Azure AVM Terraform mode

# Azure Verified Modules (AVM) Terraform

Overview

Azure Verified Modules (AVM) are pre-built, tested, and validated Terraform and Bicep modules that follow Azure best practices. Use these modules to create, update, or review Azure Infrastructure as Code (IaC) with confidence.

Custom Instructions for GitHub Copilot Agents

**IMPORTANT**: When GitHub Copilot Agent or GitHub Copilot Coding Agent is working on this repository, the following local unit tests MUST be executed to comply with PR checks. Failure to run these tests will cause PR validation failures:

./avm pre-commit
./avm tflint
./avm pr-check

These commands must be run before any pull request is created or updated to ensure compliance with the Azure Verified Modules standards and prevent CI/CD pipeline failures.

More details on the AVM process can be found in the [Azure Verified Modules Contribution documentation](https://azure.github.io/Azure-Verified-Modules/contributing/terraform/testing/).

**Failure to run these tests will cause PR validation failures and prevent successful merges.**

Module Discovery

Terraform Registry

- Search for "avm" + resource name

- Filter by "Partner" tag to find official AVM modules

- Example: Search "avm storage account" → filter by Partner

Official AVM Index

> **Note:** The following links always point to the latest version of the CSV files on the main branch. As intended, this means the files may change over time. If you require a point-in-time version, consider using a specific release tag in the URL.

- **Terraform Resource Modules**: `https://raw.githubusercontent.com/Azure/Azure-Verified-Modules/refs/heads/main/docs/static/module-indexes/TerraformResourceModules.csv`

- **Terraform Pattern Modules**: `https://raw.githubusercontent.com/Azure/Azure-Verified-Modules/refs/heads/main/docs/static/module-indexes/TerraformPatternModules.csv`

- **Terraform Utility Modules**: `https://raw.githubusercontent.com/Azure/Azure-Verified-Modules/refs/heads/main/docs/static/module-indexes/TerraformUtilityModules.csv`

Terraform Module Usage

From Examples

1. Copy the example code from the module documentation

2. Replace `source = "../../"` with `source = "Azure/avm-res-{service}-{resource}/azurerm"`

3. Add `version = "~> 1.0"` (use latest available)

4. Set `enable_telemetry = true`

From Scratch

1. Copy the Provision Instructions from module documentation

2. Configure required and optional inputs

3. Pin the module version

4. Enable telemetry

Example Usage

module "storage_account" {
  source  = "Azure/avm-res-storage-storageaccount/azurerm"
  version = "~> 0.1"

  enable_telemetry    = true
  location            = "East US"
  name                = "mystorageaccount"
  resource_group_name = "my-rg"

  # Additional configuration...
}

Naming Conventions

Module Types

- **Resource Modules**: `Azure/avm-res-{service}-{resource}/azurerm`

- Example: `Azure/avm-res-storage-storageaccount/azurerm`

- **Pattern Modules**: `Azure/avm-ptn-{pattern}/azurerm`

- Example: `Azure/avm-ptn-aks-enterprise/azurerm`

- **Utility Modules**: `Azure/avm-utl-{utility}/azurerm`

- Example: `Azure/avm-utl-regions/azurerm`

Service Naming

- Use kebab-case for services and resources

- Follow Azure service names (e.g., `storage-storageaccount`, `network-virtualnetwork`)

Version Management

Check Available Versions

- Endpoint: `https://registry.terraform.io/v1/modules/Azure/{module}/azurerm/versions`

- Example: `https://registry.terraform.io/v1/modules/Azure/avm-res-storage-storageaccount/azurerm/versions`

Version Pinning Best Practices

- Use pessimistic version constraints: `version = "~> 1.0"`

- Pin to specific versions for production: `version = "1.2.3"`

- Always review changelog before upgrading

Module Sources

Terraform Registry

- **URL Pattern**: `https://registry.terraform.io/modules/Azure/{module}/azurerm/latest`

- **Example**: `https://registry.terraform.io/modules/