https://github.com/getindata/terraform-azurerm-subscription

Terraform Module for Azure Subscription
https://github.com/getindata/terraform-azurerm-subscription
Last synced: 3 months ago
JSON representation
Terraform Module for Azure Subscription
Host: GitHub
URL: https://github.com/getindata/terraform-azurerm-subscription
Owner: getindata
License: apache-2.0
Created: 2022-08-30T06:58:43.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-12-11T22:16:15.000Z (over 2 years ago)
Last Synced: 2025-06-07T22:04:51.849Z (about 1 year ago)
Language: HCL
Size: 36.1 KB
Stars: 1
Watchers: 7
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

          # Azure Subscription Terraform Module

![Azure](https://img.shields.io/badge/azure-%230072C6.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)

![Terraform](https://img.shields.io/badge/terraform-%235835CC.svg?style=for-the-badge&logo=terraform&logoColor=white)

![License](https://badgen.net/github/license/getindata/terraform-azurerm-subscription/)

![Release](https://badgen.net/github/release/getindata/terraform-azurerm-subscription/)



  

  
We help companies turn their data into assets


---

This module manages Azure Subscription.

## USAGE

```hcl

module "test_subscription" {

  source  = "github.com/getindata/terraform-azurerm-subscription"

  name              = "Test Subscription"

  subscription_id   = "00000000-0000-0000-0000-000000000000"

}

```

## Consumption Budget

You can create a consumption budget for the subscription and setup notifications based on various thresholds.

```hcl

consumption_budgets = {

  default = {

    amount = 100

    time_period = {

      start_date = "2022-07-01T00:00:00Z"

    }

    notifications = {

      forecastedGreaterThan100 = {

        contact_emails = ["notify@example.com"]

        operator       = "GreaterThan"

        threshold      = 100

        threshold_type = "Forecasted"

      }

    }

  }

}

```

> This module supports only e-mail addresses for notification.

## Examples

- [Basic Subscription management](examples/basic)

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |

|  [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the `delimiter`
and treated as a single ID element. | `list(string)` | `[]` | no |

|  [billing\_enrollment\_account\_scope](#input\_billing\_enrollment\_account\_scope) | Enterprise Account details. The Billing Account Name and the Enrollment Account Name. | 
object({
    billing_account_name : string
    enrollment_account_name : string
  }) | `null` | no |

|  [consumption\_budgets](#input\_consumption\_budgets) | Consumption budget resources associated with this resource group, it should be a map of values:
`{
  amount = number
  time_period = object
  notifications = map

  #optional
  time_grain = string
}`
`time_period` is an object of `start_date` (which is required) and `end_date` (which is optional).
`time_grain` must be one of Monthly, Quarterly, Annually, BillingMonth, BillingQuarter, or BillingYear. Defaults to Monthly
`notifications` is a map of values:
`{
  #optional
  contact_emails = list(string)
  operator = string
  threshold = string
  threshold_type = string
}`
`contact_emails` is a list of email addresses to send the budget notification to when the threshold is exceeded
`operator` - the comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo. Defaults to `EqualTo`
`threshold` - threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000. Defaults to 90.
`threshold_type` - the type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual.

For more information, please visit: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/consumption_budget_resource_group | `map(any)` | `{}` | no |

|  [context](#input\_context) | Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as `null` to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | {
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
} | no |

|  [default\_consumption\_budget\_notification\_emails](#input\_default\_consumption\_budget\_notification\_emails) | List of e-mail addresses that will be used for notifications if they were not provided explicitly | `list(string)` | `[]` | no |

|  [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |

|  [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
`{
   format = string
   labels = list(string)
}`
(Type is `any` so the map values can later be enhanced to provide additional options.)
`format` is a Terraform format string to be passed to the `format()` function.
`labels` is a list of labels, in order, to pass to `format()` function.
Label values will be normalized before being passed to `format()` so they will be
identical to how they appear in `id`.
Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |

|  [diagnostics\_categories\_flag\_map](#input\_diagnostics\_categories\_flag\_map) | Map of Diagnostic categories. By default all of them are enabled. Ti disable particular category, add an entry with a `false` value | `map(bool)` | `{}` | no |

|  [diagnostics\_log\_analytics\_workspace\_id](#input\_diagnostics\_log\_analytics\_workspace\_id) | Resource ID of the log analytics workspace. Used for diagnostics logs and metrics | `string` | `null` | no |

|  [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |

|  [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |

|  [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).
Set to `0` for unlimited length.
Set to `null` for keep the existing setting, which defaults to `0`.
Does not affect `id_full`. | `number` | `null` | no |

|  [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper`.
Default value: `title`. | `string` | `null` | no |

|  [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no |

|  [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the `tags` input.
Possible values: `lower`, `title`, `upper` and `none` (no transformation).
Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.
Default value: `lower`. | `string` | `null` | no |

|  [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.
Default is to include all labels.
Tags with empty values will not be included in the `tags` output.
Set to `[]` to suppress all generated tags.
**Notes:**
  The value of the `name` tag, if included, will be the `id`, not the `name`.
  Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be
  changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | [
  "default"
] | no |

|  [management\_group\_id](#input\_management\_group\_id) | ID of the Management Group where subscription will be created | `string` | `null` | no |

|  [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a `tag`.
The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |

|  [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no |

|  [refresh\_token](#input\_refresh\_token) | Indicates wherever the refresh token of service principal should be refreshed after the subscription is created. | `bool` | `true` | no |

|  [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |

|  [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |

|  [subscription\_id](#input\_subscription\_id) | If Provided, subscription will not be created but managed via Alias | `string` | `null` | no |

|  [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |

|  [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |

## Modules

| Name | Source | Version |

|------|--------|---------|

|  [this](#module\_this) | cloudposse/label/null | 0.25.0 |

## Outputs

| Name | Description |

|------|-------------|

|  [alias\_id](#output\_alias\_id) | Alias ID of the subscription |

|  [subscription\_id](#output\_subscription\_id) | ID of the subscription |

|  [subscription\_id\_after\_refreshed\_access\_token](#output\_subscription\_id\_after\_refreshed\_access\_token) | Subscription ID, which can be used after the running service principal refreshed its access token |

|  [subscription\_name](#output\_subscription\_name) | Name of the subscription |

|  [subscription\_resource\_id](#output\_subscription\_resource\_id) | Resource ID of the subscription |

## Providers

| Name | Version |

|------|---------|

|  [azurerm](#provider\_azurerm) | >= 3.0 |

|  [null](#provider\_null) | >= 3.0 |

|  [time](#provider\_time) | 0.8.0 |

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1.3.0 |

|  [azurerm](#requirement\_azurerm) | >= 3.0 |

|  [null](#requirement\_null) | >= 3.0 |

|  [time](#requirement\_time) | 0.8.0 |

## Resources

| Name | Type |

|------|------|

| [azurerm_consumption_budget_subscription.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/consumption_budget_subscription) | resource |

| [azurerm_management_group_subscription_association.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/management_group_subscription_association) | resource |

| [azurerm_monitor_diagnostic_setting.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/monitor_diagnostic_setting) | resource |

| [azurerm_subscription.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subscription) | resource |

| [null_resource.refresh_access_token](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |

| [time_static.consumption_budget_start_date](https://registry.terraform.io/providers/hashicorp/time/0.8.0/docs/resources/static) | resource |

| [azurerm_billing_enrollment_account_scope.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/billing_enrollment_account_scope) | data source |

## CONTRIBUTING

Contributions are very welcomed!

Start by reviewing [contribution guide](CONTRIBUTING.md) and our [code of conduct](CODE_OF_CONDUCT.md). After that, start coding and ship your changes by creating a new PR.

## LICENSE

Apache 2 Licensed. See [LICENSE](LICENSE) for full details.

## AUTHORS



  



Made with [contrib.rocks](https://contrib.rocks).
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/getindata/terraform-azurerm-subscription

Awesome Lists containing this project

README

We help companies turn their data into assets
