az consumption budget
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage budgets for an Azure subscription.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az consumption budget create |
Create a budget for an Azure subscription. |
Core | Preview |
| az consumption budget create-with-rg |
Create operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag. |
Core | Preview |
| az consumption budget delete |
Delete a budget for an Azure subscription. |
Core | Preview |
| az consumption budget delete-with-rg |
Delete operation to delete a budget. |
Core | Preview |
| az consumption budget list |
List budgets for an Azure subscription. |
Core | Preview |
| az consumption budget show |
Show budget for an Azure subscription. |
Core | Preview |
| az consumption budget show-with-rg |
Get the budget for a resource group under a subscription by budget name. |
Core | Preview |
| az consumption budget update |
Update operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag. |
Core | Preview |
| az consumption budget update-with-rg |
Update operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag. |
Core | Preview |
az consumption budget create
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a budget for an Azure subscription.
az consumption budget create --amount
--budget-name
--category {cost, usage}
--end-date
--start-date
--time-grain {annually, monthly, quarterly}
[--meter-filter]
[--resource-filter]
[--resource-group]
[--resource-group-filter]Required Parameters
Amount of a budget.
Name of a budget.
Category of the budget can be cost or usage.
End date (YYYY-MM-DD in UTC) of time period of a budget.
Start date (YYYY-MM-DD in UTC) of time period of a budget.
Time grain of the budget can be monthly, quarterly, or annually.
Optional Parameters
Space-separated list of meters to filter on. Required if category is usage.
Space-separated list of resource instances to filter on.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Space-separated list of resource groups to filter on.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az consumption budget create-with-rg
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
az consumption budget create-with-rg [--amount]
[--budget-name]
[--category {Cost, Usage}]
[--e-tag]
[--filters]
[--ids]
[--notifications]
[--resource-group]
[--subscription]
[--time-grain {Annually, Monthly, Quarterly}]
[--time-period]Optional Parameters
The total amount of cost to track with the budget.
Budget Name.
The category of the budget, whether the budget tracks cost or usage.
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.
May be used to filter budgets by resource group, resource, or meter. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Dictionary of notifications associated with the budget. Budget can have up to five notifications. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The time covered by a budget. Tracking of the amount will be reset based on the time grain.
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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az consumption budget delete
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a budget for an Azure subscription.
az consumption budget delete --budget-name
[--resource-group]Examples
Delete a budget for an Azure subscription. (autogenerated)
az consumption budget delete --budget-name MyBudgetRequired Parameters
Name of a budget.
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az consumption budget delete-with-rg
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete operation to delete a budget.
az consumption budget delete-with-rg [--budget-name]
[--ids]
[--resource-group]
[--subscription]Optional Parameters
Budget Name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az consumption budget list
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List budgets for an Azure subscription.
az consumption budget list [--max-items]
[--next-token]
[--resource-group]Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az consumption budget show
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show budget for an Azure subscription.
az consumption budget show --budget-name
[--resource-group]Examples
Show budget for an Azure subscription. (autogenerated)
az consumption budget show --budget-name MyBudgetRequired Parameters
Name of a budget.
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az consumption budget show-with-rg
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the budget for a resource group under a subscription by budget name.
az consumption budget show-with-rg [--budget-name]
[--ids]
[--resource-group]
[--subscription]Optional Parameters
Budget Name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az consumption budget update
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
az consumption budget update [--add]
[--amount]
[--budget-name]
[--category {Cost, Usage}]
[--e-tag]
[--filters]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--notifications]
[--remove]
[--set]
[--subscription]
[--time-grain {Annually, Monthly, Quarterly}]
[--time-period]Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
The total amount of cost to track with the budget.
Budget Name.
The category of the budget, whether the budget tracks cost or usage.
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.
May be used to filter budgets by resource group, resource, or meter. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Dictionary of notifications associated with the budget. Budget can have up to five notifications. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The time covered by a budget. Tracking of the amount will be reset based on the time grain.
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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az consumption budget update-with-rg
Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
az consumption budget update-with-rg [--amount]
[--budget-name]
[--category {Cost, Usage}]
[--e-tag]
[--filters]
[--ids]
[--notifications]
[--resource-group]
[--subscription]
[--time-grain {Annually, Monthly, Quarterly}]
[--time-period]Optional Parameters
The total amount of cost to track with the budget.
Budget Name.
The category of the budget, whether the budget tracks cost or usage.
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.
May be used to filter budgets by resource group, resource, or meter. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Dictionary of notifications associated with the budget. Budget can have up to five notifications. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The time covered by a budget. Tracking of the amount will be reset based on the time grain.
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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for