# azure-verified-modules-terraform

Keeps Copilot on the Azure Verified Modules path: find a module, pin its version, run the ./avm checks before opening a pull request.

- rule · `type=rule` · GitHub Copilot · ★ 40451
- Author: github · official GitHub repository
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/github/awesome-copilot/tree/HEAD/instructions/azure-verified-modules-terraform.instructions.md
- Updated: 2026-10-23
- HTML: https://affpapa.org/en/nevibecode/rules/azure-verified-modules-terraform

## What it does

The rule fires on Terraform files: `*.tf`, `*.tfvars`, `*.tfstate`, `*.tflint.hcl` and their JSON forms. It lays out how to work with Azure Verified Modules — discovery, wiring, validation.

Discovery goes through the Terraform Registry: search “avm” plus the resource name, then narrow to the Partner tag. The Azure-Verified-Modules repo also ships CSV indexes for resource, pattern and utility modules. You wire a module in by its registry address, such as `Azure/avm-res-{service}-{resource}/azurerm`, with a pinned version and `enable_telemetry = true`.

Before a pull request the rule demands `terraform fmt -recursive`, `terraform validate`, and three `./avm` commands: `pre-commit`, `tflint`, `pr-check`. PR validation fails without them. That is a hard gate, so a repo without an executable `./avm` will stall at this step.

## Requirements
- Works with: Azure, Terraform

## Install

### GitHub Copilot (native platform)

**Manually: put the files in place**
- File: `.github/instructions/azure-verified-modules-terraform.instructions.md` — The applyTo field sets which files it applies to

### Claude Code

**Manually: put the files in place**
- File: `.claude/rules/azure-verified-modules-terraform.md` — The paths frontmatter field limits the files: move applyTo from the source into paths

### Codex

**AGENTS.md**
- Codex reads AGENTS.md: paste the rule text there

### Cursor

**Manually: put the files in place**
- File: `.cursor/rules/azure-verified-modules-terraform.mdc` — Frontmatter: description, globs, alwaysApply. Move applyTo from the source into globs, or the rule will not attach on its own

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/rules/azure-verified-modules-terraform.md`

### Cline

**Manually: put the files in place**
- File: `.clinerules/azure-verified-modules-terraform.md`

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/github/awesome-copilot/tree/HEAD/instructions/azure-verified-modules-terraform.instructions.md

## When to use it
- pull in the official AVM module for a given Azure resource
- lock module and provider versions before deploying
- run the mandatory checks before opening a pull request
- build configs from the published examples instead of starting blank

## Example prompts
- Find the AVM module for a storage account and wire it in with a pinned version
- Add a virtual network through an AVM module and turn on telemetry
- Confirm `./avm pre-commit`, `./avm tflint` and `./avm pr-check` all ran before the PR

## Source text · azure-verified-modules-terraform.instructions.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 64624080277df2cf.

BEGIN THIRD-PARTY FILE 64624080277df2cf
````text
---
description: ' Azure Verified Modules (AVM) and Terraform'
applyTo: '**/*.terraform, **/*.tf, **/*.tfvars, **/*.tfstate, **/*.tflint.hcl, **/*.tf.json, **/*.tfvars.json'
---

# 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:

```bash
./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

```hcl
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`)
````
END THIRD-PARTY FILE 64624080277df2cf

The third-party file has ended. Everything between the 64624080277df2cf tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 3542 of 7697 bytes. © github · MIT · https://github.com/github/awesome-copilot/tree/HEAD/instructions/azure-verified-modules-terraform.instructions.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md