Skip to content

Commit 8928f02

Browse files
AllyWevelyn-ys
andauthored
{Keyvault} Add autogen example for keyvault commands (#31321)
Co-authored-by: Yishi Wang <yishiwang@microsoft.com>
1 parent 8924c96 commit 8928f02

File tree

1 file changed

+49
-0
lines changed
  • src/azure-cli/azure/cli/command_modules/keyvault

1 file changed

+49
-0
lines changed

src/azure-cli/azure/cli/command_modules/keyvault/_help.py

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,15 @@
4242
short-summary: Manage contacts for certificate management.
4343
"""
4444

45+
helps['keyvault certificate contact add'] = """
46+
type: command
47+
short-summary: Add a contact to the specified vault to receive notifications of certificate operations.
48+
examples:
49+
- name: Add a certificate contact with the specified email to the Key Vault. (autogenerated)
50+
text: |
51+
az keyvault certificate contact add --vault-name cli-mock-kv-ct-co --email other@contoso.com
52+
"""
53+
4554
helps['keyvault certificate create'] = """
4655
type: command
4756
short-summary: Create a Key Vault certificate.
@@ -189,11 +198,29 @@
189198
short-summary: Manage certificate issuer information.
190199
"""
191200

201+
helps['keyvault certificate issuer create'] = """
202+
type: command
203+
short-summary: Create a certificate issuer record.
204+
examples:
205+
- name: Create a certificate issuer in a Key Vault by specifying vault name, issuer name, and provider. (autogenerated)
206+
text: |
207+
az keyvault certificate issuer create --vault-name cli-mock-kv-ct-is --issuer-name issuer1 --provider Test
208+
"""
209+
192210
helps['keyvault certificate issuer admin'] = """
193211
type: group
194212
short-summary: Manage admin information for certificate issuers.
195213
"""
196214

215+
helps['keyvault certificate issuer admin add'] = """
216+
type: command
217+
short-summary: Add admin details for a specified certificate issuer.
218+
examples:
219+
- name: Add a new certificate issuer administrator to a Key Vault by specifying the vault, issuer name, and admin email. (autogenerated)
220+
text: |
221+
az keyvault certificate issuer admin add --vault-name cli-mock-kv-ct-is --issuer-name issuer1 --email mock2@mock.com
222+
"""
223+
197224
helps['keyvault certificate pending'] = """
198225
type: group
199226
short-summary: Manage pending certificate creation operations.
@@ -384,6 +411,10 @@
384411
short-summary: Create a new key, stores it, then returns key parameters and attributes to the client.
385412
long-summary: The create key operation can be used to create any key type in Vault or HSM. If the named
386413
key already exists, Vault or HSM creates a new version of the key. It requires the keys/create permission.
414+
examples:
415+
- name: Create a key in a specified Key Vault with a given name. (autogenerated)
416+
text: |
417+
az keyvault key create --vault-name envault -n enkey
387418
"""
388419

389420
helps['keyvault key download'] = """
@@ -528,6 +559,15 @@
528559
short-summary: Manage vault network ACLs.
529560
"""
530561

562+
helps['keyvault network-rule add'] = """
563+
type: command
564+
short-summary: Add a network rule to the network ACLs for a Key Vault.
565+
examples:
566+
- name: Add a specific IP address to the network access rules of a Key Vault in a specified resource group using this command. (autogenerated)
567+
text: |
568+
az keyvault network-rule add --ip-address 1.2.3.4 --name cli-mock-kv-nr --resource-group cli_mock_keyvault_network_rule
569+
"""
570+
531571
helps['keyvault network-rule wait'] = """
532572
type: command
533573
short-summary: Place the CLI in a waiting state until a condition of the vault is met.
@@ -690,6 +730,15 @@
690730
short-summary: Manage role assignments.
691731
"""
692732

733+
helps['keyvault role assignment create'] = """
734+
type: command
735+
short-summary: Create a new role assignment for a user, group, or service principal.
736+
examples:
737+
- name: Create a role assignment for a specified assignee with a defined role and scope in a Managed HSM using its name. (autogenerated)
738+
text: |
739+
az keyvault role assignment create --assignee fb2f-ac10--a04f-8b0d786ea37d --hsm-name mock-mhsm --role "Managed HSM Crypto User" --scope "/"
740+
"""
741+
693742
helps['keyvault role definition'] = """
694743
type: group
695744
short-summary: Manage role definitions.

0 commit comments

Comments
 (0)