# TFFR7 - AzAPI - retry and timeouts variables

Module Specification for the Azure Verified Modules (AVM) program

ID: TFFR7 - Category: Inputs/Outputs - AzAPI - retry and timeouts variables The retry and timeouts blocks of every azapi_resource declared by the module MUST be configurable by the consumer. Authors MUST NOT hard-code values inline that the consumer cannot override.
To meet this requirement, the module MUST expose two variables:
retry — an object variable controlling the AzAPI retry block. timeouts — an object variable controlling the AzAPI timeouts block. Both variables:
MAY define module-level defaults (e.g., a default error_message_regex such as "ScopeLocked" for resources that race with lock removal, or a default delete = "5m"). MUST allow the consumer to override the defaults — either by supplying a non-null value at the variable level, or by allowing per-field overrides through optional(...) attributes. MUST be applied to every azapi_resource (and equivalent AzAPI resources) declared by the module. MUST cascade to submodules — the parent module’s retry and timeouts values MUST be passed through to each submodule it instantiates (see TFRMNFR1). Submodules MAY additionally expose per-item overrides for cases where individual resources need different settings. variable "retry" { type = object({ error_message_regex = optional(list(string)) interval_seconds = optional(number) max_interval_seconds = optional(number) }) default = null description = <<DESCRIPTION Retry configuration applied to every `azapi` resource managed by the module (root resource and all submodules). Defaults to `null` (no custom retry). - `error_message_regex` - (Optional) A list of regex patterns matching error messages that trigger a retry. - `interval_seconds` - (Optional) Initial interval between retries in seconds. - `max_interval_seconds` - (Optional) Maximum interval between retries in seconds. See <https://registry.terraform.io/providers/Azure/azapi/latest/docs/resources/resource#retry> for full semantics. DESCRIPTION } variable "timeouts" { type = object({ create = optional(string) read = optional(string) update = optional(string) delete = optional(string) }) default = null description = <<DESCRIPTION Default per-operation timeouts applied to every `azapi` resource managed by the module. Defaults to `null` (provider defaults). Each value is a Go duration string (e.g. `30m`, `1h`). - `create` - (Optional) Timeout for create operations. - `read` - (Optional) Timeout for read operations. - `update` - (Optional) Timeout for update operations. - `delete` - (Optional) Timeout for delete operations. DESCRIPTION } resource "azapi_resource" "this" { type = var.resource_types.this name = var.name parent_id = var.parent_id body = { /* ... */ } # `retry` is an attribute on `azapi_resource`, so the variable can be # assigned directly. `timeouts` is a block, so a `dynamic "timeouts"` # block is required to honor the variable's `null` default. retry = var.retry dynamic "timeouts" { for_each = var.timeouts == null ? [] : [var.timeouts] content { create = timeouts.value.create read = timeouts.value.read update = timeouts.value.update delete = timeouts.value.delete } } response_export_values = [] } module "child" { source = "./modules/child" # Cascade retry and timeouts to the submodule. retry = var.retry timeouts = var.timeouts # ...other arguments... } 

---
Source: https://raw.githubusercontent.com/Azure/Azure-Verified-Modules/refs/heads/main/docs/content/specs-defs/includes/terraform/shared/functional/TFFR7.md
Last Modified: 0001-01-01