azurermConsumptionBudgetManagementGroup
Manages a Consumption Budget for a Management Group.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermManagementGroupExample =
new azurerm.managementGroup.ManagementGroup(this, "example", {
display_name: "example",
});
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example_1",
{
location: "eastus",
name: "example",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermResourceGroupExample.overrideLogicalId("example");
const azurermConsumptionBudgetManagementGroupExample =
new azurerm.consumptionBudgetManagementGroup.ConsumptionBudgetManagementGroup(
this,
"example_2",
{
amount: 1000,
filter: [
{
dimension: [
{
name: "ResourceGroupName",
values: [azurermResourceGroupExample.name],
},
],
tag: [
{
name: "foo",
values: ["bar", "baz"],
},
],
},
],
management_group_id: azurermManagementGroupExample.id,
name: "example",
notification: [
{
contact_emails: ["foo@example.com", "bar@example.com"],
enabled: true,
operator: "EqualTo",
threshold: 90,
},
{
contact_emails: ["foo@example.com", "bar@example.com"],
enabled: false,
operator: "GreaterThan",
threshold: 100,
threshold_type: "Forecasted",
},
],
time_grain: "Monthly",
time_period: [
{
end_date: "2022-07-01T00:00:00Z",
start_date: "2022-06-01T00:00:00Z",
},
],
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermConsumptionBudgetManagementGroupExample.overrideLogicalId("example");
Arguments Reference
The following arguments are supported:
-
name
- (Required) The name which should be used for this Management Group Consumption Budget. Changing this forces a new resource to be created. -
managementGroupId
- (Required) The ID of the Management Group. Changing this forces a new resource to be created. -
amount
- (Required) The total amount of cost to track with the budget. -
timeGrain
- (Optional) The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one ofbillingAnnual
,billingMonth
,billingQuarter
,annually
,monthly
andquarterly
. Defaults tomonthly
. Changing this forces a new resource to be created. -
timePeriod
- (Required) AtimePeriod
block as defined below. -
notification
- (Required) One or morenotification
blocks as defined below. -
filter
- (Optional) Afilter
block as defined below.
A filter
block supports the following:
-
dimension
- (Optional) One or moredimension
blocks as defined below to filter the budget on. -
tag
- (Optional) One or moretag
blocks as defined below to filter the budget on. -
not
- (Optional) Anot
block as defined below to filter the budget on. This is deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.
A not
block supports the following:
-
dimension
- (Optional) Onedimension
block as defined below to filter the budget on. Conflicts withtag
. -
tag
- (Optional) Onetag
block as defined below to filter the budget on. Conflicts withdimension
.
A notification
block supports the following:
-
operator
- (Required) The comparison operator for the notification. Must be one ofequalTo
,greaterThan
, orgreaterThanOrEqualTo
. -
threshold
- (Required) 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. -
contactEmails
- (Required) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded. -
thresholdType
- (Optional) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values areactual
andforecasted
. Default isactual
. Changing this forces a new resource to be created. -
enabled
- (Optional) Should the notification be enabled? Defaults totrue
.
A dimension
block supports the following:
-
name
- (Required) The name of the column to use for the filter. The allowed values arechargeType
,frequency
,invoiceId
,meter
,meterCategory
,meterSubCategory
,partNumber
,pricingModel
,product
,productOrderId
,productOrderName
,publisherType
,reservationId
,reservationName
,resourceGroupName
,resourceGuid
,resourceId
,resourceLocation
,resourceType
,serviceFamily
,serviceName
,subscriptionId
,subscriptionName
,unitOfMeasure
. -
operator
- (Optional) The operator to use for comparison. The allowed values arein
. -
values
- (Required) Specifies a list of values for the column.
A tag
block supports the following:
-
name
- (Required) The name of the tag to use for the filter. -
operator
- (Optional) The operator to use for comparison. The allowed values arein
. -
values
- (Required) Specifies a list of values for the tag.
A timePeriod
block supports the following:
-
startDate
- (Required) The start date for the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. Changing this forces a new resource to be created. -
endDate
- (Optional) The end date for the budget. If not set this will be 10 years after the start date.
Attributes Reference
In addition to the Arguments listed above - the following Attributes are exported:
-
id
- The ID of the Management Group Consumption Budget. -
etag
- (Optional) The ETag of the Management Group Consumption Budget.
Timeouts
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the Management Group Consumption Budget.read
- (Defaults to 5 minutes) Used when retrieving the Management Group Consumption Budget.update
- (Defaults to 30 minutes) Used when updating the Management Group Consumption Budget.delete
- (Defaults to 30 minutes) Used when deleting the Management Group Consumption Budget.
Import
Management Group Consumption Budgets can be imported using the resourceId
, e.g.