forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathkeyvault.pycliyml
More file actions
781 lines (781 loc) · 28.9 KB
/
Copy pathkeyvault.pycliyml
File metadata and controls
781 lines (781 loc) · 28.9 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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
commandList:
- name: az keyvault certificate
description: Manage certificates.
href: keyvault/certificate
isGroup: true
- name: az keyvault certificate contact
description: Manage contacts for certificate management.
href: keyvault/certificate/contact
isGroup: true
- name: az keyvault certificate contact add
description: Add a contact to the specified vault to receive notifications of certificate operations.
href: keyvault/certificate/contact#add
- name: az keyvault certificate contact delete
description: Remove a certificate contact from the specified vault.
href: keyvault/certificate/contact#delete
- name: az keyvault certificate contact list
description: Lists the certificate contacts for a specified key vault.
href: keyvault/certificate/contact#list
- name: az keyvault certificate create
description: Creates a new certificate.
href: keyvault/certificate#create
- name: az keyvault certificate delete
description: Deletes a certificate from a specified key vault.
href: keyvault/certificate#delete
- name: az keyvault certificate download
description: Download a certificate from a KeyVault.
href: keyvault/certificate#download
- name: az keyvault certificate get-default-policy
description: Get a default policy for a self-signed certificate.
href: keyvault/certificate#get-default-policy
- name: az keyvault certificate import
description: Import a certificate into KeyVault.
href: keyvault/certificate#import
- name: az keyvault certificate issuer
description: Manage certificate issuer information.
href: keyvault/certificate/issuer
isGroup: true
- name: az keyvault certificate issuer admin
description: Manage admin information for certificate issuers.
href: keyvault/certificate/issuer/admin
isGroup: true
- name: az keyvault certificate issuer admin add
description: Add admin details for a specified certificate issuer.
href: keyvault/certificate/issuer/admin#add
- name: az keyvault certificate issuer admin delete
description: Remove admin details for the specified certificate issuer.
href: keyvault/certificate/issuer/admin#delete
- name: az keyvault certificate issuer admin list
description: List admins for a specified certificate issuer.
href: keyvault/certificate/issuer/admin#list
- name: az keyvault certificate issuer create
description: Create a certificate issuer record.
href: keyvault/certificate/issuer#create
- name: az keyvault certificate issuer delete
description: Deletes the specified certificate issuer.
href: keyvault/certificate/issuer#delete
- name: az keyvault certificate issuer list
description: List certificate issuers for a specified key vault.
href: keyvault/certificate/issuer#list
- name: az keyvault certificate issuer show
description: Lists the specified certificate issuer.
href: keyvault/certificate/issuer#show
- name: az keyvault certificate issuer update
description: Update a certificate issuer record.
href: keyvault/certificate/issuer#update
- name: az keyvault certificate list
description: List certificates in a specified key vault.
href: keyvault/certificate#list
- name: az keyvault certificate list-deleted
description: Lists the deleted certificates in the specified vault, currently available for recovery.
href: keyvault/certificate#list-deleted
- name: az keyvault certificate list-versions
description: List the versions of a certificate.
href: keyvault/certificate#list-versions
- name: az keyvault certificate pending
description: Manage pending certificate creation operations.
href: keyvault/certificate/pending
isGroup: true
- name: az keyvault certificate pending delete
description: Deletes the operation for a specified certificate.
href: keyvault/certificate/pending#delete
- name: az keyvault certificate pending merge
description: Merges a certificate or a certificate chain with a key pair existing on the server.
href: keyvault/certificate/pending#merge
- name: az keyvault certificate pending show
description: Gets the operation associated with a specified certificate.
href: keyvault/certificate/pending#show
- name: az keyvault certificate purge
description: Permanently deletes the specified deleted certificate.
href: keyvault/certificate#purge
- name: az keyvault certificate recover
description: Recovers the deleted certificate back to its current version under /certificates.
href: keyvault/certificate#recover
- name: az keyvault certificate set-attributes
description: Updates the specified attributes associated with the given certificate.
href: keyvault/certificate#set-attributes
- name: az keyvault certificate show
description: Gets information about a specified certificate.
href: keyvault/certificate#show
- name: az keyvault certificate show-deleted
description: Retrieves information about the specified deleted certificate.
href: keyvault/certificate#show-deleted
- name: az keyvault create
description: Create a key vault.
href: keyvault#create
- name: az keyvault delete
description: Delete a key vault.
href: keyvault#delete
- name: az keyvault delete-policy
description: Delete security policy settings for a Key Vault.
href: keyvault#delete-policy
- name: az keyvault key
description: Manage keys.
href: keyvault/key
isGroup: true
- name: az keyvault key backup
description: Requests that a backup of the specified key be downloaded to the client.
href: keyvault/key#backup
- name: az keyvault key create
description: Creates a new key, stores it, then returns key parameters and attributes to the client.
href: keyvault/key#create
- name: az keyvault key delete
description: Deletes a key of any type from storage in Azure Key Vault.
href: keyvault/key#delete
- name: az keyvault key import
description: Import a private key.
href: keyvault/key#import
- name: az keyvault key list
description: List keys in the specified vault.
href: keyvault/key#list
- name: az keyvault key list-deleted
description: List deleted keys in the specified vault.
href: keyvault/key#list-deleted
- name: az keyvault key list-versions
description: Retrieves a list of individual key versions with the same key name.
href: keyvault/key#list-versions
- name: az keyvault key purge
description: Permanently deletes the specified key.
href: keyvault/key#purge
- name: az keyvault key recover
description: Recovers the deleted key back to its current version under /keys.
href: keyvault/key#recover
- name: az keyvault key restore
description: Restores a backed up key to a vault.
href: keyvault/key#restore
- name: az keyvault key set-attributes
description: The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.
href: keyvault/key#set-attributes
- name: az keyvault key show
description: Gets the public part of a stored key.
href: keyvault/key#show
- name: az keyvault key show-deleted
description: Retrieves the deleted key information plus its attributes.
href: keyvault/key#show-deleted
- name: az keyvault list
description: List key vaults.
href: keyvault#list
- name: az keyvault list-deleted
description: Gets information about the deleted vaults in a subscription.
href: keyvault#list-deleted
- name: az keyvault purge
description: Permanently deletes the specified vault.
href: keyvault#purge
- name: az keyvault recover
description: Recover a key vault.
href: keyvault#recover
- name: az keyvault secret
description: Manage secrets.
href: keyvault/secret
isGroup: true
- name: az keyvault secret backup
description: Requests that a backup of the specified secret be downloaded to the client.
href: keyvault/secret#backup
- name: az keyvault secret delete
description: Deletes a secret from a specified key vault.
href: keyvault/secret#delete
- name: az keyvault secret download
description: Download a secret from a KeyVault.
href: keyvault/secret#download
- name: az keyvault secret list
description: List secrets in a specified key vault.
href: keyvault/secret#list
- name: az keyvault secret list-deleted
description: List deleted secrets in the specified vault.
href: keyvault/secret#list-deleted
- name: az keyvault secret list-versions
description: List the versions of the specified secret.
href: keyvault/secret#list-versions
- name: az keyvault secret purge
description: Permanently deletes the specified secret.
href: keyvault/secret#purge
- name: az keyvault secret recover
description: Recovers the deleted secret back to its current version under /secrets.
href: keyvault/secret#recover
- name: az keyvault secret restore
description: ''
href: keyvault/secret#restore
- name: az keyvault secret set
description: Sets a secret in a specified key vault.
href: keyvault/secret#set
- name: az keyvault secret set-attributes
description: Updates the attributes associated with a specified secret in a given key vault.
href: keyvault/secret#set-attributes
- name: az keyvault secret show
description: Get a specified secret from a given key vault.
href: keyvault/secret#show
- name: az keyvault secret show-deleted
description: Retrieves the deleted secret information plus its attributes.
href: keyvault/secret#show-deleted
- name: az keyvault set-policy
description: Update security policy settings for a Key Vault.
href: keyvault#set-policy
- name: az keyvault show
description: Show details of a key vault.
href: keyvault#show
- name: az keyvault update
description: Update the properties of a key vault.
href: keyvault#update
htmlId: keyvault
examples: []
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children:
- commandList: []
htmlId: create
examples: []
parameters:
- name: --name -n
isRequired: True
summary: Name of the key vault.
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: --enable-soft-delete
isRequired: False
summary: Enable vault deletion recovery for the vault, and all contained entities.
description: ''
parameterValueGroup: false, true
- name: --enabled-for-deployment
isRequired: False
summary: Allow Virtual Machines to retrieve certificates stored as secrets from the vault.
description: ''
parameterValueGroup: false, true
- name: --enabled-for-disk-encryption
isRequired: False
summary: Allow Disk Encryption to retrieve secrets from the vault and unwrap keys.
description: ''
parameterValueGroup: false, true
- name: --enabled-for-template-deployment
isRequired: False
summary: Allow Resource Manager to retrieve secrets from the vault.
description: ''
parameterValueGroup: false, true
- name: --location -l
isRequired: False
summary: Location. You can configure the default location using az configure --defaults location=<location>.
description: ''
- name: --no-self-perms
isRequired: False
summary: Don't add permissions for the current user/service principal in the new vault.
description: ''
parameterValueGroup: false, true
- name: --sku
isRequired: False
summary: SKU details.
description: ''
defaultValue: standard
parameterValueGroup: premium, standard
- 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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_create
name: az keyvault create
description: Default permissions are created for the current user or service principal unless the --no-self-perms flag is specified.
summary: Create a key vault.
Metadata: {}
- commandList: []
htmlId: delete
examples: []
parameters:
- name: --name -n
isRequired: True
summary: Name of the key vault.
description: ''
- name: --resource-group -g
isRequired: False
summary: Proceed only if Key Vault belongs to the specified resource group.
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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_delete
name: az keyvault delete
description: ''
summary: Delete a key vault.
Metadata: {}
- commandList: []
htmlId: delete-policy
examples: []
parameters:
- name: --name -n
isRequired: True
summary: Name of the key vault.
description: ''
- name: --object-id
isRequired: False
summary: A GUID that identifies the principal that will receive permissions.
description: ''
- name: --resource-group -g
isRequired: False
summary: Proceed only if Key Vault belongs to the specified resource group.
description: ''
- name: --spn
isRequired: False
summary: Name of a service principal that will receive permissions.
description: ''
- name: --upn
isRequired: False
summary: Name of a user principal that will receive permissions.
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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_delete-policy
name: az keyvault delete-policy
description: ''
summary: Delete security policy settings for a Key Vault.
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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_list
name: az keyvault list
description: ''
summary: List key vaults.
Metadata: {}
- commandList: []
htmlId: list-deleted
examples: []
parameters:
- 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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_list-deleted
name: az keyvault list-deleted
description: ''
summary: Gets information about the deleted vaults in a subscription.
Metadata: {}
- commandList: []
htmlId: purge
examples: []
parameters:
- name: --location -l
isRequired: True
summary: Location. You can configure the default location using az configure --defaults location=<location>.
description: ''
- name: --name -n
isRequired: True
summary: Name of the key vault.
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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_purge
name: az keyvault purge
description: Aka Purges the deleted Azure key vault.
summary: Permanently deletes the specified vault.
Metadata: {}
- commandList: []
htmlId: recover
examples: []
parameters:
- name: --location -l
isRequired: True
summary: Location. You can configure the default location using az configure --defaults location=<location>.
description: ''
- name: --name -n
isRequired: True
summary: Name of the key vault.
description: ''
- name: --resource-group -g
isRequired: False
summary: Proceed only if Key Vault belongs to the specified resource group.
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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_recover
name: az keyvault recover
description: Recovers a previously deleted key vault for which soft delete was enabled.
summary: Recover a key vault.
Metadata: {}
- commandList: []
htmlId: set-policy
examples: []
parameters:
- name: --name -n
isRequired: True
summary: Name of the key vault.
description: ''
- name: --object-id
isRequired: False
summary: A GUID that identifies the principal that will receive permissions.
description: ''
- name: --resource-group -g
isRequired: False
summary: Proceed only if Key Vault belongs to the specified resource group.
description: ''
- name: --spn
isRequired: False
summary: Name of a service principal that will receive permissions.
description: ''
- name: --upn
isRequired: False
summary: Name of a user principal that will receive permissions.
description: ''
- name: --certificate-permissions
isRequired: False
summary: 'Space separated list. Possible values: get, list, delete, create, import, update, managecontacts, getissuers, listissuers, setissuers, deleteissuers, manageissuers, recover, purge.'
description: ''
- name: --key-permissions
isRequired: False
summary: 'Space separated list. Possible values: encrypt, decrypt, wrapKey, unwrapKey, sign, verify, get, list, create, update, import, delete, backup, restore, recover, purge.'
description: ''
- name: --secret-permissions
isRequired: False
summary: 'Space separated list. Possible values: get, list, set, delete, backup, restore, recover, purge.'
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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_set-policy
name: az keyvault set-policy
description: ''
summary: Update security policy settings for a Key Vault.
Metadata: {}
- commandList: []
htmlId: show
examples: []
parameters:
- name: --name -n
isRequired: True
summary: Name of the key vault.
description: ''
- name: --resource-group -g
isRequired: False
summary: Proceed only if Key Vault belongs to the specified resource group.
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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_show
name: az keyvault show
description: ''
summary: Show details of a key vault.
Metadata: {}
- commandList: []
htmlId: update
examples: []
parameters:
- name: --name -n
isRequired: True
summary: Name of the key vault.
description: ''
- name: --enabled-for-deployment
isRequired: False
summary: Allow Virtual Machines to retrieve certificates stored as secrets from the vault.
description: ''
parameterValueGroup: false, true
- name: --enabled-for-disk-encryption
isRequired: False
summary: Allow Disk Encryption to retrieve secrets from the vault and unwrap keys.
description: ''
parameterValueGroup: false, true
- name: --enabled-for-template-deployment
isRequired: False
summary: Allow Resource Manager to retrieve secrets from the vault.
description: ''
parameterValueGroup: false, true
- name: --resource-group -g
isRequired: False
summary: Proceed only if Key Vault belongs to the specified resource group.
description: ''
- 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: ''
source:
remote:
path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_keyvault_update
name: az keyvault update
description: ''
summary: Update the properties of a key vault.
Metadata: {}
uid: az_keyvault
name: 'Key Vault - az keyvault'
description: If you don't have the keyvault component installed, add it with az component update --add keyvault.
summary: Safeguard and maintain control of keys, secrets, and certificates.
Metadata:
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
doc_source_url_path: src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
gitcommit: https://github.com/Azure/azure-cli/blob/e0ee922a1f9da2b2bc29c7eed72872eca26df7e5/src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py
updated_at: 6/16/2017 10:50:05 PM
ms.date: 6/16/2017