Azure AVM Bicep mode

# Azure Verified Modules (AVM) Bicep

Overview

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

Module Discovery

Bicep Public Registry

- Search for modules: `br/public:avm/res/{service}/{resource}:{version}`

- Browse available modules: `https://github.com/Azure/bicep-registry-modules/tree/main/avm/res`

- Example: `br/public:avm/res/storage/storage-account:0.30.0`

Official AVM Index

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

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

Module Documentation

- **GitHub Repository**: `https://github.com/Azure/bicep-registry-modules/tree/main/avm/res/{service}/{resource}`

- **README**: Each module contains comprehensive documentation with examples

Module Usage

From Examples

1. Review module README in `https://github.com/Azure/bicep-registry-modules/tree/main/avm/res/{service}/{resource}`

2. Copy example code from module documentation

3. Reference module using `br/public:avm/res/{service}/{resource}:{version}`

4. Configure required and optional parameters

Example Usage

module storageAccount 'br/public:avm/res/storage/storage-account:0.30.0' = {
  name: 'storage-account-deployment'
  scope: resourceGroup()
  params: {
    name: storageAccountName
    location: location
    skuName: 'Standard_LRS'
    tags: tags
  }
}

When AVM Module Not Available

If no AVM module exists for a resource type, use native Bicep resource declarations with latest stable API version.

Naming Conventions

Module References

- **Resource Modules**: `br/public:avm/res/{service}/{resource}:{version}`

- **Pattern Modules**: `br/public:avm/ptn/{pattern}:{version}`

- Example: `br/public:avm/res/network/virtual-network:0.7.2`

Symbolic Names

- Use lowerCamelCase for all names (variables, parameters, resources, modules)

- Use resource type descriptive names (e.g., `storageAccount` not `storageAccountName`)

- Avoid 'name' suffix in symbolic names as they represent the resource, not the resource's name

- Avoid distinguishing variables and parameters by suffixes

Version Management

Version Pinning Best Practices

- Always pin to specific module versions: `:{version}`

- Use semantic versioning (e.g., `:0.30.0`)

- Review module changelog before upgrading

- Test version upgrades in non-production environments first

Development Best Practices

Module Discovery and Usage

- ✅ **Always** check for existing AVM modules before creating raw resources

- ✅ **Review** module documentation and examples before implementation

- ✅ **Pin** module versions explicitly

- ✅ **Use** types from modules when available (import types from module)

- ✅ **Prefer** AVM modules over raw resource declarations

Code Structure

- ✅ **Declare** parameters at top of file with `@sys.description()` decorators

- ✅ **Specify** `@minLength()` and `@maxLength()` for naming parameters

- ✅ **Use** `@allowed()` decorator sparingly to avoid blocking valid deployments

- ✅ **Set** default values safe for test environments (low-cost SKUs)

- ✅ **Use** variables for complex expressions instead of embedding in resource properties

- ✅ **Leverage** `loadJsonContent()` for external configuration files

Resource References

- ✅ **Use** symbolic names for references (e.g., `storageAccount.id`) not `reference()` or `resourceId()`

- ✅ **Create** dependencies through symbolic names, not explicit `dependsOn`

- ✅ **Use** `existing` keyword for accessing properties from other resources

- ✅ **Access** module outputs via dot notation (e.g., `storageAccount.outputs.resourceId`)

Resource Naming

- ✅ **Use** `