-
Notifications
You must be signed in to change notification settings - Fork 461
/
budget.yml
418 lines (418 loc) · 20.4 KB
/
budget.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
### YamlMime:AzureCLIGroup
uid: az_consumption_budget
name: az consumption budget
summary: |-
Manage budgets for an Azure subscription.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
directCommands:
- uid: az_consumption_budget_create
name: az consumption budget create
summary: |-
Create a budget for an Azure subscription.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
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]
requiredParameters:
- isRequired: true
name: --amount
summary: |-
Amount of a budget.
- isRequired: true
name: --budget-name
summary: |-
Name of a budget.
- isRequired: true
name: --category
parameterValueGroup: "cost, usage"
summary: |-
Category of the budget can be cost or usage.
- isRequired: true
name: --end-date -e
summary: |-
End date (YYYY-MM-DD in UTC) of time period of a budget.
- isRequired: true
name: --start-date -s
summary: |-
Start date (YYYY-MM-DD in UTC) of time period of a budget.
- isRequired: true
name: --time-grain
parameterValueGroup: "annually, monthly, quarterly"
summary: |-
Time grain of the budget can be monthly, quarterly, or annually.
optionalParameters:
- name: --meter-filter
summary: |-
Space-separated list of meters to filter on. Required if category is usage.
- name: --resource-filter
summary: |-
Space-separated list of resource instances to filter on.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --resource-group-filter
summary: |-
Space-separated list of resource groups to filter on.
- uid: az_consumption_budget_create-with-rg
name: az consumption budget create-with-rg
summary: |-
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.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
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]
optionalParameters:
- name: --amount
summary: |-
The total amount of cost to track with the budget.
- name: --budget-name --name -n
summary: |-
Budget Name.
- name: --category
parameterValueGroup: "Cost, Usage"
summary: |-
The category of the budget, whether the budget tracks cost or usage.
- name: --e-tag
summary: |-
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.
- name: --filters
summary: |-
May be used to filter budgets by resource group, resource, or meter. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --ids
summary: |-
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: --notifications
summary: |-
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: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --time-grain
parameterValueGroup: "Annually, Monthly, Quarterly"
summary: |-
The time covered by a budget. Tracking of the amount will be reset based on the time grain.
- name: --time-period
summary: |-
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.
- uid: az_consumption_budget_delete
name: az consumption budget delete
summary: |-
Delete a budget for an Azure subscription.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
az consumption budget delete --budget-name
[--resource-group]
examples:
- summary: |-
Delete a budget for an Azure subscription. (autogenerated)
syntax: az consumption budget delete --budget-name MyBudget
requiredParameters:
- isRequired: true
name: --budget-name
summary: |-
Name of a budget.
optionalParameters:
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_consumption_budget_delete-with-rg
name: az consumption budget delete-with-rg
summary: |-
Delete operation to delete a budget.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
az consumption budget delete-with-rg [--budget-name]
[--ids]
[--resource-group]
[--subscription]
optionalParameters:
- name: --budget-name --name -n
summary: |-
Budget Name.
- name: --ids
summary: |-
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: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_consumption_budget_list
name: az consumption budget list
summary: |-
List budgets for an Azure subscription.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
az consumption budget list [--max-items]
[--next-token]
[--resource-group]
optionalParameters:
- name: --max-items
summary: |-
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.
- name: --next-token
summary: |-
Token to specify where to start paginating. This is the token value from a previously truncated response.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_consumption_budget_show
name: az consumption budget show
summary: |-
Show budget for an Azure subscription.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
az consumption budget show --budget-name
[--resource-group]
examples:
- summary: |-
Show budget for an Azure subscription. (autogenerated)
syntax: az consumption budget show --budget-name MyBudget
requiredParameters:
- isRequired: true
name: --budget-name
summary: |-
Name of a budget.
optionalParameters:
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_consumption_budget_show-with-rg
name: az consumption budget show-with-rg
summary: |-
Get the budget for a resource group under a subscription by budget name.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
az consumption budget show-with-rg [--budget-name]
[--ids]
[--resource-group]
[--subscription]
optionalParameters:
- name: --budget-name --name -n
summary: |-
Budget Name.
- name: --ids
summary: |-
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: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_consumption_budget_update
name: az consumption budget update
summary: |-
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.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
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]
optionalParameters:
- name: --add
summary: |-
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>.
- name: --amount
summary: |-
The total amount of cost to track with the budget.
- name: --budget-name --name -n
summary: |-
Budget Name.
- name: --category
parameterValueGroup: "Cost, Usage"
summary: |-
The category of the budget, whether the budget tracks cost or usage.
- name: --e-tag
summary: |-
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.
- name: --filters
summary: |-
May be used to filter budgets by resource group, resource, or meter. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --force-string
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
- name: --ids
summary: |-
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: --notifications
summary: |-
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: --remove
summary: |-
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
- name: --set
summary: |-
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --time-grain
parameterValueGroup: "Annually, Monthly, Quarterly"
summary: |-
The time covered by a budget. Tracking of the amount will be reset based on the time grain.
- name: --time-period
summary: |-
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.
- uid: az_consumption_budget_update-with-rg
name: az consumption budget update-with-rg
summary: |-
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.
status: Preview
isPreview: true
previewOrExperimentalInfo: "Command group 'consumption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/consumption/_help.py
syntax: >-
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]
optionalParameters:
- name: --amount
summary: |-
The total amount of cost to track with the budget.
- name: --budget-name --name -n
summary: |-
Budget Name.
- name: --category
parameterValueGroup: "Cost, Usage"
summary: |-
The category of the budget, whether the budget tracks cost or usage.
- name: --e-tag
summary: |-
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.
- name: --filters
summary: |-
May be used to filter budgets by resource group, resource, or meter. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --ids
summary: |-
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: --notifications
summary: |-
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: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --time-grain
parameterValueGroup: "Annually, Monthly, Quarterly"
summary: |-
The time covered by a budget. Tracking of the amount will be reset based on the time grain.
- name: --time-period
summary: |-
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.
commands:
- az_consumption_budget_create
- az_consumption_budget_create-with-rg
- az_consumption_budget_delete
- az_consumption_budget_delete-with-rg
- az_consumption_budget_list
- az_consumption_budget_show
- az_consumption_budget_show-with-rg
- az_consumption_budget_update
- az_consumption_budget_update-with-rg
globalParameters:
- name: --debug
summary: |-
Increase logging verbosity to show all debug logs.
- name: --help -h
summary: |-
Show this help message and exit.
- name: --only-show-errors
summary: |-
Only show errors, suppressing warnings.
- name: --output -o
defaultValue: "json"
parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
summary: |-
Output format.
- name: --query
summary: |-
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
summary: |-
Increase logging verbosity. Use --debug for full debug logs.
metadata:
ms.date: 09/16/2019
description: Manage budgets for an Azure subscription.