You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
modules/azure-region/README.md

62 lines
1.2 KiB
Markdown

---
display_name: Azure Region
description: A parameter with human region names and icons
icon: ../.icons/azure.svg
maintainer_github: coder
verified: true
tags: [helper, parameter, azure]
---
# Azure Region
This module adds a parameter with all Azure regions, allowing developers to select the region closest to them.
## Examples
### Default region
```hcl
module "azure_region" {
source = "https://registry.coder.com/modules/azure-region"
default = "eastus"
}
resource "azurem_resource_group" "example" {
location = module.azure_region.value
}
```
### Customize existing regions
Change the display name for a region:
```hcl
module "azure-region" {
source = "https://registry.coder.com/modules/azure-region"
custom_names = {
"eastus": "Eastern United States!"
}
custom_icons = {
"eastus": "/icons/smiley.svg"
}
}
resource "azurerm_resource_group" "example" {
location = module.azure_region.value
}
```
### Exclude Regions
Hide the `westus2` region:
```hcl
module "azure-region" {
source = "https://registry.coder.com/modules/azure-region"
exclude = [ "westus2" ]
}
resource "azurerm_resource_group" "example" {
location = module.azure_region.value
}
```