forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdisk.pycliyml
More file actions
452 lines (452 loc) · 14.5 KB
/
disk.pycliyml
File metadata and controls
452 lines (452 loc) · 14.5 KB
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
commandList:
- name: az disk create
description: Create a managed disk.
href: disk#create
- name: az disk delete
description: Delete a managed disk.
href: disk#delete
- name: az disk grant-access
description: Grant read access to a managed disk.
href: disk#grant-access
- name: az disk list
description: List managed disks.
href: disk#list
- name: az disk revoke-access
description: Revoke read access to a managed disk.
href: disk#revoke-access
- name: az disk show
description: Gets information about a disk.
href: disk#show
- name: az disk update
description: Update a managed disk.
href: disk#update
- name: az disk wait
description: Place the CLI in a waiting state until a condition of the managed disk is met.
href: disk#wait
htmlId: disk
examples: []
children:
- commandList: []
htmlId: create
examples:
- title: Create a managed disk by importing from a blob uri.
code: az disk create -g MyResourceGroup -n MyDisk --source https://vhd1234.blob.core.windows.net/vhds/osdisk1234.vhd
- title: Create an empty managed disk.
code: az disk create -g MyResourceGroup -n MyDisk --size-gb 10
- title: Create a managed disk by copying from an existing disk or snapshot.
code: az disk create -g MyResourceGroup -n MyDisk2 --source MyDisk
parameters:
- name: --name -n
isRequired: True
summary: The name of the managed disk.
description: ''
- name: --resource-group -g
isRequired: True
summary: Name of resource group. You can configure the default group using az configure --defaults group=<name>.
description: ''
- name: --location -l
isRequired: False
summary: Location. You can configure the default location using az configure --defaults location=<location>.
description: ''
- name: --no-wait
isRequired: False
summary: Do not wait for the long running operation to finish.
description: ''
- name: --size-gb -z
isRequired: False
summary: Size in GB.
description: ''
- name: --sku
isRequired: False
summary: Underlying storage sku.
description: ''
defaultValue: Premium_LRS
parameterValueGroup: Premium_LRS, Standard_LRS
- name: --source
isRequired: False
summary: Source to create the disk/snapshot from, including unmanaged blob uri, managed disk id or name, or snapshot id or name.
description: ''
- name: --source-storage-account-id
isRequired: False
summary: Used when source blob is in a different subscription.
description: ''
- name: --tags
isRequired: False
summary: Space separated tags in 'key[=value]' format. Use "" to clear existing tags.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_disk_create
name: az disk create
description: ''
summary: Create a managed disk.
Metadata: {}
- commandList: []
htmlId: delete
examples: []
parameters:
- name: --name -n
isRequired: True
summary: The name of the managed disk.
description: ''
- name: --resource-group -g
isRequired: True
summary: Name of resource group. You can configure the default group using az configure --defaults group=<name>.
description: ''
- name: --no-wait
isRequired: False
summary: Do not wait for the long running operation to finish.
description: ''
- name: --yes -y
isRequired: False
summary: Do not prompt for confirmation.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_disk_delete
name: az disk delete
description: ''
summary: Delete a managed disk.
Metadata: {}
- commandList: []
htmlId: grant-access
examples: []
parameters:
- name: --duration-in-seconds
isRequired: True
summary: Time duration in seconds until the SAS access expires.
description: ''
- name: --name -n
isRequired: True
summary: The name of the managed disk.
description: ''
- name: --resource-group -g
isRequired: True
summary: Name of resource group. You can configure the default group using az configure --defaults group=<name>.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_disk_grant-access
name: az disk grant-access
description: ''
summary: Grant read access to a managed disk.
Metadata: {}
- commandList: []
htmlId: list
examples: []
parameters:
- name: --resource-group -g
isRequired: False
summary: Name of resource group. You can configure the default group using az configure --defaults group=<name>.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_disk_list
name: az disk list
description: ''
summary: List managed disks.
Metadata: {}
- commandList: []
htmlId: revoke-access
examples: []
parameters:
- name: --name -n
isRequired: True
summary: The name of the managed disk.
description: ''
- name: --resource-group -g
isRequired: True
summary: Name of resource group. You can configure the default group using az configure --defaults group=<name>.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_disk_revoke-access
name: az disk revoke-access
description: ''
summary: Revoke read access to a managed disk.
Metadata: {}
- commandList: []
htmlId: show
examples: []
parameters:
- name: --name -n
isRequired: True
summary: The name of the managed disk.
description: ''
- name: --resource-group -g
isRequired: True
summary: Name of resource group. You can configure the default group using az configure --defaults group=<name>.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_disk_show
name: az disk show
description: ''
summary: Gets information about a disk.
Metadata: {}
- commandList: []
htmlId: update
examples: []
parameters:
- name: --name -n
isRequired: True
summary: The name of the managed disk.
description: ''
- name: --resource-group -g
isRequired: True
summary: Name of resource group. You can configure the default group using az configure --defaults group=<name>.
description: ''
- name: --no-wait
isRequired: False
summary: Do not wait for the long running operation to finish.
description: ''
- name: --size-gb -z
isRequired: False
summary: Size in GB.
description: ''
- name: --sku
isRequired: False
summary: Underlying storage sku.
description: ''
parameterValueGroup: Premium_LRS, Standard_LRS
- name: --add
isRequired: False
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>.'
description: ''
- name: --remove
isRequired: False
summary: 'Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.'
description: ''
- name: --set
isRequired: False
summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.'
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_disk_update
name: az disk update
description: ''
summary: Update a managed disk.
Metadata: {}
- commandList: []
htmlId: wait
examples: []
parameters:
- name: --name -n
isRequired: True
summary: The name of the managed disk.
description: ''
- name: --resource-group -g
isRequired: True
summary: Name of resource group. You can configure the default group using az configure --defaults group=<name>.
description: ''
- name: --created
isRequired: False
summary: Wait till created with 'provisioningState' at 'Succeeded'.
description: ''
- name: --custom
isRequired: False
summary: Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
description: ''
- name: --deleted
isRequired: False
summary: Wait till deleted.
description: ''
- name: --exists
isRequired: False
summary: Wait till the resource exists.
description: ''
- name: --interval
isRequired: False
summary: Polling interval in seconds.
description: ''
defaultValue: 30
- name: --timeout
isRequired: False
summary: Maximum wait in seconds.
description: ''
defaultValue: 3600
- name: --updated
isRequired: False
summary: Wait till updated with provisioningState at 'Succeeded'.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_disk_wait
name: az disk wait
description: ''
summary: Place the CLI in a waiting state until a condition of the managed disk is met.
Metadata: {}
uid: az_disk
name: 'Managed Disks - az disk'
description: ''
summary: Manage Azure Managed Disks.
Metadata: {}