Azurecaf Terraform Provider

The azurecaf provider implements a set of methodologies for naming convention implementation, including the default Microsoft Cloud Adoption Framework for Azure recommendations as per the Azure naming and tagging best practices. Please note this project is not part of Azure Cloud Adoption Framework and is supported by the community, not by Microsoft Support.

🎯 Key Features

The Azure CAF provider allows you to:

🏗️ Generate compliant Azure resource names following CAF guidelines and Azure naming restrictions
🧹 Clean and sanitize inputs to ensure compliance with allowed patterns for each Azure resource
🎲 Add random characters to resource names for uniqueness
🏷️ Handle prefixes and suffixes (either manual or as per Azure CAF resource conventions)
✅ Validate existing names using passthrough mode
🔄 Generate one or multiple related names from the same naming inputs
📋 Generate names for 520 Azure resource types with accurate validation rules

Upgrading from v1.x? Read the v2.0.0 migration guide before changing the provider version.

📦 Quick Start

Installation

Add the provider to your Terraform configuration:

terraform {
  required_providers {
    azurecaf = {
      source  = "aztfmod/azurecaf"
      version = "~> 2.0"
    }
  }
}

Basic Usage

Generate an Azure-compliant resource group name:

# Using data source (recommended - evaluated at plan time)
data "azurecaf_name" "rg_example" {
  name          = "myproject"
  resource_type = "azurerm_resource_group"
  prefixes      = ["demo"]
  suffixes      = ["001"]
  random_length = 5
  random_seed   = 12345
  clean_input   = true
}
resource "azurerm_resource_group" "example" {
  name     = data.azurecaf_name.rg_example.result
  location = "East US"
}
output "resource_group_name" {
  value = data.azurecaf_name.rg_example.result
  # Example output: rg-demo-myproject-001-abcde
}

📚 Comprehensive Examples

Example 1: Simple Resource Naming

Generate names with automatic resource type prefixes:

data "azurecaf_name" "storage_account" {
  name          = "mydata"
  resource_type = "azurerm_storage_account"
  random_length = 3
  random_seed   = 12345
}
resource "azurerm_storage_account" "example" {
  name                     = data.azurecaf_name.storage_account.result
  resource_group_name      = azurerm_resource_group.example.name
  location                 = azurerm_resource_group.example.location
  account_tier             = "Standard"
  account_replication_type = "LRS"
}
Result: "stmydata123" (st = storage account slug, mydata = name, 123 = random)

Example 2: Multiple Resources with Consistent Naming

Generate names for multiple related resources:

locals {
  project = "webapp"
  env     = "prod"
}
data "azurecaf_name" "service_plan" {
  name          = local.project
  resource_type = "azurerm_service_plan"
  prefixes      = [local.env]
  suffixes      = ["001"]
}
data "azurecaf_name" "app_service" {
  name          = local.project
  resource_type = "azurerm_app_service"
  prefixes      = [local.env]
  suffixes      = ["001"]
}
data "azurecaf_name" "key_vault" {
  name          = local.project
  resource_type = "azurerm_key_vault"
  prefixes      = [local.env]
  suffixes      = ["001"]
}
Results:
App Service Plan: "asp-prod-webapp-001"
App Service: "app-prod-webapp-001"  
Key Vault: "kv-prod-webapp-001"

Example 3: Using Resource (vs Data Source)

For cases where you need to generate multiple resource names:

resource "azurecaf_name" "multiple_resources" {
  name           = "myapp"
  resource_type  = "azurerm_app_service"
  resource_types = [
    "azurerm_service_plan",
    "azurerm_application_insights"
  ]
  prefixes       = ["prod"]
  suffixes       = ["web"]
  random_length  = 3
  random_seed    = 12345
  clean_input    = true
}
Access individual names:
Primary: azurecaf_name.multiple_resources.result
All: azurecaf_name.multiple_resources.results

Example 4: Passthrough Mode for Validation

Validate existing resource names without modification:

data "azurecaf_name" "existing_storage" {
  name          = "mystorageaccount123"
  resource_type = "azurerm_storage_account"
  passthrough   = true
}
Validates that "mystorageaccount123" is compliant with storage account naming rules

Example 5: Advanced Configuration

Complex naming with custom separators and no resource slugs:

data "azurecaf_name" "custom_vm" {
  name          = "database-server"
  resource_type = "azurerm_linux_virtual_machine"
  prefixes      = ["corp", "prod"]
  suffixes      = ["db", "001"]
  separator     = "_"
  use_slug      = false
  random_length = 4
  random_seed   = 12345
  clean_input   = true
}
Result: "corp_prod_database_server_db_001_a1b2"

🛠️ Configuration Reference

Supported Parameters

| Parameter | Type | Description | Default | |-----------|------|-------------|---------| | name | string | Base name for the resource | "" | | resource_type | string | Azure resource type (e.g., azurerm_storage_account) | Required | | resource_types | list(string) | Additional resource types for multi-resource naming | [] | | prefixes | list(string) | List of prefixes to prepend | [] | | suffixes | list(string) | List of suffixes to append | [] | | random_length | number | Number of random characters to add | 0 | | random_seed | number | Seed for deterministic random generation | unset | | separator | string | Character to separate name components | "-" | | clean_input | bool | Remove non-compliant characters from inputs | true | | passthrough | bool | Validate without modification | false | | use_slug | bool | Include resource type abbreviation | true | | error_when_exceeding_max_length | bool | Fail when generated name exceeds the resource's max length | false |

For azurecaf_name data sources, explicitly set random_seed (including 0) whenever random_length > 0 and the name must remain stable across refreshes. Omitting it generates a fresh suffix on every read. For azurecaf_name resources, only a non-zero seed enables deterministic plan-time generation; an omitted or zero seed is generated once during apply and preserved in state.

Output Attributes

| Attribute | Description | |-----------|-------------| | id | Unique identifier for the naming configuration | | result | Generated name for the primary resource type | | results | Map of all generated names (when using resource_types) |

🔧 Supported Azure Resources

This provider supports 520 Azure resource types with accurate naming validation rules. Each resource type has specific constraints for:

Minimum and maximum length
Allowed characters and patterns
Case sensitivity requirements
Uniqueness scope (global, resource group, or parent resource)

Popular Resource Types

| Resource Type | Slug | Min Length | Max Length | Example Generated Name | |---------------|------|------------|------------|----------------------| | azurerm_resource_group | rg | 1 | 90 | rg-prod-myapp-001 | | azurerm_storage_account | st | 3 | 24 | stprodmyapp001 | | azurerm_key_vault | kv | 3 | 24 | kv-prod-myapp-001 | | azurerm_app_service | app | 2 | 60 | app-prod-myapp-001 | | azurerm_kubernetes_cluster | aks | 1 | 63 | aks-prod-myapp-001 | | azurerm_virtual_machine | vm | 1 | 15 | vm-prod-001 | | azurerm_sql_server | sql | 1 | 63 | sql-prod-myapp-001 |

📋 View Full Resource Type List

For the complete list of 520 supported resource types, see the Resource Types Documentation.

🚀 Advanced Usage

Environment-Based Naming

locals {
  environment_config = {
    dev = {
      prefix = "dev"
      random_length = 3
    }
    prod = {
      prefix = "prod" 
      random_length = 5
    }
  }
  
  current_env = local.environment_config[var.environment]
}
data "azurecaf_name" "app_service" {
  name          = var.application_name
  resource_type = "azurerm_app_service"
  prefixes      = [local.current_env.prefix]
  random_length = local.current_env.random_length
  random_seed   = 12345
}

Integration with Terraform Modules

# In your module
variable "project_name" {
  description = "Name of the project"
  type        = string
}
variable "environment" {
  description = "Environment (dev, test, prod)"
  type        = string
}
data "azurecaf_name" "resources" {
  for_each = toset([
    "azurerm_resource_group",
    "azurerm_storage_account", 
    "azurerm_key_vault"
  ])
  
  name          = var.project_name
  resource_type = each.key
  prefixes      = [var.environment]
  random_length = 3
  random_seed   = 12345
}
output "resource_names" {
  value = { for k, v in data.azurecaf_name.resources : k => v.result }
}

🔍 Troubleshooting

Common Issues

Issue: Names too long for resource type

# Problem: Generated name exceeds Azure limits
data "azurecaf_name" "long_name" {
  name          = "very-long-application-name-that-exceeds-limits"
  resource_type = "azurerm_storage_account"  # max 24 chars
}
Solution: Use shorter base name or disable slug
data "azurecaf_name" "fixed_name" {
  name          = "shortname"
  resource_type = "azurerm_storage_account"
  use_slug      = false  # Removes 'st' prefix
}

Issue: Invalid characters in resource names

# Problem: Special characters not allowed
data "azurecaf_name" "invalid_chars" {
  name          = "[email protected]"
  resource_type = "azurerm_app_service"
  clean_input   = false  # Keeps invalid chars
}
Solution: Enable input cleaning (default)
data "azurecaf_name" "clean_name" {
  name          = "[email protected]"
  resource_type = "azurerm_app_service"
  clean_input   = true   # Removes invalid chars
}

Validation Errors

The provider validates names against Azure requirements and will show specific error messages:

Error: Invalid resource name "my--invalid--name"
│ The generated name contains consecutive separators, which is not allowed for azurerm_storage_account

🧪 Testing & Development

The Azure CAF terraform provider includes comprehensive testing to ensure reliability and correctness.

Running Unit Tests

To run the standard unit tests:

go test ./azurecaf/...

To run tests with coverage information:

go test -cover ./azurecaf/...

For a detailed coverage report:

go test -coverprofile=coverage.out ./azurecaf/...
go tool cover -html=coverage.out -o coverage.html

Running Integration Tests

Integration tests verify the provider works correctly with Terraform itself. These tests require setting the TF_ACC environment variable:

# Run all integration tests
TF_ACC=1 go test -v ./azurecaf/... -run="TestAcc"
Run specific integration tests
TF_ACC=1 go test -v ./azurecaf/... -run="TestAccDataSourcesIntegration"
TF_ACC=1 go test -v ./azurecaf/... -run="TestAccErrorHandling"

Note: Integration tests take longer to run than unit tests.

Test Coverage

The project maintains high test coverage (99.0% of statements) to ensure code quality and reliability. Tests are designed to cover:

Basic functionality for all resources and data sources
Edge cases and error handling
Various resource types and naming conventions
Different configuration combinations
Environment variable interactions
Validation and constraints

Test Organization

The test files are organized as follows:

Unit Tests: Basic test files like resource_name_test.go
Enhanced Tests: More comprehensive tests in files like enhanced_tests_test.go
Integration Tests: Tests with the prefix TestAcc that interact with Terraform directly
Error Handling Tests: Tests that verify proper error reporting in edge cases
Complete Coverage Tests: Tests designed specifically to achieve maximum code coverage
Resource Matrix Tests: Comprehensive validation of all 520 resource types
Constraint Tests: Validation of resource naming constraints and limitations

Comprehensive Testing Framework

The provider includes a comprehensive testing framework that validates all 520 Azure resource types:

# Run comprehensive tests for all resource types
make test_all_resources
Run resource matrix validation (category-based testing and constraint validation)
make test_resource_matrix
Test resource definition completeness
make test_resource_definitions

This framework ensures:

100% Resource Coverage: All 520 resource types are tested
Naming Validation: Each resource type's naming constraints are verified
Category Organization: Resources are tested by logical categories (Compute, Networking, etc.)
Edge Case Testing: Complex naming scenarios and error conditions are validated

Writing New Tests

When writing new tests, consider the following guidelines:

Unit Tests: Test individual functions and components in isolation
Integration Tests: Test full resources with actual Terraform configurations
Error Cases: Include tests for edge cases and error conditions
Resource Types: Test with various Azure resource types to ensure naming compatibility
Validation: Test validation rules for different resource constraints

Makefile Targets

The project includes Makefile targets for common testing operations:

# Run unit tests without coverage
make unittest
Run tests with coverage reporting
make test_coverage
Generate HTML coverage report
make test_coverage_html
Run integration tests
make test_integration
Run data source integration tests
make test_data_sources
Run error handling integration tests
make test_error_handling
Run resource naming convention tests
make test_resource_naming
Run all tests (unit and integration)
make test_all
Run CI tests (unit tests with coverage, no integration tests)
make test_ci
Comprehensive testing framework
make test_all_resources          # Test all 520 resource types
make test_resource_matrix        # Category-based testing and constraint validation
make test_resource_definitions   # Resource definition completeness
Build the project and run unit tests
make build
Clean up build artifacts
make clean

Building the Provider

Clone the repository:

git clone https://github.com/aztfmod/terraform-provider-azurecaf.git
   cd terraform-provider-azurecaf

Build the provider:

make build

Run tests:

# Unit tests only
   make unittest
   
   # All tests (unit + integration)  
   make test_all

For detailed testing information, see TESTING.md.

🤝 Contributing

We welcome contributions to the Azure CAF Terraform Provider! Here's how you can help:

Contributing Guidelines

🐛 Bug Reports: Open an issue with detailed reproduction steps
💡 Feature Requests: Discuss new features in issues before implementing
📝 Documentation: Help improve documentation and examples
🔧 Code: Submit pull requests for bug fixes and new features

For detailed contribution guidelines, see CONTRIBUTING.md.

Adding New Resource Types

Check the resource status table to see if it's already implemented
Create an issue requesting the new resource type
Add the resource definition to resourceDefinition.json
Run make build to generate the updated code
Add tests and submit a pull request

🌟 Community & Support

💬 Questions: Reach out to tf-landingzones at microsoft dot com
💭 Discussions: Join us on Gitter
🐛 Issues: Report bugs and request features on GitHub Issues

🔗 Related Projects

| Project | Description | |---------|-------------| | CAF Landing Zones | Landing zones with sample and core documentation | | Rover | DevOps toolset for operating landing zones | | CAF Modules | Official CAF modules in Terraform Registry |

📊 Resource Status

This provider supports 520 Azure resource types. Here's the implementation status compared to the azurerm provider:

The detailed table covers AzureRM schema resources; the total also includes compatibility aliases and helper definitions.

🔍 View Detailed Resource Status Table

|resource | status | |---|---| |azurerm_aadb2c_directory | ✔ | |azurerm_advisor_recommendations | ❌ | |azurerm_analysis_services_server | ✔ | |azurerm_api_management | ✔ | |azurerm_api_management_api | ✔ | |azurerm_api_management_api_diagnostic | ❌ | |azurerm_api_management_api_operation | ❌ | |azurerm_api_management_api_operation_policy | ❌ | |azurerm_api_management_api_operation_tag | ✔ | |azurerm_api_management_api_policy | ❌ | |azurerm_api_management_api_schema | ❌ | |azurerm_api_management_api_version_set | ✔ | |azurerm_api_management_authorization_server | ✔ | |azurerm_api_management_backend | ✔ | |azurerm_api_management_certificate | ✔ | |azurerm_api_management_custom_domain | ❌ | |azurerm_api_management_diagnostic | ❌ | |azurerm_api_management_gateway | ✔ | |azurerm_api_management_group | ✔ | |azurerm_api_management_group_user | ❌ | |azurerm_api_management_identity_provider_aad | ❌ | |azurerm_api_management_identity_provider_facebook | ❌ | |azurerm_api_management_identity_provider_google | ❌ | |azurerm_api_management_identity_provider_microsoft | ❌ | |azurerm_api_management_identity_provider_twitter | ❌ | |azurerm_api_management_logger | ✔ | |azurerm_api_management_named_value | ✔ | |azurerm_api_management_openid_connect_provider | ✔ | |azurerm_api_management_product | ❌ | |azurerm_api_management_product_api | ❌ | |azurerm_api_management_product_group | ❌ | |azurerm_api_management_product_policy | ❌ | |azurerm_api_management_property | ❌ | |azurerm_api_management_subscription | ❌ | |azurerm_api_management_user | ❌ | |azurerm_app_configuration | ✔ | |azurerm_app_service | ✔ | |azurerm_app_service_active_slot | ❌ | |azurerm_app_service_certificate | ✔ | |azurerm_app_service_certificate_order | ✔ | |azurerm_app_service_custom_hostname_binding | ❌ | |azurerm_app_service_environment | ✔ | |azurerm_app_service_hybrid_connection | ❌ | |azurerm_app_service_plan | ❌ | |azurerm_service_plan | ✔ | |azurerm_app_service_slot | ✔ | |azurerm_app_service_slot_virtual_network_swift_connection | ❌ | |azurerm_app_service_source_control_token | ❌ | |azurerm_app_service_virtual_network_swift_connection | ❌ | |azurerm_application_gateway | ✔ | |azurerm_application_insights | ✔ | |azurerm_application_insights_analytics_item | ✔ | |azurerm_application_insights_api_key | ✔ | |azurerm_application_insights_web_test | ✔ | |azurerm_application_security_group | ✔ | |azurerm_automation_account | ✔ | |azurerm_automation_certificate | ✔ | |azurerm_automation_connection | ✔ | |azurerm_automation_connection_certificate | ✔ | |azurerm_automation_connection_classic_certificate | ✔ | |azurerm_automation_connection_service_principal | ✔ | |azurerm_automation_credential | ✔ | |azurerm_automation_dsc_configuration | ✔ | |azurerm_automation_dsc_nodeconfiguration | ✔ | |azurerm_automation_hybrid_runbook_worker_group | ✔ | |azurerm_automation_job_schedule | ✔ | |azurerm_automation_module | ✔ | |azurerm_automation_runbook | ✔ | |azurerm_automation_schedule | ✔ | |azurerm_automation_variable_bool | ✔ | |azurerm_automation_variable_datetime | ✔ | |azurerm_automation_variable_int | ✔ | |azurerm_automation_variable_string | ✔ | |azurerm_availability_set | ✔ | |azurerm_backup_container_storage_account | ❌ | |azurerm_backup_policy_file_share | ✔ | |azurerm_backup_policy_vm | ✔ | |azurerm_backup_protected_file_share | ❌ | |azurerm_backup_protected_vm | ❌ | |azurerm_bastion_host | ✔ | |azurerm_batch_account | ✔ | |azurerm_batch_application | ✔ | |azurerm_batch_certificate | ✔ | |azurerm_batch_pool | ✔ | |azurerm_blueprint_assignment | ✔ | |azurerm_bot_channel_directline | ✔ | |azurerm_bot_channel_email | ❌ | |azurerm_bot_channel_ms_teams | ✔ | |azurerm_bot_channel_slack | ✔ | |azurerm_bot_channels_registration | ✔ | |azurerm_bot_connection | ✔ | |azurerm_bot_service_azure_bot | ✔ | |azurerm_bot_web_app | ✔ | |azurerm_cdn_endpoint | ✔ | |azurerm_cdn_frontdoor_custom_domain | ✔ | |azurerm_cdn_frontdoor_endpoint | ✔ | |azurerm_cdn_frontdoor_firewall_policy | ✔ | |azurerm_cdn_frontdoor_origin | ✔ | |azurerm_cdn_frontdoor_origin_group | ✔ | |azurerm_cdn_frontdoor_profile | ✔ | |azurerm_cdn_frontdoor_route | ✔ | |azurerm_cdn_frontdoor_rule | ✔ | |azurerm_cdn_frontdoor_rule_set | ✔ | |azurerm_cdn_frontdoor_secret | ✔ | |azurerm_cdn_frontdoor_security_policy | ✔ | |azurerm_cdn_profile | ✔ | |azurerm_client_config | ❌ | |azurerm_cognitive_account | ✔ | |azurerm_communication_service | ✔ | |azurerm_consumption_budget_resource_group | ✔ | |azurerm_consumption_budget_subscription | ✔ | |azurerm_container_app | ✔ | |azurerm_container_app_environment | ✔ | |azurerm_container_group | ✔ | |azurerm_container_registry | ✔ | |azurerm_container_registry_webhook | ✔ | |azurerm_cosmosdb_account | ✔ | |azurerm_cosmosdb_cassandra_keyspace | ✔ | |azurerm_cosmosdb_gremlin_database | ✔ | |azurerm_cosmosdb_gremlin_graph | ✔ | |azurerm_cosmosdb_mongo_collection | ✔ | |azurerm_cosmosdb_mongo_database | ✔ | |azurerm_cosmosdb_sql_container | ✔ | |azurerm_cosmosdb_sql_database | ✔ | |azurerm_cosmosdb_sql_stored_procedure | ✔ | |azurerm_cosmosdb_table | ✔ | |azurerm_cost_management_export_resource_group | ❌ | |azurerm_custom_provider | ✔ | |azurerm_dashboard | ✔ | |azurerm_portal_dashboard | ✔ | |azurerm_data_factory | ✔ | |azurerm_data_factory_dataset_azure_blob | ✔ | |azurerm_data_factory_dataset_cosmosdb_sqlapi | ✔ | |azurerm_data_factory_dataset_delimited_text | ✔ | |azurerm_data_factory_dataset_http | ✔ | |azurerm_data_factory_dataset_json | ✔ | |azurerm_data_factory_dataset_mysql | ✔ | |azurerm_data_factory_dataset_postgresql | ✔ | |azurerm_data_factory_dataset_sql_server_table | ✔ | |azurerm_data_factory_integration_runtime_managed | ✔ | |azurerm_data_factory_integration_runtime_self_hosted | ✔ | |azurerm_data_factory_linked_service_azure_blob_storage | ✔ | |azurerm_data_factory_linked_service_azure_databricks | ✔ | |azurerm_data_factory_linked_service_azure_file_storage | ✔ | |azurerm_data_factory_linked_service_azure_function | ✔ | |azurerm_data_factory_linked_service_azure_sql_database | ✔ | |azurerm_data_factory_linked_service_cosmosdb | ✔ | |azurerm_data_factory_linked_service_data_lake_storage_gen2 | ✔ | |azurerm_data_factory_linked_service_key_vault | ✔ | |azurerm_data_factory_linked_service_mysql | ✔ | |azurerm_data_factory_linked_service_postgresql | ✔ | |azurerm_data_factory_linked_service_sftp | ✔ | |azurerm_data_factory_linked_service_sql_server | ✔ | |azurerm_data_factory_linked_service_web | ✔ | |azurerm_data_factory_pipeline | ✔ | |azurerm_data_factory_trigger_schedule | ✔ | |azurerm_data_lake_analytics_account | ✔ | |azurerm_data_lake_analytics_firewall_rule | ✔ | |azurerm_data_lake_store | ✔ | |azurerm_data_lake_store_file | ❌ | |azurerm_data_lake_store_firewall_rule | ✔ | |azurerm_data_protection_backup_policy_blob_storage | ✔ | |azurerm_data_protection_backup_policy_disk | ✔ | |azurerm_data_protection_backup_policy_postgresql | ✔ | |azurerm_data_protection_backup_policy_postgresql_flexible_server | ✔ | |azurerm_data_protection_backup_vault | ✔ | |azurerm_data_share | ✔ | |azurerm_data_share_account | ✔ | |azurerm_data_share_dataset_blob_storage | ✔ | |azurerm_data_share_dataset_data_lake_gen1 | ✔ | |azurerm_data_share_dataset_data_lake_gen2 | ✔ | |azurerm_data_share_dataset_kusto_cluster | ✔ | |azurerm_data_share_dataset_kusto_database | ✔ | |azurerm_database_migration_project | ✔ | |azurerm_database_migration_service | ✔ | |azurerm_databricks_workspace | ✔ | |azurerm_dedicated_hardware_security_module | ✔ | |azurerm_dedicated_host | ✔ | |azurerm_dedicated_host_group | ✔ | |azurerm_dev_center | ✔ | |azurerm_dev_center_catalog | ✔ | |azurerm_dev_center_dev_box_definition | ✔ | |azurerm_dev_center_environment_type | ✔ | |azurerm_dev_center_gallery | ✔ | |azurerm_dev_center_network_connection | ✔ | |azurerm_dev_center_project | ✔ | |azurerm_dev_center_project_environment_type | ✔ | |azurerm_dev_test_global_vm_shutdown_schedule | ❌ | |azurerm_dev_test_lab | ✔ | |azurerm_dev_test_linux_virtual_machine | ✔ | |azurerm_dev_test_schedule | ✔ | |azurerm_dev_test_virtual_network | ✔ | |azurerm_dev_test_windows_virtual_machine | ✔ | |azurerm_devspace_controller | ✔ | |azurerm_digital_twins_endpoint_eventgrid | ✔ | |azurerm_digital_twins_endpoint_eventhub | ✔ | |azurerm_digital_twins_endpoint_servicebus | ✔ | |azurerm_digital_twins_instance | ✔ | |azurerm_disk_encryption_set | ✔ | |azurerm_dns_a_record | ✔ | |azurerm_dns_aaaa_record | ✔ | |azurerm_dns_caa_record | ✔ | |azurerm_dns_cname_record | ✔ | |azurerm_dns_mx_record | ✔ | |azurerm_dns_ns_record | ✔ | |azurerm_dns_ptr_record | ✔ | |azurerm_dns_srv_record | ✔ | |azurerm_dns_txt_record | ✔ | |azurerm_dns_zone | ✔ | |azurerm_email_communication_service | ✔ | |azurerm_eventgrid_domain | ✔ | |azurerm_eventgrid_domain_topic | ✔ | |azurerm_eventgrid_event_subscription | ✔ | |azurerm_eventgrid_system_topic | ✔ | |azurerm_eventgrid_topic | ✔ | |azurerm_eventhub | ✔ | |azurerm_eventhub_authorization_rule | ✔ | |azurerm_eventhub_cluster | ✔ | |azurerm_eventhub_consumer_group | ✔ | |azurerm_eventhub_namespace | ✔ | |azurerm_eventhub_namespace_authorization_rule | ✔ | |azurerm_eventhub_namespace_disaster_recovery_config | ✔ | |azurerm_express_route_circuit | ✔ | |azurerm_express_route_circuit_authorization | ✔ | |azurerm_express_route_gateway | ✔ | |azurerm_federated_identity_credential | ✔ | |azurerm_firewall | ✔ | |azurerm_firewall_application_rule_collection | ✔ | |azurerm_firewall_nat_rule_collection | ✔ | |azurerm_firewall_network_rule_collection | ✔ | |azurerm_firewall_policy | ✔ | |azurerm_firewall_policy_rule_collection_group | ✔ | |azurerm_frontdoor | ✔ | |azurerm_frontdoor_custom_https_configuration | ❌ | |azurerm_frontdoor_firewall_policy | ✔ | |azurerm_function_app | ✔ | |azurerm_function_app_host_keys | ❌ | |azurerm_function_app_slot | ✔ | |azurerm_hdinsight_hadoop_cluster | ✔ | |azurerm_hdinsight_hbase_cluster | ✔ | |azurerm_hdinsight_interactive_query_cluster | ✔ | |azurerm_hdinsight_kafka_cluster | ✔ | |azurerm_hdinsight_ml_services_cluster | ✔ | |azurerm_hdinsight_rserver_cluster | ✔ | |azurerm_hdinsight_spark_cluster | ✔ | |azurerm_hdinsight_storm_cluster | ✔ | |azurerm_healthcare_dicom_service | ✔ | |azurerm_healthcare_fhir_service | ✔ | |azurerm_healthcare_medtech_service | ✔ | |azurerm_healthcare_service | ✔ | |azurerm_healthcare_workspace | ✔ | |azurerm_hpc_cache | ✔ | |azurerm_hpc_cache_blob_target | ✔ | |azurerm_hpc_cache_nfs_target | ✔ | |azurerm_image | ✔ | |azurerm_images | ❌ | |azurerm_integration_service_environment | ✔ | |azurerm_iot_security_device_group | ✔ | |azurerm_iot_security_solution | ✔ | |azurerm_iot_time_series_insights_access_policy | ❌ | |azurerm_iot_time_series_insights_reference_data_set | ✔ | |azurerm_iot_time_series_insights_standard_environment | ✔ | |azurerm_iotcentral_application | ✔ | |azurerm_iothub | ✔ | |azurerm_iothub_certificate | ✔ | |azurerm_iothub_consumer_group | ✔ | |azurerm_iothub_dps | ✔ | |azurerm_iothub_dps_certificate | ✔ | |azurerm_iothub_dps_shared_access_policy | ✔ | |azurerm_iothub_endpoint_eventhub | ✔ | |azurerm_iothub_endpoint_servicebus_queue | ✔ | |azurerm_iothub_endpoint_servicebus_topic | ✔ | |azurerm_iothub_endpoint_storage_container | ✔ | |azurerm_iothub_route | ✔ | |azurerm_iothub_shared_access_policy | ✔ | |azurerm_ip_group | ✔ | |azurerm_key_vault | ✔ | |azurerm_key_vault_certificate | ✔ | |azurerm_key_vault_certificate_issuer | ✔ | |azurerm_key_vault_key | ✔ | |azurerm_key_vault_secret | ✔ | |azurerm_kubernetes_cluster | ✔ | |azurerm_kubernetes_cluster_node_pool | ❌ | |azurerm_kubernetes_fleet_manager | ✔ | |azurerm_kubernetes_service_versions | ❌ | |azurerm_kusto_attached_database_configuration | ✔ | |azurerm_kusto_cluster | ✔ | |azurerm_kusto_cluster_customer_managed_key | ❌ | |azurerm_kusto_cluster_principal_assignment | ✔ | |azurerm_kusto_database | ✔ | |azurerm_kusto_database_principal | ❌ | |azurerm_kusto_database_principal_assignment | ✔ | |azurerm_kusto_eventhub_data_connection | ✔ | |azurerm_lb | ✔ | |azurerm_lb_backend_address_pool | ✔ | |azurerm_lb_backend_address_pool_address | ❌ | |azurerm_lb_nat_pool | ✔ | |azurerm_lb_nat_rule | ✔ | |azurerm_lb_outbound_rule | ✔ | |azurerm_lb_probe | ✔ | |azurerm_lb_rule | ✔ | |azurerm_lighthouse_definition | ✔ | |azurerm_linux_function_app | ✔ | |azurerm_linux_function_app_slot | ✔ | |azurerm_linux_virtual_machine | ✔ | |azurerm_linux_virtual_machine_scale_set | ✔ | |azurerm_linux_web_app | ✔ | |azurerm_linux_web_app_slot | ❌ | |azurerm_load_test | ✔ | |azurerm_local_network_gateway | ✔ | |azurerm_log_analytics_cluster | ✔ | |azurerm_log_analytics_data_export_rule | ✔ | |azurerm_log_analytics_datasource_windows_event | ✔ | |azurerm_log_analytics_datasource_windows_performance_counter | ✔ | |azurerm_log_analytics_linked_storage_account | ❌ | |azurerm_log_analytics_saved_search | ✔ | |azurerm_log_analytics_solution | ✔ | |azurerm_log_analytics_query_pack | ✔ | |azurerm_log_analytics_storage_insights | ✔ | |azurerm_log_analytics_workspace | ✔ | |azurerm_logic_app_action_custom | ✔ | |azurerm_logic_app_action_http | ✔ | |azurerm_logic_app_integration_account | ✔ | |azurerm_logic_app_trigger_custom | ✔ | |azurerm_logic_app_trigger_http_request | ✔ | |azurerm_logic_app_trigger_recurrence | ✔ | |azurerm_logic_app_workflow | ✔ | |azurerm_machine_learning_compute_instance | ✔ | |azurerm_machine_learning_workspace | ✔ | |azurerm_maintenance_assignment_dedicated_host | ❌ | |azurerm_maintenance_assignment_virtual_machine | ❌ | |azurerm_maintenance_configuration | ✔ | |azurerm_managed_application | ✔ | |azurerm_managed_application_definition | ✔ | |azurerm_managed_disk | ✔ | |azurerm_managed_redis | ✔ | |azurerm_management_group | ✔ | |azurerm_management_lock | ✔ | |azurerm_maps_account | ✔ | |azurerm_mariadb_configuration | ❌ | |azurerm_mariadb_database | ✔ | |azurerm_mariadb_firewall_rule | ✔ | |azurerm_mariadb_server | ✔ | |azurerm_mariadb_virtual_network_rule | ✔ | |azurerm_marketplace_agreement | ❌ | |azurerm_media_services_account | ✔ | |azurerm_monitor_action_group | ✔ | |azurerm_monitor_action_rule_action_group | ✔ | |azurerm_monitor_action_rule_suppression | ✔ | |azurerm_monitor_activity_log_alert | ✔ | |azurerm_monitor_autoscale_setting | ✔ | |azurerm_monitor_data_collection_endpoint | ✔ | |azurerm_monitor_data_collection_rule | ✔ | |azurerm_monitor_diagnostic_categories | ❌ | |azurerm_monitor_diagnostic_setting | ✔ | |azurerm_monitor_log_profile | ✔ | |azurerm_monitor_metric_alert | ✔ | |azurerm_monitor_private_link_scope | ✔ | |azurerm_monitor_scheduled_query_rules_alert | ✔ | |azurerm_monitor_scheduled_query_rules_log | ✔ | |azurerm_monitor_smart_detector_alert_rule | ✔ | |azurerm_monitor_workspace | ✔ | |azurerm_mssql_database | ✔ | |azurerm_mssql_database_extended_auditing_policy | ❌ | |azurerm_mssql_database_vulnerability_assessment_rule_baseline | ❌ | |azurerm_mssql_elasticpool | ✔ | |azurerm_mssql_mi | ✔ | |azurerm_mssql_server | ✔ | |azurerm_mssql_server_extended_auditing_policy | ❌ | |azurerm_mssql_server_security_alert_policy | ❌ | |azurerm_mssql_server_vulnerability_assessment | ❌ | |azurerm_mysql_active_directory_administrator | ❌ | |azurerm_mysql_configuration | ❌ | |azurerm_mysql_database | ✔ | |azurerm_mysql_firewall_rule | ✔ | |azurerm_mysql_flexible_server | ✔ | |azurerm_mysql_flexible_server_database | ✔ | |azurerm_mysql_flexible_server_firewall_rule | ✔ | |azurerm_mysql_server | ✔ | |azurerm_mysql_server_key | ❌ | |azurerm_mysql_virtual_network_rule | ✔ | |azurerm_nat_gateway | ✔ | |azurerm_nat_gateway_public_ip_association | ❌ | |azurerm_netapp_account | ✔ | |azurerm_netapp_pool | ✔ | |azurerm_netapp_snapshot | ✔ | |azurerm_netapp_volume | ✔ | |azurerm_network_connection_monitor | ✔ | |azurerm_network_ddos_protection_plan | ✔ | |azurerm_network_interface | ✔ | |azurerm_network_interface_application_gateway_backend_address_pool_association | ❌ | |azurerm_network_interface_application_security_group_association | ❌ | |azurerm_network_interface_backend_address_pool_association | ❌ | |azurerm_network_interface_nat_rule_association | ❌ | |azurerm_network_interface_security_group_association | ❌ | |azurerm_network_packet_capture | ✔ | |azurerm_network_profile | ✔ | |azurerm_network_security_group | ✔ | |azurerm_network_security_rule | ✔ | |azurerm_network_service_tags | ❌ | |azurerm_network_watcher | ✔ | |azurerm_network_watcher_flow_log | ✔ | |azurerm_nginx_deployment | ✔ | |azurerm_notification_hub | ✔ | |azurerm_notification_hub_authorization_rule | ✔ | |azurerm_notification_hub_namespace | ✔ | |azurerm_orchestrated_virtual_machine_scale_set | ✔ | |azurerm_packet_capture | ❌ | |azurerm_platform_image | ❌ | |azurerm_point_to_site_vpn_gateway | ✔ | |azurerm_policy_assignment | ❌ | |azurerm_policy_definition | ✔ | |azurerm_policy_remediation | ✔ | |azurerm_policy_set_definition | ✔ | |azurerm_postgresql_active_directory_administrator | ❌ | |azurerm_postgresql_configuration | ❌ | |azurerm_postgresql_database | ✔ | |azurerm_postgresql_firewall_rule | ✔ | |azurerm_postgresql_flexible_server | ✔ | |azurerm_postgresql_flexible_server_configuration | ❌ | |azurerm_postgresql_flexible_server_database | ✔ | |azurerm_postgresql_flexible_server_firewall_rule | ✔ | |azurerm_postgresql_server | ✔ | |azurerm_postgresql_server_key | ❌ | |azurerm_postgresql_virtual_network_rule | ✔ | |azurerm_powerbi_embedded | ✔ | |azurerm_private_dns_a_record | ✔ | |azurerm_private_dns_aaaa_record | ✔ | |azurerm_private_dns_cname_record | ✔ | |azurerm_private_dns_mx_record | ✔ | |azurerm_private_dns_ptr_record | ✔ | |azurerm_private_dns_resolver | ✔ | |azurerm_private_dns_resolver_dns_forwarding_ruleset | ✔ | |azurerm_private_dns_resolver_forwarding_rule | ✔ | |azurerm_private_dns_resolver_inbound_endpoint | ✔ | |azurerm_private_dns_resolver_outbound_endpoint | ✔ | |azurerm_private_dns_resolver_virtual_network_link | ✔ | |azurerm_private_dns_srv_record | ✔ | |azurerm_private_dns_txt_record | ✔ | |azurerm_private_dns_zone | ✔ | |azurerm_private_dns_zone_virtual_network_link | ✔ | |azurerm_private_endpoint | ✔ | |azurerm_private_endpoint_connection | ❌ | |azurerm_private_link_service | ✔ | |azurerm_private_link_service_endpoint_connections | ❌ | |azurerm_proximity_placement_group | ✔ | |azurerm_public_ip | ✔ | |azurerm_public_ip_prefix | ✔ | |azurerm_public_ips | ❌ | |azurerm_purview_account | ✔ | |azurerm_recovery_services_vault | ✔ | |azurerm_redhat_openshift_cluster | ✔ | |azurerm_redhat_openshift_domain | ✔ | |azurerm_redis_cache | ✔ | |azurerm_redis_firewall_rule | ✔ | |azurerm_redis_linked_server | ❌ | |azurerm_relay_hybrid_connection | ✔ | |azurerm_relay_namespace | ✔ | |azurerm_resource_group | ✔ | |azurerm_resource_group_policy_assignment | ✔ | |azurerm_resource_group_template_deployment | ✔ | |azurerm_role_assignment | ❌ | |azurerm_role_definition | ✔ | |azurerm_route | ✔ | |azurerm_route_filter | ✔ | |azurerm_route_server | ✔ | |azurerm_route_table | ✔ | |azurerm_search_service | ✔ | |azurerm_security_center_automation | ✔ | |azurerm_security_center_contact | ✔ | |azurerm_security_center_setting | ❌ | |azurerm_security_center_subscription_pricing | ❌ | |azurerm_security_center_workspace | ❌ | |azurerm_sentinel_alert_rule_ms_security_incident | ✔ | |azurerm_sentinel_alert_rule_scheduled | ✔ | |azurerm_service_fabric_cluster | ✔ | |azurerm_service_fabric_mesh_application | ✔ | |azurerm_service_fabric_mesh_local_network | ✔ | |azurerm_service_fabric_mesh_secret | ✔ | |azurerm_service_fabric_mesh_secret_value | ❌ | |azurerm_servicebus_namespace | ✔ | |azurerm_servicebus_namespace_authorization_rule | ✔ | |azurerm_servicebus_namespace_network_rule_set | ❌ | |azurerm_servicebus_queue | ✔ | |azurerm_servicebus_queue_authorization_rule | ✔ | |azurerm_servicebus_subscription | ✔ | |azurerm_servicebus_subscription_rule | ✔ | |azurerm_servicebus_topic | ✔ | |azurerm_servicebus_topic_authorization_rule | ✔ | |azurerm_servicebus_namespace_disaster_recovery_config | ✔ | |azurerm_shared_image | ✔ | |azurerm_shared_image_gallery | ✔ | |azurerm_shared_image_versions | ❌ | |azurerm_signalr_service | ✔ | |azurerm_site_recovery_fabric | ✔ | |azurerm_site_recovery_network_mapping | ✔ | |azurerm_site_recovery_protection_container | ✔ | |azurerm_site_recovery_protection_container_mapping | ✔ | |azurerm_site_recovery_replicated_vm | ✔ | |azurerm_site_recovery_replication_policy | ✔ | |azurerm_snapshot | ✔ | |azurerm_spatial_anchors_account | ✔ | |azurerm_spring_cloud_app | ✔ | |azurerm_spring_cloud_certificate | ✔ | |azurerm_spring_cloud_service | ✔ | |azurerm_sql_active_directory_administrator | ❌ | |azurerm_sql_database | ✔ | |azurerm_sql_elasticpool | ✔ | |azurerm_sql_failover_group | ✔ | |azurerm_sql_firewall_rule | ✔ | |azurerm_sql_server | ✔ | |azurerm_sql_virtual_network_rule | ❌ | |azurerm_static_site | ✔ | |azurerm_storage_account | ✔ | |azurerm_storage_account_blob_container_sas | ❌ | |azurerm_storage_account_customer_managed_key | ❌ | |azurerm_storage_account_network_rules | ❌ | |azurerm_storage_account_sas | ❌ | |azurerm_storage_blob | ✔ | |azurerm_storage_container | ✔ | |azurerm_storage_data_lake_gen2_filesystem | ✔ | |azurerm_storage_data_lake_gen2_path | ✔ | |azurerm_storage_encryption_scope | ✔ | |azurerm_storage_management_policy | ❌ | |azurerm_storage_queue | ✔ | |azurerm_storage_share | ✔ | |azurerm_storage_share_directory | ✔ | |azurerm_storage_sync | ✔ | |azurerm_storage_sync_group | ✔ | |azurerm_storage_table | ✔ | |azurerm_storage_table_entity | ❌ | |azurerm_stream_analytics_function_javascript_udf | ✔ | |azurerm_stream_analytics_job | ✔ | |azurerm_stream_analytics_output_blob | ✔ | |azurerm_stream_analytics_output_eventhub | ✔ | |azurerm_stream_analytics_output_mssql | ✔ | |azurerm_stream_analytics_output_servicebus_queue | ✔ | |azurerm_stream_analytics_output_servicebus_topic | ✔ | |azurerm_stream_analytics_reference_input_blob | ✔ | |azurerm_stream_analytics_stream_input_blob | ✔ | |azurerm_stream_analytics_stream_input_eventhub | ✔ | |azurerm_stream_analytics_stream_input_iothub | ✔ | |azurerm_subnet | ✔ | |azurerm_subnet_nat_gateway_association | ❌ | |azurerm_subnet_network_security_group_association | ❌ | |azurerm_subnet_route_table_association | ❌ | |azurerm_subscription | ❌ | |azurerm_subscription_policy_assignment | ✔ | |azurerm_subscription_template_deployment | ✔ | |azurerm_subscriptions | ❌ | |azurerm_synapse_firewall_rule | ✔ | |azurerm_synapse_integration_runtime_azure | ✔ | |azurerm_synapse_integration_runtime_self_hosted | ✔ | |azurerm_synapse_linked_service | ✔ | |azurerm_synapse_managed_private_endpoint | ✔ | |azurerm_synapse_private_link_hub | ✔ | |azurerm_synapse_role_assignment | ❌ | |azurerm_synapse_spark_pool | ✔ | |azurerm_synapse_sql_pool | ✔ | |azurerm_synapse_sql_pool_vulnerability_assessment_baseline | ✔ | |azurerm_synapse_sql_pool_workload_classifier | ✔ | |azurerm_synapse_sql_pool_workload_group | ✔ | |azurerm_synapse_workspace | ✔ | |azurerm_template_deployment | ✔ | |azurerm_traffic_manager_endpoint | ❌ | |azurerm_traffic_manager_geographical_location | ❌ | |azurerm_traffic_manager_profile | ✔ | |azurerm_user_assigned_identity | ✔ | |azurerm_virtual_desktop_application_group | ✔ | |azurerm_virtual_desktop_host_pool | ✔ | |azurerm_virtual_desktop_workspace | ✔ | |azurerm_virtual_desktop_workspace_application_group_association | ❌ | |azurerm_virtual_hub | ✔ | |azurerm_virtual_hub_bgp_connection | ✔ | |azurerm_virtual_hub_connection | ✔ | |azurerm_virtual_hub_ip | ✔ | |azurerm_virtual_hub_route_table | ✔ | |azurerm_virtual_hub_security_partner_provider | ✔ | |azurerm_virtual_machine | ✔ | |azurerm_virtual_machine_data_disk_attachment | ❌ | |azurerm_virtual_machine_extension | ✔ | |azurerm_virtual_machine_scale_set | ✔ | |azurerm_virtual_machine_scale_set_extension | ✔ | |azurerm_virtual_network | ✔ | |azurerm_virtual_network_gateway | ✔ | |azurerm_virtual_network_gateway_connection | ✔ | |azurerm_virtual_network_peering | ✔ | |azurerm_virtual_wan | ✔ | |azurerm_vmware_cluster | ✔ | |azurerm_vmware_express_route_authorization | ✔ | |azurerm_vmware_private_cloud | ✔ | |azurerm_vpn_gateway | ✔ | |azurerm_vpn_gateway_connection | ✔ | |azurerm_vpn_server_configuration | ✔ | |azurerm_vpn_site | ✔ | |azurerm_web_application_firewall_policy | ✔ | |azurerm_web_pubsub | ✔ | |azurerm_web_pubsub_hub | ✔ | |azurerm_windows_function_app | ✔ | |azurerm_windows_function_app_slot | ✔ | |azurerm_windows_virtual_machine | ✔ | |azurerm_windows_virtual_machine_scale_set | ✔ | |azurerm_windows_web_app | ✔ |

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Microsoft Azure team for the Cloud Adoption Framework guidelines
Terraform community for the excellent provider SDK
All contributors who have helped improve this provider

Made with ❤️ by the Azure CAF community

❌ = Not yet implemented ✔ = Already implemented ⚠ = Will not be implemented

aztfmod/terraform-provider-azurecaf: Terraform provider for the Terraform platform engineering for Azure

Azurecaf Terraform Provider

🎯 Key Features

📦 Quick Start

Installation

Basic Usage

📚 Comprehensive Examples

Example 1: Simple Resource Naming

Result: "stmydata123" (st = storage account slug, mydata = name, 123 = random)

Example 2: Multiple Resources with Consistent Naming

Results:

App Service Plan: "asp-prod-webapp-001"

App Service: "app-prod-webapp-001"

Key Vault: "kv-prod-webapp-001"

Example 3: Using Resource (vs Data Source)

Access individual names:

Primary: azurecaf_name.multiple_resources.result

All: azurecaf_name.multiple_resources.results

Example 4: Passthrough Mode for Validation

Validates that "mystorageaccount123" is compliant with storage account naming rules

Example 5: Advanced Configuration

Result: "corp_prod_database_server_db_001_a1b2"

🛠️ Configuration Reference

Supported Parameters

Output Attributes

🔧 Supported Azure Resources

Popular Resource Types

🚀 Advanced Usage

Environment-Based Naming

Integration with Terraform Modules

🔍 Troubleshooting

Common Issues

Solution: Use shorter base name or disable slug

Solution: Enable input cleaning (default)

Validation Errors

🧪 Testing & Development

Running Unit Tests

Running Integration Tests

Run specific integration tests

Test Coverage

Test Organization

Comprehensive Testing Framework

Run resource matrix validation (category-based testing and constraint validation)

Test resource definition completeness

Writing New Tests

Makefile Targets

Run tests with coverage reporting

Generate HTML coverage report

Run integration tests

Run data source integration tests

Run error handling integration tests

Run resource naming convention tests

Run all tests (unit and integration)

Run CI tests (unit tests with coverage, no integration tests)

Comprehensive testing framework

Build the project and run unit tests

Clean up build artifacts

Building the Provider

🤝 Contributing

Contributing Guidelines

Adding New Resource Types

🌟 Community & Support

🔗 Related Projects

📊 Resource Status

📜 License

🙏 Acknowledgments

Reading Mode

Related Stories

Qwen3-Coder writes less secure code when told it's for a US persona

I built a 3D game that shows the exact hop where your AWS design fails. Help me break it.

Who Runs the .com Internet? Top DNS Providers

An Overview of Agent Substrate

I'm 12. I Built an Ephemeral Cloud Platform on a $150 Phone (And Fought 10 Bugs to Win)

Related Stories

`Result: "stmydata123" (st = storage account slug, mydata = name, 123 = random)`

`Key Vault: "kv-prod-webapp-001"`

`All: azurecaf_name.multiple_resources.results`

`Validates that "mystorageaccount123" is compliant with storage account naming rules`

`Result: "corp_prod_database_server_db_001_a1b2"`