feat(subscription): add subscription budgets.

[nyanhp]

Overview/summary

This PR adds the ability to define cost management budgets for a subscription, excluding filters.

This PR fixes/adds/changes/removes

1. fixes feat: budget support #64

Breaking changes

None

Testing evidence

I am not familiar enough with Go to have added tests. I tested instead in my environment.

# module.lz_vending["subname"].module.subscription[0].azapi_resource.subscription_budget["budget1"] will be created
  + resource "azapi_resource" "subscription_budget" {
      + body                      = jsonencode(
            {
              + properties = {
                  + amount        = 150
                  + category      = "Cost"
                  + notifications = {
                      + eightypercent = {
                          + contactEmails = [
                              + "[email protected]",
                            ]
                          + contactGroups = []
                          + contactRoles  = []
                          + enabled       = true
                          + locale        = "en-us"
                          + operator      = "GreaterThan"
                          + threshold     = 80
                          + thresholdType = "Actual"
                        }
                      + forecast      = {
                          + contactEmails = [
                              + "[email protected]",
                            ]
                          + contactGroups = []
                          + contactRoles  = []
                          + enabled       = true
                          + locale        = "en-us"
                          + operator      = "GreaterThanOrEqualTo"
                          + threshold     = 290
                          + thresholdType = "Forecasted"
                        }
                      + ninetypercent = {
                          + contactEmails = [
                              + "[email protected]",
                            ]
                          + contactGroups = []
                          + contactRoles  = []
                          + enabled       = true
                          + locale        = "en-us"
                          + operator      = "GreaterThanOrEqualTo"
                          + threshold     = 90
                          + thresholdType = "Actual"
                        }
                    }
                  + timeGrain     = "Monthly"
                  + timePeriod    = {
                      + endDate   = "2027-12-31T23:59:59Z"
                      + startDate = "2024-05-01T00:00:00Z"
                    }
                }
            }
        )
      + id                        = (known after apply)
      + ignore_casing             = false
      + ignore_missing_property   = true
      + location                  = (known after apply)
      + name                      = "budget1"
      + output                    = (known after apply)
      + parent_id                 = "/subscriptions/nope"
      + removing_special_chars    = false
      + schema_validation_enabled = true
      + tags                      = (known after apply)
      + type                      = "Microsoft.Consumption/budgets@2021-10-01"
    }

  # module.lz_vending["subname"].module.subscription[0].azapi_resource.subscription_budget["budget2"] will be created
  + resource "azapi_resource" "subscription_budget" {
      + body                      = jsonencode(
            {
              + properties = {
                  + amount        = 1500
                  + category      = "Cost"
                  + notifications = {
                      + eightypercent = {
                          + contactEmails = [
                              + "[email protected]",
                            ]
                          + contactGroups = []
                          + contactRoles  = []
                          + enabled       = true
                          + locale        = "en-us"
                          + operator      = "GreaterThan"
                          + threshold     = 80
                          + thresholdType = "Actual"
                        }
                      + forecast      = {
                          + contactEmails = [
                              + "[email protected]",
                            ]
                          + contactGroups = []
                          + contactRoles  = []
                          + enabled       = true
                          + locale        = "en-us"
                          + operator      = "GreaterThanOrEqualTo"
                          + threshold     = 290
                          + thresholdType = "Forecasted"
                        }
                      + ninetypercent = {
                          + contactEmails = [
                              + "[email protected]",
                            ]
                          + contactGroups = []
                          + contactRoles  = []
                          + enabled       = true
                          + locale        = "en-us"
                          + operator      = "GreaterThanOrEqualTo"
                          + threshold     = 90
                          + thresholdType = "Actual"
                        }
                    }
                  + timeGrain     = "Annually"
                  + timePeriod    = {
                      + endDate   = "2027-12-31T23:59:59Z"
                      + startDate = "2024-05-01T00:00:00Z"
                    }
                }
            }
        )
      + id                        = (known after apply)
      + ignore_casing             = false
      + ignore_missing_property   = true
      + location                  = (known after apply)
      + name                      = "budget2"
      + output                    = (known after apply)
      + parent_id                 = "/subscriptions/nope"
      + removing_special_chars    = false
      + schema_validation_enabled = true
      + tags                      = (known after apply)
      + type                      = "Microsoft.Consumption/budgets@2021-10-01"
    }

Apply was successfully completed, e.g.:

As part of this pull request I have

• Checked for duplicate Pull Requests
• Associated it with relevant issues, for tracking and closure.
• Run and make fmt & make docs to format your code and update documentation.
• Created unit and deployment tests and provided evidence.
• Updated relevant and associated documentation.

[kewalaka]

Question for the team - does it make sense to have this interface "look" like azurerm - e.g. the input name would be camel-cased, like "threshold_type", and the ones below like "contact_emails" etc.

My thoughts are if we do switch out the implementation for an AzureRM version, the interface will remain the same.

[jaredfholgate]

Agreed, the inputs for all terraform modules should be snake case.

[nyanhp]

This will add unnecessary work (in my opinion) and requires re-assembling all notifications just to bring them into the correct format for the azapi body

[kewalaka]

I don't consider it unnecessary, it is something that needs to be once in the module to support creating a more consistent interface should the implementation change. It doesnt put burden on the module consumers.

It is similar to what has been done for container app managed envs, for example

https://github.com/Azure/terraform-azurerm-avm-res-app-managedenvironment/blob/main/main.tf

[nyanhp]

added local to transform the notification map.

[jaredfholgate]

Thank you very much for submitting this PR. I appreciate this ask is extra work, but the consistency of naming conventions will be beneficial in the longer term. Thanks

[jaredfholgate]

The code looks really good, just think we can improve the user experience a bit.

[matt-FFFFFF]

LGTM - one comment!