https://github.com/Azure-Terraform/terraform-azurerm-metadata
Terraform Metadata Module
https://github.com/Azure-Terraform/terraform-azurerm-metadata
Last synced: 5 months ago
JSON representation
Terraform Metadata Module
- Host: GitHub
- URL: https://github.com/Azure-Terraform/terraform-azurerm-metadata
- Owner: Azure-Terraform
- License: mit
- Created: 2020-05-13T09:53:24.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-04-15T15:13:11.000Z (almost 3 years ago)
- Last Synced: 2024-08-03T22:19:29.730Z (8 months ago)
- Language: HCL
- Homepage:
- Size: 41 KB
- Stars: 3
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - Azure-Terraform/terraform-azurerm-metadata - Terraform Metadata Module (HCL)
README
# Azure - Metadata Module
## Introduction
This module will return a map of mandatory tag for resources in Azure.
It is recommended that you always use this module to generate tags as it will prevent code duplication. We also reccommend leveraging this data as "metadata" to determine core details about resources in other modules.
- For example the location output can be referenced when creating a virtual machine. If you want to change regions at a later date you only need to update one place.
Where applicable, the inputs will be checked against the input naming rules for Azure.
- https://github.com/Azure-Terraform/example-naming-template/
## Providers
| Name | Version |
|------|---------|
| azurerm | >= 2.0.0 |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:-----:|
| additional\_tags | A map of additional tags to add to the tags output | `map(string)` | `{}` | no |
| business\_unit | rba.businessUnit (https://github.com/Azure-Terraform/example-naming-template#custombusinessunit) | `string` | n/a | yes |
| environment | rba.environment (https://github.com/Azure-Terraform/example-naming-template#customenvironment) | `string` | n/a | yes |
| location | rba.azureRegion (https://github.com/Azure-Terraform/example-naming-template#customazureregion) | `string` | n/a | yes |
| market | rba.market (https://github.com/Azure-Terraform/example-naming-template#custommarket) | `string` | n/a | yes |
| naming\_rules | naming conventions yaml file | `string` | n/a | yes |
| on\_prem | rba.onPrem (https://github.com/Azure-Terraform/example-naming-template#customonprem) | `string` | `""` | no |
| product\_group | rba.productGroup (https://github.com/Azure-Terraform/example-naming-template#customproductgroup) or [a-z0-9]{2,12} | `string` | `""` | no |
| product\_name | rba.productName (https://github.com/Azure-Terraform/example-naming-template#customproductname) | `string` | `""` | no |
| project | Jira Project | `string` | n/a | yes |
| resource\_group\_type | rba.resourceGroupType (https://github.com/Azure-Terraform/example-naming-template#customresourcegrouptype) | `string` | n/a | yes |
| service\_name | rba.serviceName (https://github.com/Azure-Terraform/example-naming-template#customservicename) | `string` | `""` | no |
| sre\_team | SRE Team owner | `string` | `""` | no |
| subnet\_type | rba.subnetType (https://github.com/Azure-Terraform/example-naming-template#customsubnettype) | `string` | `""` | no |
| subscription\_id | Azure Subscription ID | `string` | n/a | yes |
| subscription\_type | rba.subscriptionType (https://github.com/Azure-Terraform/example-naming-template#customsubscriptiontype) | `string` | n/a | yes |
| virtual\_network\_gateway\_type | virtualNetGwType (https://github.com/Azure-Terraform/example-naming-template#customvirtualnetgwtype) | `string` | `""` | no |
## Outputs
| Name | Description |
|------|-------------|
| location | Azure region |
| location\_pair | Azure paired region |
| names | Map of validated names for resources |
| tags | Map of tags with any global defaults appended |