Azure landing zones Terraform module

[!IMPORTANT]

For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.

Please see the documentation at .

⚠️ DEPRECATION NOTICE

This module is now in extended support mode and will be archived on August 1, 2026.

Current Status

• Extended Support Period: This module is now in extended support for one year (until August 1, 2026)
• Support Scope: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
• No New Features: No new features or functionality will be added to this module

Migration Path

We strongly recommend that all users migrate to the new Azure Verified Modules approach for Azure Landing Zones. This new approach provides:

• Enhanced reliability and testing
• Improved modularity and flexibility
• Better alignment with Azure best practices
• Ongoing feature development and support

Further reading: Please read our recent blog

Migration Guide: Please visit aka.ms/alz/tf/migrate for detailed migration guidance and resources.

Timeline

• Now - August 1, 2026: Extended support (quality and policy updates only)
• August 1, 2026: Repository will be archived and no further updates will be made

Questions?

If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.

Detailed information about how to use, configure and extend this module can be found on our Wiki:

• Home
• User Guide
• Examples
• Frequently Asked Questions
• Troubleshooting

Overview

The Azure landing zones Terraform module is designed to accelerate deployment of platform resources based on the Azure landing zones conceptual architecture using Terraform.

This is currently split logically into the following capabilities within the module (links to further guidance on the Wiki):

| Module capability | Scope | Design area | | :--- | :--- | :--- | | Core Resources | Management group and subscription organization | Resource organization | | Management Resources | Management subscription | Management | | Connectivity Resources | Connectivity subscription | Network topology and connectivity | | Identity Resources | Identity subscription | Identity and access management |

Using a very simple initial configuration, the module will deploy a management group hierarchy based on the above diagram. This includes the recommended governance baseline, applied using Azure Policy and Access control (IAM) resources deployed at the management group scope. The default configuration can be easily extended to meet differing requirements, and includes the ability to deploy platform resources in the management and connectivity subscriptions.

NOTE: In addition to setting input variables to control which resources are deployed, the module requires setting a Provider Configuration block to enable deployment across multiple subscriptions.

Although resources are logically grouped to simplify operations, the modular design of the module also allows resources to be deployed using different Terraform workspaces. This allows customers to address concerns around managing large state files, or assigning granular permissions to pipelines based on the principle of least privilege. (more information coming soon in the Wiki)

Terraform versions

This module has been tested using Terraform 1.7.0 and AzureRM Provider 3.108.0 as a baseline, and various versions to up the latest at time of release. In some cases, individual versions of the AzureRM provider may cause errors. If this happens, we advise upgrading to the latest version and checking our troubleshooting guide before raising an issue.

Usage

We recommend starting with the following configuration in your root module to learn what resources are created by the module and how it works.

This will deploy the core components only.

NOTE: For production use we highly recommend using the Terraform Registry and pinning to the latest stable version, as per the example below.

Pinning to the main branch in GitHub will give you the latest updates quicker, but increases the likelihood of unplanned changes to your environment and unforeseen issues.

main.tf

# Configure Terraform to set the required AzureRM provider
version and features{} block.
terraform {   required_providers {     azurerm = {       source  = "hashicorp/azurerm"       version = "~> 3.107"     }   } }
provider "azurerm" {   features {} }
Get the current client configuration from the AzureRM provider.
This is used to populate the rootparentid variable with the
current Tenant ID used as the ID for the "Tenant Root Group"
management group.
data "azurermclientconfig" "core" {}
Use variables to customize the deployment
variable "root_id" {   type    = string   default = "es" }
variable "root_name" {   type    = string   default = "Enterprise-Scale" }
variable "default_location" {   type    = string }
Declare the Azure landing zones Terraform module
and provide a base configuration.
module "enterprise_scale" {   source  = "Azure/caf-enterprise-scale/azurerm"   version = "<version>" # change this to your desired version, https://www.terraform.io/language/expressions/version-constraints
defaultlocation = var.defaultlocation
providers = {     azurerm              = azurerm     azurerm.connectivity = azurerm     azurerm.management   = azurerm   }
rootparentid = data.azurermclientconfig.core.tenant_id   rootid        = var.rootid   rootname      = var.rootname
}

NOTE: For additional guidance on how to customize your deployment using the advanced configuration options for this module, please refer to our User Guide and the additional examples in our documentation.

Permissions

Please refer to our Module Permissions guide on the Wiki.

Examples

The following list outlines some of our most popular examples:

• Examples - Level 100

- Deploy Default Configuration - Deploy Demo Landing Zone Archetypes

• Examples - Level 200

- Deploy Custom Landing Zone Archetypes - Deploy Connectivity Resources - Deploy Identity Resources - Deploy Management Resources - Assign a Built-in Policy

• Examples - Level 300

- Deploy Connectivity Resources With Custom Settings - Deploy Identity Resources With Custom Settings - Deploy Management Resources With Custom Settings - Expand Built-in Archetype Definitions - Create Custom Policies, Policy Sets and Assignments

For the complete list of our latest examples, please refer to our Examples page on the Wiki.

Release notes

Please see the releases page for the latest module updates.

Upgrade guides

For upgrade guides from previous versions, please refer to the following links:

• Upgrade from v5.2.1 to v6.0.0
• Upgrade from v4.2.0 to v5.0.0
• Upgrade from v3.3.0 to v4.0.0
• Upgrade from v2.4.1 to v3.0.0
• Upgrade from v1.1.4 to v2.0.0
• Upgrade from v0.4.0 to v1.0.0
• Upgrade from v0.3.3 to v0.4.0
• Upgrade from v0.1.2 to v0.2.0
• Upgrade from v0.0.8 to v0.1.0

Documentation

Requirements

The following requirements are needed by this module:

• terraform (~> 1.7)

• azapi (~> 1.13, != 1.13.0)

• azurerm (~> 3.108)

• random (~> 3.6)

• time (~> 0.11)

Modules

The following Modules are called:

connectivity\_resources

Source: ./modules/connectivity

Version:

identity\_resources

Source: ./modules/identity

Version:

management\group\archetypes

Source: ./modules/archetypes

Version:

management\_resources

Source: ./modules/management

Version:

role\assignments\for\_policy

Source: ./modules/roleassignmentsfor_policy

Version:

Required Inputs

The following input variables are required:

default\_location

Description: Must be specified, e.g eastus. Will set the Azure region in which region bound resources will be deployed. Please see: https://azure.microsoft.com/en-gb/global-infrastructure/geographies/

Type: string

root\parent\id

Description: The root\parent\id is used to specify where to set the root for all Landing Zone deployments. Usually the Tenant ID when deploying the core Enterprise-scale Landing Zones.

Type: string

Optional Inputs

The following input variables are optional (have default values):

archetype\config\overrides

Description: If specified, will set custom Archetype configurations for the core ALZ Management Groups. Does not work for management groups specified by the 'custom\landing\zones' input variable. To override the default configuration settings for any of the core Management Groups, add an entry to the archetype\config\overrides variable for each Management Group you want to customize. To create a valid archetype\config\overrides entry, you must provide the required values in the archetype\config\overrides object for the Management Group you wish to re-configure. To do this, simply create an entry similar to the root example below for one or more of the supported core Management Group IDs:

• root
• decommissioned
• sandboxes
• landing-zones
• platform
• connectivity
• management
• identity
• corp
• online
• sap

map(
  object({
    archetype_id     = string
    enforcement_mode = map(bool)
    parameters       = map(any)
    access_control   = map(list(string))
  })
)

e.g.

archetypeconfigoverrides = {
    root = {
      archetype_id = "root"
      enforcement_mode = {
        "Example-Policy-Assignment" = true,
      }
      parameters = {
        Example-Policy-Assignment = {
          parameterStringExample = "value1",
          parameterBoolExample   = true,
          parameterNumberExample = 10,
          parameterListExample = [
            "listItem1",
            "listItem2",
          ]
          parameterObjectExample = {
            key1 = "value1",
            key2 = "value2",
          }
        }
      }
      access_control = {
        Example-Role-Definition = [
          "00000000-0000-0000-0000-000000000000", # Object ID of user/group/spn/mi from Microsoft Entra ID
          "11111111-1111-1111-1111-111111111111", # Object ID of user/group/spn/mi from Microsoft Entra ID
        ]
      }
    }
  }

Type: any

Default: {}

configure\connectivity\resources

Description: If specified, will customize the \"Connectivity\" landing zone settings and resources.

Notes for the configureconnectivityresources variable:

• settings.hubnetworkvirtualnetworkgateway.config.address_prefix

- Only support adding a single address prefix for GatewaySubnet subnet

• settings.hubnetworkvirtualnetworkgateway.config.gatewayskuexpressroute

- If specified, will deploy the ExpressRoute gateway into the GatewaySubnet subnet

• settings.hubnetworkvirtualnetworkgateway.config.gatewayskuvpn

- If specified, will deploy the VPN gateway into the GatewaySubnet subnet

• settings.hubnetworkvirtualnetworkgateway.config.advancedvpnsettings.privateipaddress_allocation

- Valid options are "", "Static" or "Dynamic". Will set privateipaddressenabled and privateipaddressallocation as needed.

• settings.azurefirewall.config.addressprefix

- Only support adding a single address prefix for AzureFirewallManagementSubnet subnet

Type:

object({
    settings = optional(object({
      hub_networks = optional(list(
        object({
          enabled = optional(bool, true)
          config = object({
            address_space                = list(string)
            location                     = optional(string, "")
            linktoddosprotectionplan = optional(bool, false)
            dns_servers                  = optional(list(string), [])
            bgp_community                = optional(string, "")
            subnets = optional(list(
              object({
                name                      = string
                address_prefixes          = list(string)
                networksecuritygroup_id = optional(string, "")
                routetableid            = optional(string, "")
              })
            ), [])
            virtualnetworkgateway = optional(object({
              enabled = optional(bool, false)
              config = optional(object({
                address_prefix              = optional(string, "")
                gatewayskuexpressroute    = optional(string, "")
                gatewayskuvpn             = optional(string, "")
                remotevnettraffic_enabled = optional(bool, false)
                virtualwantraffic_enabled = optional(bool, false)
                advancedvpnsettings = optional(object({
                  enable_bgp                       = optional(bool, null)
                  active_active                    = optional(bool, null)
                  privateipaddress_allocation    = optional(string, "")
                  defaultlocalnetworkgatewayid = optional(string, "")
                  vpnclientconfiguration = optional(list(
                    object({
                      address_space = list(string)
                      aad_tenant    = optional(string, null)
                      aad_audience  = optional(string, null)
                      aad_issuer    = optional(string, null)
                      root_certificate = optional(list(
                        object({
                          name             = string
                          publiccertdata = string
                        })
                      ), [])
                      revoked_certificate = optional(list(
                        object({
                          name       = string
                          thumbprint = string
                        })
                      ), [])
                      radiusserveraddress = optional(string, null)
                      radiusserversecret  = optional(string, null)
                      vpnclientprotocols  = optional(list(string), null)
                      vpnauthtypes        = optional(list(string), null)
                    })
                  ), [])
                  bgp_settings = optional(list(
                    object({
                      asn         = optional(number, null)
                      peer_weight = optional(number, null)
                      peering_addresses = optional(list(
                        object({
                          ipconfigurationname = optional(string, null)
                          apipa_addresses       = optional(list(string), null)
                        })
                      ), [])
                    })
                  ), [])
                  custom_route = optional(list(
                    object({
                      address_prefixes = optional(list(string), [])
                    })
                  ), [])
                }), {})
              }), {})
            }), {})
            azure_firewall = optional(object({
              enabled = optional(bool, false)
              config = optional(object({
                address_prefix                = optional(string, "")
                addressmanagementprefix     = optional(string, "")
                enablednsproxy              = optional(bool, true)
                dns_servers                   = optional(list(string), [])
                sku_tier                      = optional(string, "Standard")
                basepolicyid                = optional(string, "")
                privateipranges             = optional(list(string), [])
                threatintelligencemode      = optional(string, "Alert")
                threatintelligenceallowlist = optional(map(list(string)), {})
                availability_zones = optional(object({
                  zone_1 = optional(bool, true)
                  zone_2 = optional(bool, true)
                  zone_3 = optional(bool, true)
                }), {})
              }), {})
            }), {})
            spokevirtualnetworkresourceids      = optional(list(string), [])
            enableoutboundvirtualnetworkpeering = optional(bool, false)
            enablehubnetworkmeshpeering         = optional(bool, false)
          })
        })
      ), [])
      vwanhubnetworks = optional(list(
        object({
          enabled = optional(bool, true)
          config = object({
            address_prefix = string
            location       = string
            sku            = optional(string, "")
            routes = optional(list(
              object({
                address_prefixes    = list(string)
                nexthopip_address = string
              })
            ), [])
            routing_intent = optional(object({
              enabled = optional(bool, false)
              config = optional(object({
                routing_policies = optional(list(object({
                  name         = string
                  destinations = list(string)
                })), [])
              }), {})
            }), {})
            expressroute_gateway = optional(object({
              enabled = optional(bool, false)
              config = optional(object({
                scale_unit                    = optional(number, 1)
                allownonvirtualwantraffic = optional(bool, false)
              }), {})
            }), {})
            vpn_gateway = optional(object({
              enabled = optional(bool, false)
              config = optional(object({
                bgp_settings = optional(list(
                  object({
                    asn         = number
                    peer_weight = number
                    instance0bgppeeringaddress = optional(list(
                      object({
                        custom_ips = list(string)
                      })
                    ), [])
                    instance1bgppeeringaddress = optional(list(
                      object({
                        custom_ips = list(string)
                      })
                    ), [])
                  })
                ), [])
                routing_preference = optional(string, "Microsoft Network")
                scale_unit         = optional(number, 1)
              }), {})
            }), {})
            azure_firewall = optional(object({
              enabled = optional(bool, false)
              config = optional(object({
                enablednsproxy              = optional(bool, true)
                dns_servers                   = optional(list(string), [])
                sku_tier                      = optional(string, "Standard")
                basepolicyid                = optional(string, "")
                privateipranges             = optional(list(string), [])
                threatintelligencemode      = optional(string, "Alert")
                threatintelligenceallowlist = optional(map(list(string)), {})
                availability_zones = optional(object({
                  zone_1 = optional(bool, true)
                  zone_2 = optional(bool, true)
                  zone_3 = optional(bool, true)
                }), {})
              }), {})
            }), {})
            spokevirtualnetworkresourceids        = optional(list(string), [])
            securespokevirtualnetworkresource_ids = optional(list(string), [])
            enablevirtualhub_connections            = optional(bool, false)
          })
        })
      ), [])
      ddosprotectionplan = optional(object({
        enabled = optional(bool, false)
        config = optional(object({
          location = optional(string, "")
        }), {})
      }), {})
      dns = optional(object({
        enabled = optional(bool, true)
        config = optional(object({
          location = optional(string, "")
          enableprivatelinkbyservice = optional(object({
            azureapimanagement                 = optional(bool, true)
            azureappconfiguration_stores       = optional(bool, true)
            azure_arc                            = optional(bool, true)
            azurearcguest_configuration        = optional(bool, true)
            azurearchybridresourceprovider   = optional(bool, true)
            azurearckubernetes                 = optional(bool, true)
            azureautomationdscandhybridworker  = optional(bool, true)
            azureautomationwebhook             = optional(bool, true)
            azure_backup                         = optional(bool, true)
            azurebatchaccount                  = optional(bool, true)
            azurebotservice_bot                = optional(bool, true)
            azurebotservice_token              = optional(bool, true)
            azurecachefor_redis                = optional(bool, true)
            azurecacheforredisenterprise     = optional(bool, true)
            azurecontainerregistry             = optional(bool, true)
            azurecosmosdb_cassandra            = optional(bool, true)
            azurecosmosdb_gremlin              = optional(bool, true)
            azurecosmosdb_mongodb              = optional(bool, true)
            azurecosmosdb_sql                  = optional(bool, true)
            azurecosmosdb_table                = optional(bool, true)
            azuredataexplorer                  = optional(bool, true)
            azuredatafactory                   = optional(bool, true)
            azuredatafactory_portal            = optional(bool, true)
            azuredatahealthdataservices      = optional(bool, true)
            azuredatalakefilesystem_gen2     = optional(bool, true)
            azuredatabaseformariadbserver    = optional(bool, true)
            azuredatabaseformysqlserver      = optional(bool, true)
            azuredatabaseforpostgresqlserver = optional(bool, true)
            azure_databricks                     = optional(bool, true)
            azuredigitaltwins                  = optional(bool, true)
            azureeventgrid_domain              = optional(bool, true)
            azureeventgrid_topic               = optional(bool, true)
            azureeventhubs_namespace           = optional(bool, true)
            azurefilesync                      = optional(bool, true)
            azure_hdinsights                     = optional(bool, true)
            azureiotdps                        = optional(bool, true)
            azureiothub                        = optional(bool, true)
            azurekeyvault                      = optional(bool, true)
            azurekeyvaultmanagedhsm          = optional(bool, true)
            azurekubernetesservice_management  = optional(bool, true)
            azuremachinelearning_workspace     = optional(bool, true)
            azuremanageddisks                  = optional(bool, true)
            azuremanagedgrafana                = optional(bool, true)
            azuremediaservices                 = optional(bool, true)
            azure_migrate                        = optional(bool, true)
            azure_monitor                        = optional(bool, true)
            azureopenaiservice                 = optional(bool, true)
            azurepurviewaccount                = optional(bool, true)
            azurepurviewstudio                 = optional(bool, true)
            azurerelaynamespace                = optional(bool, true)
            azuresearchservice                 = optional(bool, true)
            azureservicebus_namespace          = optional(bool, true)
            azuresiterecovery                  = optional(bool, true)
            azuresqldatabase_sqlserver         = optional(bool, true)
            azuresynapseanalytics_dev          = optional(bool, true)
            azuresynapseanalytics_sql          = optional(bool, true)
            azuresynapsestudio                 = optional(bool, true)
            azurevirtualdesktop                = optional(bool, true)
            azurewebapps_sites                 = optional(bool, true)
            azurewebappsstaticsites          = optional(bool, true)
            cognitiveservicesaccount           = optional(bool, true)
            microsoftpowerbi                   = optional(bool, true)
            signalr                              = optional(bool, true)
            signalr_webpubsub                    = optional(bool, true)
            storageaccountblob                 = optional(bool, true)
            storageaccountfile                 = optional(bool, true)
            storageaccountqueue                = optional(bool, true)
            storageaccounttable                = optional(bool, true)
            storageaccountweb                  = optional(bool, true)
          }), {})
          privatelinklocations                                 = optional(list(string), [])
          publicdnszones                                       = optional(list(string), [])
          privatednszones                                      = optional(list(string), [])
          enableprivatednszonevirtualnetworklinkonhubs   = optional(bool, true)
          enableprivatednszonevirtualnetworklinkonspokes = optional(bool, true)
          virtualnetworkresourceidsto_link                   = optional(list(string), [])
        }), {})
      }), {})
    }), {})
    location = optional(string, "")
    tags     = optional(any, {})
    advanced = optional(any, {})
  })

Default: {}

configure\identity\resources

Description: If specified, will customize the "Identity" landing zone settings.

Type:

object({
    settings = optional(object({
      identity = optional(object({
        enabled = optional(bool, true)
        config = optional(object({
          enabledenypublic_ip             = optional(bool, true)
          enabledenyrdpfrominternet     = optional(bool, true)
          enabledenysubnetwithoutnsg    = optional(bool, true)
          enabledeployazurebackupon_vms = optional(bool, true)
        }), {})
      }), {})
    }), {})
  })

Default: {}

configure\management\resources

Description: If specified, will customize the "Management" landing zone settings and resources.

Type:

object({
    settings = optional(object({
      ama = optional(object({
        enable_uami                                                         = optional(bool, true)
        enablevminsightsdcr                                               = optional(bool, true)
        enablechangetracking_dcr                                          = optional(bool, true)
        enablemdfcdefenderforsql_dcr                                    = optional(bool, true)
        enablemdfcdefenderforsqlquerycollectionforsecurity_research = optional(bool, true)
      }), {})
      log_analytics = optional(object({
        enabled = optional(bool, true)
        config = optional(object({
          dailyquotagb                         = optional(number, -1)
          retentionindays                      = optional(number, 30)
          enablemonitoringfor_vm               = optional(bool, true)
          enablemonitoringfor_vmss             = optional(bool, true)
          enable_sentinel                        = optional(bool, true)
          enablechangetracking                 = optional(bool, true)
          enablesolutionforvminsights        = optional(bool, true)
          enablesolutionforcontainerinsights = optional(bool, true)
          sentinelcustomermanagedkeyenabled  = optional(bool, false) # not used at this time
        }), {})
      }), {})
      security_center = optional(object({
        enabled = optional(bool, true)
        config = optional(object({
          emailsecuritycontact                                = optional(string, "securitycontact@replaceme")
          enabledefenderforappservices                      = optional(bool, true)
          enabledefenderfor_arm                               = optional(bool, true)
          enabledefenderfor_containers                        = optional(bool, true)
          enabledefenderfor_cosmosdbs                         = optional(bool, true)
          enabledefenderfor_cspm                              = optional(bool, true)
          enabledefenderforkeyvault                         = optional(bool, true)
          enabledefenderforossdatabases                     = optional(bool, true)
          enabledefenderfor_servers                           = optional(bool, true)
          enabledefenderforserversvulnerability_assessments = optional(bool, true)
          enabledefenderforsqlservers                       = optional(bool, true)
          enabledefenderforsqlserver_vms                    = optional(bool, true)
          enabledefenderfor_storage                           = optional(bool, true)
        }), {})
      }), {})
    }), {})
    location = optional(string, "")
    tags     = optional(any, {})
    advanced = optional(any, {})
  })

Default: {}

create\duration\delay

Description: Used to tune terraform apply when faced with errors caused by API caching or eventual consistency. Sets a custom delay period after creation of the specified resource type.

Type:

object({
    azurermmanagementgroup      = optional(string, "30s")
    azurermpolicyassignment     = optional(string, "30s")
    azurermpolicydefinition     = optional(string, "30s")
    azurermpolicyset_definition = optional(string, "30s")
    azurermroleassignment       = optional(string, "0s")
    azurermroledefinition       = optional(string, "60s")
  })

Default: {}

custom\landing\zones

Description: If specified, will deploy additional Management Groups alongside Enterprise-scale core Management Groups. Although the object type for this input variable is set to any, the expected object is based on the following structure:

variable "customlandingzones" {
  type = map(
    object({
      display_name               = string
      parentmanagementgroup_id = string
      subscription_ids           = list(string)
      archetype_config = object({
        archetype_id   = string
        parameters     = map(any)
        access_control = map(list(string))
      })
    })
  )

The decision not to hard code the structure in the input variable type is by design, as it allows Terraform to handle the input as a dynamic object type. This was necessary to allow the parameters value to be correctly interpreted. Without this, Terraform would throw an error if each parameter value wasn't a consistent type, as it would incorrectly identify the input as a tuple which must contain consistent type structure across all entries.

Note the id of the custom landing zone will be appended to var.root_id. The maximum length of the resulting name must be less than 90 characters.

The customlandingzones object is used to deploy additional Management Groups within the core Management Group hierarchy. The main object parameters are displayname, parentmanagementgroupid, subscriptionidsand archetypeconfig.

• display_name is the name assigned to the Management Group.

• parentmanagementgroup_id is the name of the parent Management Group and must be a valid Management Group ID.

• subscription_ids is an object containing a list of Subscription IDs to assign to the current Management Group.

• archetypeconfig is used to configure the configuration applied to each Management Group. This object must contain valid entries for the archetypeid parameters, and access_control attributes.

The following example shows how you would add a simple Management Group under the myorg-landing-zones Management Group, where rootid = "myorg" and using the default\empty archetype definition.

customlandingzones = {
    myorg-customer-corp = {
      display_name               = "MyOrg Customer Corp"
      parentmanagementgroup_id = "myorg-landing-zones"
      subscription_ids           = [
        "00000000-0000-0000-0000-000000000000",
        "11111111-1111-1111-1111-111111111111",
      ]
      archetype_config = {
        archetypeid   = "defaultempty"
        parameters     = {}
        access_control = {}
      }
    }
  }

Type: any

Default: {}

custom\policy\roles

Description: If specified, the custom\policy\roles variable overrides which Role Definition ID(s) (value) to assign for Policy Assignments with a Managed Identity, if the assigned "policyDefinitionId" (key) is included in this variable.

Type: map(list(string))

Default: {}

default\_tags

Description: If specified, will set the default tags for all resources deployed by this module where supported.

Type: map(string)

Default: {}

deploy\connectivity\resources

Description: If set to true, will enable the "Connectivity" landing zone settings and add "Connectivity" resources into the current Subscription context.

Type: bool

Default: false

deploy\core\landing\_zones

Description: If set to true, module will deploy the core Enterprise-scale Management Group hierarchy, including "out of the box" policies and roles.

Type: bool

Default: true

deploy\corp\landing\_zones

Description: If set to true, module will deploy the "Corp" Management Group, including "out of the box" policies and roles.

Type: bool

Default: false

deploy\demo\landing\_zones

Description: If set to true, module will deploy the demo "Landing Zone" Management Groups ("Corp", "Online", and "SAP") into the core Enterprise-scale Management Group hierarchy.

Type: bool

Default: false

deploy\diagnostics\for\_mg

Description: If set to true, will deploy Diagnostic Settings for management groups

Type: bool

Default: false

deploy\identity\resources

Description: If set to true, will enable the "Identity" landing zone settings.

Type: bool

Default: false

deploy\management\resources

Description: If set to true, will enable the "Management" landing zone settings and add "Management" resources into the current Subscription context.

Type: bool

Default: false

deploy\online\landing\_zones

Description: If set to true, module will deploy the "Online" Management Group, including "out of the box" policies and roles.

Type: bool

Default: false

deploy\sap\landing\_zones

Description: If set to true, module will deploy the "SAP" Management Group, including "out of the box" policies and roles.

Type: bool

Default: false

destroy\duration\delay

Description: Used to tune terraform deploy when faced with errors caused by API caching or eventual consistency. Sets a custom delay period after destruction of the specified resource type.

Type:

object({
    azurermmanagementgroup      = optional(string, "0s")
    azurermpolicyassignment     = optional(string, "0s")
    azurermpolicydefinition     = optional(string, "0s")
    azurermpolicyset_definition = optional(string, "0s")
    azurermroleassignment       = optional(string, "0s")
    azurermroledefinition       = optional(string, "0s")
  })

Default: {}

disable\base\module\_tags

Description: If set to true, will remove the base module tags applied to all resources deployed by the module which support tags.

Type: bool

Default: false

disable\_telemetry

Description: If set to true, will disable telemetry for the module. See https://aka.ms/alz-terraform-module-telemetry.

Type: bool

Default: false

library\_path

Description: If specified, sets the path to a custom library folder for archetype artefacts.

Type: string

Default: ""

policy\non\compliance\message\default

Description: If set overrides the default non-compliance message used for policy assignments.

Type: string

Default: "This resource {enforcementMode} be compliant with the assigned policy."

policy\non\compliance\message\default\_enabled

Description: If set to true, will enable the use of the default custom non-compliance messages for policy assignments if they are not provided.

Type: bool

Default: true

policy\non\compliance\message\enabled

Description: If set to false, will disable non-compliance messages altogether.

Type: bool

Default: true

policy\non\compliance\message\enforced\_replacement

Description: If set overrides the non-compliance replacement used for enforced policy assignments.

Type: string

Default: "must"

policy\non\compliance\message\enforcement\_placeholder

Description: If set overrides the non-compliance message placeholder used in message templates.

Type: string

Default: "{enforcementMode}"

policy\non\compliance\message\not\enforced\replacement

Description: If set overrides the non-compliance replacement used for unenforced policy assignments.

Type: string

Default: "should"

policy\non\compliance\message\not\supported\definitions

Description: If set, overrides the list of built-in policy definition that do not support non-compliance messages.

Type: list(string)

Default:

[
  "/providers/Microsoft.Authorization/policyDefinitions/1c6e92c9-99f0-4e55-9cf2-0c234dc48f99",
  "/providers/Microsoft.Authorization/policyDefinitions/1a5b4dca-0b6f-4cf5-907c-56316bc1bf3d",
  "/providers/Microsoft.Authorization/policyDefinitions/95edb821-ddaf-4404-9732-666045e056b4"
]

resource\custom\timeouts

Description: Optional - Used to tune terraform deploy when faced with errors caused by API limits.

For each supported resource type, there is a child object that specifies the create, update, and delete timeouts. Each of these arguments takes a string representation of a duration, such as "60m" for 60 minutes, "10s" for ten seconds, or "2h" for two hours. If a timeout is not specified, the default value for the resource will be used.

e.g.

resourcecustomtimeouts = {
  azurermprivatedns_zone = {
    create = "1h"
    update = "1h30m"
    delete = "30m"
    read   = "30s"
  }
}

Type:

object({
    azurermprivatedns_zone = optional(object({
      create = optional(string, null)
      update = optional(string, null)
      read   = optional(string, null)
      delete = optional(string, null)
    }), {})
    azurermprivatednszonevirtualnetworklink = optional(object({
      create = optional(string, null)
      update = optional(string, null)
      read   = optional(string, null)
      delete = optional(string, null)
    }), {})
  })

Default: {}

root\_id

Description: If specified, will set a custom Name (ID) value for the Enterprise-scale "root" Management Group, and append this to the ID for all core Enterprise-scale Management Groups.

Type: string

Default: "es"

root\_name

Description: If specified, will set a custom Display Name value for the Enterprise-scale "root" Management Group.

Type: string

Default: "Enterprise-Scale"

strict\subscription\association

Description: If set to true, subscriptions associated to management groups will be exclusively set by the module and any added by another process will be removed. If set to false, the module will will only enforce association of the specified subscriptions and those added to management groups by other processes will not be removed. Default is false as this works better with subscription vending.

Type: bool

Default: false

subscription\id\connectivity

Description: If specified, identifies the Platform subscription for "Connectivity" for resource deployment and correct placement in the Management Group hierarchy.

Type: string

Default: ""

subscription\id\identity

Description: If specified, identifies the Platform subscription for "Identity" for resource deployment and correct placement in the Management Group hierarchy.

Type: string

Default: ""

subscription\id\management

Description: If specified, identifies the Platform subscription for "Management" for resource deployment and correct placement in the Management Group hierarchy.

Type: string

Default: ""

subscription\id\overrides

Description: If specified, will be used to assign subscription\_ids to the default Enterprise-scale Management Groups.

Type: map(list(string))

Default: {}

template\file\variables

Description: If specified, provides the ability to define custom template variables used when reading in template files from the built-in and custom library\_path.

Type: any

Default: {}

Resources

The following resources are used by this module:

• azapiresource.datacollectionrule (resource)
• azapiresource.diag_settings (resource)
• azurermautomationaccount.management (resource)
• azurermdnszone.connectivity (resource)
• azurermexpressroutegateway.virtual_wan (resource)
• azurermfirewall.connectivity (resource)
• azurermfirewall.virtual_wan (resource)
• azurermfirewallpolicy.connectivity (resource)
• azurermfirewallpolicy.virtual_wan (resource)
• azurermloganalyticslinkedservice.management (resource)
• azurermloganalyticssolution.management (resource)
• azurermloganalyticsworkspace.management (resource)
• azurermmanagementgroup.level_1 (resource)
• azurermmanagementgroup.level_2 (resource)
• azurermmanagementgroup.level_3 (resource)
• azurermmanagementgroup.level_4 (resource)
• azurermmanagementgroup.level_5 (resource)
• azurermmanagementgroup.level_6 (resource)
• azurermmanagementgrouppolicyassignment.enterprise_scale (resource)
• azurermmanagementgroupsubscriptionassociation.enterprise_scale (resource)
• azurermnetworkddosprotectionplan.connectivity (resource)
• azurermpolicydefinition.enterprise_scale (resource)
• azurermpolicysetdefinition.enterprise_scale (resource)
• azurermprivatednszone.connectivity (resource)
• azurermprivatednszonevirtualnetworklink.connectivity (resource)
• azurermpublicip.connectivity (resource)
• azurermresourcegroup.connectivity (resource)
• azurermresourcegroup.management (resource)
• azurermresourcegroup.virtual_wan (resource)
• azurermroleassignment.amamanagedidentity_operator (resource)
• azurermroleassignment.ama_reader (resource)
• azurermroleassignment.deployazsqldbauditing_connectivity (resource)
• azurermroleassignment.enterprise_scale (resource)
• azurermroleassignment.policy_assignment (resource)
• azurermroleassignment.privatednszonecontributorconnectivity (resource)
• azurermroledefinition.enterprise_scale (resource)
• azurermsubnet.connectivity (resource)
• azurermsubscriptiontemplatedeployment.telemetry_connectivity (resource)
• azurermsubscriptiontemplatedeployment.telemetry_core (resource)
• azurermsubscriptiontemplatedeployment.telemetry_identity (resource)
• azurermsubscriptiontemplatedeployment.telemetry_management (resource)
• azurermuserassignedidentity.management (resource)
• azurermvirtualhub.virtual_wan (resource)
• azurermvirtualhubconnection.virtual_wan (resource)
• azurermvirtualhubroutingintent.virtual_wan (resource)
• azurermvirtualnetwork.connectivity (resource)
• azurermvirtualnetworkgateway.connectivity (resource)
• azurermvirtualnetworkpeering.connectivity (resource)
• azurermvirtualwan.virtual_wan (resource)
• azurermvpngateway.virtual_wan (resource)
• randomid.telem (resource)
• timesleep.afterazurermmanagement_group (resource)
• timesleep.afterazurermpolicy_assignment (resource)
• timesleep.afterazurermpolicy_definition (resource)
• timesleep.afterazurermpolicysetdefinition (resource)
• timesleep.afterazurermrole_assignment (resource)
• timesleep.afterazurermrole_definition (resource)
• azapiresource.user_msi (data source)
• azurermpolicydefinition.external_lookup (data source)
• azurerm

---

README truncated. [View on GitHub