This module provides an output of all Azure regions and availability zones.
The module outputs a list of objects with the following attributes:
name- The name of the region. E.g. "eastus"display_name- The display name of the region. E.g. "East US".paired_region_name- The name of the region paired with this region. May benullif the region has no pair.geography- The geography of the region.geography_group- The geography group of the region.zones- A list of the availability zones in the region. Will benullif the region does not support zones.
This data is the further composed into useful maps keyed by region name and region display name. Useful filters are also provided.
The following requirements are needed by this module:
The following resources are used by this module:
- modtm_telemetry.telemetry (resource)
- random_uuid.telemetry (resource)
- azapi_client_config.current (data source)
- azapi_client_config.telemetry (data source)
- azapi_resource_action.locations (data source)
- modtm_module_source.telemetry (data source)
No required inputs.
The following input variables are optional (have default values):
Description: If true, the module will only return regions that have availability zones.
Type: bool
Default: false
Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetryinfo.
If it is set to false, then no telemetry will be collected.
Type: bool
Default: true
Description: If set, the module will only return regions that match the specified geography.
Type: string
Default: null
Description: If set, the module will only return regions that match the specified geography group.
Type: string
Default: null
Description: If true, the module will only return regions that are have the category set to Recommended by the locations API.
This is default true as several regions are not available for general deployment and must be explicitly made available via support ticket.
Enabling these regions by default may lead to deployment failures.
Type: bool
Default: true
Description: If true, the module will use cached data from the data directory. If false, the module will use live data from the Azure API.
The default is true to avoid unnecessary API calls and provide a guaranteed consistent output.
Set to false to ensure the latest data is used.
Using data from the Azure APIs means that if the API response changes, then the module output will change.
This may affect deployed resources that rely on this data.
Type: bool
Default: true
The following outputs are exported:
Description: A list of region objects subject to the filters supplied by input variables. Each region object contains the following attributes:
name- The name of the region.display_name- The display name of the region.paired_region_name- The name of the region paired with this region. May benullif the region has no pair.geography- The geography of the region.geography_group- The geography group of the region.zones- A list of the availability zones in the region. Will be empty if the region does not support zones.
Description: A map of region display names to region objects subject to the filters supplied by input variables. See regions output for more details.
Description: A map of geographies to a list of region objects subject to the filters supplied by input variables. See regions output for more details.
Description: A map of geography groups to a list of region objects subject to the filters supplied by input variables. See regions output for more details.
Description: A map of region display names to region objects subject to the filters supplied by input variables. See regions output for more details.
Description: A map of regions by either display names or name, to region objects subject to the filters supplied by input variables. See regions output for more details.
Description: A set of valid region display names subject to the filters supplied by input variables.
Description: A set of valid region names subject to the filters supplied by input variables.
Description: A set of valid region names or display names subject to the filters supplied by input variables.
No modules.
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.