Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azure/terraform-azurerm-regions
Terraform module that provides data about Azure regions, including availability zones! Data is sourced from Azure APIs.
https://github.com/azure/terraform-azurerm-regions
azapi-modules azure terraform-azure terraform-azurerm terraform-module
Last synced: 3 months ago
JSON representation
Terraform module that provides data about Azure regions, including availability zones! Data is sourced from Azure APIs.
- Host: GitHub
- URL: https://github.com/azure/terraform-azurerm-regions
- Owner: Azure
- License: mit
- Created: 2023-10-11T23:57:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-01T16:46:25.000Z (6 months ago)
- Last Synced: 2024-10-07T12:39:43.753Z (3 months ago)
- Topics: azapi-modules, azure, terraform-azure, terraform-azurerm, terraform-module
- Language: HCL
- Homepage: https://registry.terraform.io/modules/Azure/regions/azurerm
- Size: 71.3 KB
- Stars: 8
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Azure Regions and Availability Zones module
> [!WARNING]
> This module has been ported to Azure Verified Modules and will be archived in the near future.
>
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 be `null` if 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 `null` if the region does not support zones.
This data is the further composed into useful maps keyed by region name and region display name.
## Usage
```hcl
module "regions" {
source = "Azure/regions/azurerm"
version = "" # change this to your desired version, https://www.terraform.io/language/expressions/version-constraints
}
output "regions" {
value = module.regions.regions
}
```
## Credits
Belatedly adding this, waaaay overdue...
This module was created after a cool chat with [@markti](https://github.com/markti) whilst we were at Hashiconf 2023.
Thanks Mark!
## Requirements
The following requirements are needed by this module:
- [terraform](#requirement\_terraform) (~> 1.6)
- [terraform](#requirement\_terraform) (~> 1.6)
- [azapi](#requirement\_azapi) (>= 1.9.0)
- [azapi](#requirement\_azapi) (~> 1.13, != 1.13.0)
- [azurerm](#requirement\_azurerm) (>= 3.74.0)
- [azurerm](#requirement\_azurerm) (~> 3.74)
- [local](#requirement\_local) (>= 2.4.0)
- [local](#requirement\_local) (~> 2.4)
## Providers
The following providers are used by this module:
- [azapi](#provider\_azapi) (>= 1.9.0 ~> 1.13, != 1.13.0)
- [azurerm](#provider\_azurerm) (>= 3.74.0 ~> 3.74)
## Resources
The following resources are used by this module:
- [azapi_resource_action.compute_provider](https://registry.terraform.io/providers/azure/azapi/latest/docs/data-sources/resource_action) (data source)
- [azapi_resource_action.locations](https://registry.terraform.io/providers/azure/azapi/latest/docs/data-sources/resource_action) (data source)
- [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) (data source)
## Required Inputs
No required inputs.
## Optional Inputs
The following input variables are optional (have default values):
### [recommended\_regions\_only](#input\_recommended\_regions\_only)
Description: If true, the module will only return regions that are have the category set to `Recommended` by the locations API.
Type: `bool`
Default: `true`
### [use\_cached\_data](#input\_use\_cached\_data)
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`
## Outputs
The following outputs are exported:
### [regions](#output\_regions)
Description: A list of region objects. 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 be `null` if 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.
### [regions\_by\_display\_name](#output\_regions\_by\_display\_name)
Description: A map of region display names to region objects. See `regions` output for more details.
### [regions\_by\_geography](#output\_regions\_by\_geography)
Description: A map of geographies to a list of region objects. See `regions` output for more details.
### [regions\_by\_geography\_group](#output\_regions\_by\_geography\_group)
Description: A map of geography groups to a list of region objects. See `regions` output for more details.
### [regions\_by\_name](#output\_regions\_by\_name)
Description: A map of region display names to region objects. See `regions` output for more details.
### [regions\_by\_name\_or\_display\_name](#output\_regions\_by\_name\_or\_display\_name)
Description: A map of regions by either display names or name, to region objects. See `regions` output for more details.
## Modules
No modules.