TFFR3 - Providers - Permitted Versions

ID: TFFR3 - Category: Providers - Permitted Versions

Authors MUST only use the following Azure providers, and versions, in their modules:

provider	min version	max version
Azure/azapi	>= 2.12	< 3.0

Note

The AzAPI floor is 2.12 because TFFR8 requires every module to expose the ignore_body_changes argument, which was introduced in Azure/azapi v2.12.0. Modules pinned below that version will fail to plan because the argument is absent from the provider schema.

The AzureRM provider MUST NOT be used, except where the narrow exception below applies.

Exception — AzureRM for resources with no AzAPI equivalent

An AVM Terraform module MAY declare the AzureRM provider only for resources whose functionality is genuinely unavailable through any AzAPI resource — that is, where there is no equivalent in azapi_resource, azapi_data_plane_resource, azapi_resource_action, or azapi_update_resource. In practice this is limited to a small set of edge cases, most commonly data-plane operations such as Key Vault secrets and certificates, Storage blobs, and a handful of resources whose azurerm_* implementation calls non-ARM APIs.

Where this exception applies the module MUST:

Pin the AzureRM provider to ~> 4.0 in required_providers.
Use AzAPI for every resource that has an AzAPI equivalent. AzureRM MUST NOT be used as a convenience alternative to AzAPI.
Document the exception in the module’s README.md, listing each azurerm_* resource used, the data-plane / non-ARM API it wraps, why no AzAPI equivalent exists today, and the upstream AzAPI issue or PR tracking the eventual replacement.
Replace each azurerm_* resource with its AzAPI equivalent as soon as one becomes available, in the next module release after the AzAPI capability ships.
Add the following TFLint exclusion (only required because the AzureRM provider is otherwise blocked by AVM tooling):
```
rule "provider_azurerm_disallowed" {
  enabled = false
}
```

This exception MUST NOT be used to:

Avoid migrating an existing AzureRM resource that does have an AzAPI equivalent.
Reduce author effort where the AzAPI body schema is more verbose than the AzureRM resource.
Side-step any other AzAPI-specific spec (for example TFFR4, TFFR5, TFFR6, or TFFR7) — those rules continue to apply to every AzAPI resource the module declares, regardless of whether the module also uses AzureRM under this exception.

Authors MUST use the required_providers block in their module to enforce the provider versions.

The following is an example.

In it we use the pessimistic version constraint operator ~>.
That is to say that ~> 2.12 is equivalent to >= 2.12, < 3.0.

terraform {
  required_providers {
    # Include one or both providers, as needed
    azapi = {
      source  = "Azure/azapi"
      version = "~> 2.12"
    }
  }
}