Microsoft.Consumption budgets 2018-10-01

Article
12/09/2024

Bicep resource definition

The budgets resource type can be deployed with operations that target:

Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Consumption/budgets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Consumption/budgets@2018-10-01' = {
  eTag: 'string'
  name: 'string'
  properties: {
    amount: int
    category: 'string'
    filters: {
      meters: [
        'string'
      ]
      resourceGroups: [
        'string'
      ]
      resources: [
        'string'
      ]
      tags: {
        {customized property}: [
          'string'
        ]
      }
    }
    notifications: {
      {customized property}: {
        contactEmails: [
          'string'
        ]
        contactGroups: [
          'string'
        ]
        contactRoles: [
          'string'
        ]
        enabled: bool
        operator: 'string'
        threshold: int
      }
    }
    timeGrain: 'string'
    timePeriod: {
      endDate: 'string'
      startDate: 'string'
    }
  }
}

Property values

BudgetProperties

Name	Description	Value
amount	The total amount of cost to track with the budget	int (required)
category	The category of the budget, whether the budget tracks cost or usage.	'Cost' 'Usage' (required)
filters	May be used to filter budgets by resource group, resource, or meter.	Filters
notifications	Dictionary of notifications associated with the budget. Budget can have up to five notifications.	BudgetPropertiesNotifications
timeGrain	The time covered by a budget. Tracking of the amount will be reset based on the time grain.	'Annually' 'Monthly' 'Quarterly' (required)
timePeriod	Has start and end date of 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 three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.	BudgetTimePeriod (required)

BudgetPropertiesNotifications

Name	Description	Value

BudgetTimePeriod

Name	Description	Value
endDate	The end date for the budget. If not provided, we default this to 10 years from the start date.	string
startDate	The start date for the budget.	string (required)

Filters

Name	Description	Value
meters	The list of filters on meters (GUID), mandatory for budgets of usage category.	string Constraints: Min length = 36 Max length = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`[]
resourceGroups	The list of filters on resource groups, allowed at subscription level only.	string[]
resources	The list of filters on resources.	string[]
tags	The dictionary of filters on tags.	FiltersTags

FiltersTags

Name	Description	Value

Microsoft.Consumption/budgets

Name	Description	Value
eTag	eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.	string
name	The resource name	string (required)
properties	The properties of the budget.	BudgetProperties

Notification

Name	Description	Value
contactEmails	Email addresses to send the budget notification to when the threshold is exceeded.	string[] (required)
contactGroups	Action groups to send the budget notification to when the threshold is exceeded.	string[]
contactRoles	Contact roles to send the budget notification to when the threshold is exceeded.	string[]
enabled	The notification is enabled or not.	bool (required)
operator	The comparison operator.	'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (required)
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.	int (required)

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create a Budget	This template shows how to create a budget under a subscription.
Create a Budget with Filter	This template shows how to create a budget under a subscription.
Create a Simple Budget	This template shows how to create a budget under a subscription.

ARM template resource definition

The budgets resource type can be deployed with operations that target:

Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Consumption/budgets resource, add the following JSON to your template.

{
  "type": "Microsoft.Consumption/budgets",
  "apiVersion": "2018-10-01",
  "name": "string",
  "eTag": "string",
  "properties": {
    "amount": "int",
    "category": "string",
    "filters": {
      "meters": [ "string" ],
      "resourceGroups": [ "string" ],
      "resources": [ "string" ],
      "tags": {
        "{customized property}": [ "string" ]
      }
    },
    "notifications": {
      "{customized property}": {
        "contactEmails": [ "string" ],
        "contactGroups": [ "string" ],
        "contactRoles": [ "string" ],
        "enabled": "bool",
        "operator": "string",
        "threshold": "int"
      }
    },
    "timeGrain": "string",
    "timePeriod": {
      "endDate": "string",
      "startDate": "string"
    }
  }
}

Property values

BudgetProperties

Name	Description	Value
amount	The total amount of cost to track with the budget	int (required)
category	The category of the budget, whether the budget tracks cost or usage.	'Cost' 'Usage' (required)
filters	May be used to filter budgets by resource group, resource, or meter.	Filters
notifications	Dictionary of notifications associated with the budget. Budget can have up to five notifications.	BudgetPropertiesNotifications
timeGrain	The time covered by a budget. Tracking of the amount will be reset based on the time grain.	'Annually' 'Monthly' 'Quarterly' (required)
timePeriod	Has start and end date of 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 three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.	BudgetTimePeriod (required)

BudgetPropertiesNotifications

Name	Description	Value

BudgetTimePeriod

Name	Description	Value
endDate	The end date for the budget. If not provided, we default this to 10 years from the start date.	string
startDate	The start date for the budget.	string (required)

Filters

Name	Description	Value
meters	The list of filters on meters (GUID), mandatory for budgets of usage category.	string Constraints: Min length = 36 Max length = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`[]
resourceGroups	The list of filters on resource groups, allowed at subscription level only.	string[]
resources	The list of filters on resources.	string[]
tags	The dictionary of filters on tags.	FiltersTags

FiltersTags

Name	Description	Value

Microsoft.Consumption/budgets

Name	Description	Value
apiVersion	The api version	'2018-10-01'
eTag	eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.	string
name	The resource name	string (required)
properties	The properties of the budget.	BudgetProperties
type	The resource type	'Microsoft.Consumption/budgets'

Notification

Name	Description	Value
contactEmails	Email addresses to send the budget notification to when the threshold is exceeded.	string[] (required)
contactGroups	Action groups to send the budget notification to when the threshold is exceeded.	string[]
contactRoles	Contact roles to send the budget notification to when the threshold is exceeded.	string[]
enabled	The notification is enabled or not.	bool (required)
operator	The comparison operator.	'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (required)
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.	int (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Budget	This template shows how to create a budget under a subscription.
Create a Budget with Filter	This template shows how to create a budget under a subscription.
Create a Simple Budget	This template shows how to create a budget under a subscription.

Terraform (AzAPI provider) resource definition

The budgets resource type can be deployed with operations that target:

Subscription* Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Consumption/budgets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Consumption/budgets@2018-10-01"
  name = "string"
  eTag = "string"
  body = jsonencode({
    properties = {
      amount = int
      category = "string"
      filters = {
        meters = [
          "string"
        ]
        resourceGroups = [
          "string"
        ]
        resources = [
          "string"
        ]
        tags = {
          {customized property} = [
            "string"
          ]
        }
      }
      notifications = {
        {customized property} = {
          contactEmails = [
            "string"
          ]
          contactGroups = [
            "string"
          ]
          contactRoles = [
            "string"
          ]
          enabled = bool
          operator = "string"
          threshold = int
        }
      }
      timeGrain = "string"
      timePeriod = {
        endDate = "string"
        startDate = "string"
      }
    }
  })
}

Property values

BudgetProperties

Name	Description	Value
amount	The total amount of cost to track with the budget	int (required)
category	The category of the budget, whether the budget tracks cost or usage.	'Cost' 'Usage' (required)
filters	May be used to filter budgets by resource group, resource, or meter.	Filters
notifications	Dictionary of notifications associated with the budget. Budget can have up to five notifications.	BudgetPropertiesNotifications
timeGrain	The time covered by a budget. Tracking of the amount will be reset based on the time grain.	'Annually' 'Monthly' 'Quarterly' (required)
timePeriod	Has start and end date of 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 three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.	BudgetTimePeriod (required)

BudgetPropertiesNotifications

Name	Description	Value

BudgetTimePeriod

Name	Description	Value
endDate	The end date for the budget. If not provided, we default this to 10 years from the start date.	string
startDate	The start date for the budget.	string (required)

Filters

Name	Description	Value
meters	The list of filters on meters (GUID), mandatory for budgets of usage category.	string Constraints: Min length = 36 Max length = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`[]
resourceGroups	The list of filters on resource groups, allowed at subscription level only.	string[]
resources	The list of filters on resources.	string[]
tags	The dictionary of filters on tags.	FiltersTags

FiltersTags

Name	Description	Value

Microsoft.Consumption/budgets

Name	Description	Value
eTag	eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.	string
name	The resource name	string (required)
properties	The properties of the budget.	BudgetProperties
type	The resource type	"Microsoft.Consumption/budgets@2018-10-01"

Notification

Name	Description	Value
contactEmails	Email addresses to send the budget notification to when the threshold is exceeded.	string[] (required)
contactGroups	Action groups to send the budget notification to when the threshold is exceeded.	string[]
contactRoles	Contact roles to send the budget notification to when the threshold is exceeded.	string[]
enabled	The notification is enabled or not.	bool (required)
operator	The comparison operator.	'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (required)
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.	int (required)

Share via

Microsoft.Consumption budgets 2018-10-01

Bicep resource definition

Resource format

Property values

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

Filters

FiltersTags

Microsoft.Consumption/budgets

Notification

Quickstart samples

ARM template resource definition

Resource format

Property values

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

Filters

FiltersTags

Microsoft.Consumption/budgets

Notification

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

Filters

FiltersTags

Microsoft.Consumption/budgets

Notification

Feedback

Additional resources