feat: add retry variable to all azapi resources (#272)

Add a configurable retry variable that is passed to all azapi_resource,
azapi_update_resource, and azapi_resource_action resources across the
root module, slot submodule, and all config submodules.

The default retries on 409 Conflict errors caused by concurrent
operations ('Cannot modify this site because another operation is in
progress') with 10 second intervals and up to 3 retries.

Author: jaredfholgate

README.md

@@ -1615,6 +1615,34 @@ object({
 
 Default: `null`
 
+### <a name="input_retry"></a> [retry](#input\_retry)
+
+Description: Retry configuration for all azapi resources. Defaults to retrying on 409 Conflict errors caused by concurrent operations.
+
+- `error_message_regex` - (Required) A list of regular expressions to match against error messages. If any match, the operation will be retried.
+- `interval_seconds` - (Optional) The initial interval in seconds between retries. Defaults to `10`.
+- `max_retries` - (Optional) The maximum number of retries. Defaults to `3`.
+
+Type:
+
+```hcl
+object({
+    error_message_regex = list(string)
+    interval_seconds    = optional(number, 10)
+    max_retries         = optional(number, 3)
+  })
+```
+
+Default:
+
+```json
+{
+  "error_message_regex": [
+    "Cannot modify this site because another operation is in progress"
+  ]
+}
+```
+
 ### <a name="input_role_assignments"></a> [role\_assignments](#input\_role\_assignments)
 
 Description: A map of role assignments to create on this resource. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

examples/windows_dotnet10/README.md

@@ -37,7 +37,7 @@ resource "azapi_resource" "service_plan" {
   body = {
     kind = "app"
     sku = {
-      name = "P1v2"
+      name = "P1v3"
     }
     properties = {
       reserved      = false

examples/windows_dotnet10/main.tf

@@ -26,7 +26,7 @@ resource "azapi_resource" "service_plan" {
   body = {
     kind = "app"
     sku = {
-      name = "P1v2"
+      name = "P1v3"
     }
     properties = {
       reserved      = false

main.auth.tf

@@ -15,6 +15,7 @@ module "config_authsettings" {
   google                         = each.value.google
   issuer                         = each.value.issuer
   microsoft                      = each.value.microsoft
+  retry                          = var.retry
   runtime_version                = each.value.runtime_version
   token_refresh_extension_hours  = each.value.token_refresh_extension_hours
   token_store_enabled            = each.value.token_store_enabled
@@ -39,6 +40,7 @@ module "config_authsettingsv2" {
   redirect_to_provider                   = each.value.redirect_to_provider
   require_authentication                 = each.value.require_authentication
   require_https                          = each.value.require_https
+  retry                                  = var.retry
   runtime_version                        = each.value.runtime_version
   unauthenticated_client_action          = each.value.unauthenticated_client_action
 }

main.backup.tf

@@ -5,6 +5,7 @@ module "config_backup" {
   parent_id   = azapi_resource.this.id
   backup_name = coalesce(each.value.name, "backup-${var.name}")
   enabled     = each.value.enabled
+  retry       = var.retry
   schedule = each.value.schedule != null ? {
     for sk, sv in each.value.schedule : sk => sv
   }[keys(each.value.schedule)[0]] : null

main.config.tf

@@ -3,27 +3,31 @@ module "config_appsettings" {
 
   app_settings = local.merged_app_settings
   parent_id    = azapi_resource.this.id
+  retry        = var.retry
 }
 
 module "config_connectionstrings" {
   source = "./modules/config_connectionstrings"
 
   connection_strings = var.connection_strings
   parent_id          = azapi_resource.this.id
+  retry              = var.retry
 }
 
 module "config_azurestorageaccounts" {
   source = "./modules/config_azurestorageaccounts"
 
   parent_id               = azapi_resource.this.id
   storage_shares_to_mount = var.storage_shares_to_mount
+  retry                   = var.retry
 }
 
 module "config_metadata" {
   source = "./modules/config_metadata"
 
   metadata  = { for m in coalesce(module.site_config_helpers.site_config_metadata, []) : m.name => m.value }
   parent_id = azapi_resource.this.id
+  retry     = var.retry
 }
 
 module "config_slotconfignames" {
@@ -33,6 +37,7 @@ module "config_slotconfignames" {
   parent_id               = azapi_resource.this.id
   app_setting_names       = flatten([for k, v in var.sticky_settings : coalesce(v.app_setting_names, [])])
   connection_string_names = flatten([for k, v in var.sticky_settings : coalesce(v.connection_string_names, [])])
+  retry                   = var.retry
 }
 
 module "ftp_publishing_credential_policy" {
@@ -42,6 +47,7 @@ module "ftp_publishing_credential_policy" {
   name      = "ftp"
   parent_id = azapi_resource.this.id
   allow     = false
+  retry     = var.retry
 }
 
 module "scm_publishing_credential_policy" {
@@ -51,4 +57,5 @@ module "scm_publishing_credential_policy" {
   name      = "scm"
   parent_id = azapi_resource.this.id
   allow     = false
+  retry     = var.retry
 }

main.custom_domains.tf

@@ -4,6 +4,7 @@ module "hostname_binding" {
 
   hostname   = each.value.hostname
   parent_id  = azapi_resource.this.id
+  retry      = var.retry
   ssl_state  = each.value.ssl_state
   thumbprint = each.value.thumbprint
 }
@@ -14,6 +15,7 @@ module "slot_hostname_binding" {
 
   hostname   = each.value.hostname
   parent_id  = module.slot[each.value.app_service_slot_key].resource_id
+  retry      = var.retry
   ssl_state  = each.value.ssl_state
   thumbprint = each.value.thumbprint
 }

main.deploy.tf

@@ -20,6 +20,7 @@ module "extensions_zipdeploy" {
 
   parent_id       = azapi_resource.this.id
   zip_deploy_file = var.zip_deploy_file
+  retry           = var.retry
 
   depends_on = [
     time_sleep.wait_before_zip_deploy,

main.interfaces.tf

@@ -27,6 +27,7 @@ resource "azapi_resource" "lock" {
   delete_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   read_headers           = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   response_export_values = []
+  retry                  = var.retry
   update_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
 }
 
@@ -42,6 +43,7 @@ resource "azapi_resource" "role_assignment" {
   ignore_null_property   = true
   read_headers           = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   response_export_values = []
+  retry                  = var.retry
   update_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
 }
 
@@ -57,6 +59,7 @@ resource "azapi_resource" "private_endpoint" {
   delete_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   read_headers           = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   response_export_values = []
+  retry                  = var.retry
   tags                   = each.value.tags
   update_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
 }
@@ -72,6 +75,7 @@ resource "azapi_resource" "private_dns_zone_group" {
   delete_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   read_headers           = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   response_export_values = []
+  retry                  = var.retry
   update_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
 }
 
@@ -86,6 +90,7 @@ resource "azapi_resource" "lock_private_endpoint" {
   delete_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   read_headers           = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   response_export_values = []
+  retry                  = var.retry
   update_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
 }
 
@@ -100,6 +105,7 @@ resource "azapi_resource" "role_assignment_private_endpoint" {
   delete_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   read_headers           = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   response_export_values = []
+  retry                  = var.retry
   update_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
 }
 
@@ -115,6 +121,7 @@ resource "azapi_resource" "diagnostic_setting" {
   ignore_null_property   = true
   read_headers           = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
   response_export_values = []
+  retry                  = var.retry
   update_headers         = var.enable_telemetry ? { "User-Agent" : local.avm_azapi_header } : null
 }
 

main.logs.tf

@@ -11,4 +11,5 @@ module "config_logs" {
   http_logs = length(each.value.http_logs) > 0 ? {
     for hlk, hlv in each.value.http_logs : hlk => hlv
   }[keys(each.value.http_logs)[0]] : null
+  retry = var.retry
 }