Skip to content

Commit 562a879

Browse files
azdevxpsazdevxps
committed
Regenerate KeyVault help files
1 parent 32b4832 commit 562a879

File tree

52 files changed

+1201
-335
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1201
-335
lines changed

‎src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificate.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml
3+
Module Name: AzureRM.KeyVault
34
ms.assetid: 89299823-3382-402D-9458-519466748051
45
online version:
56
schema: 2.0.0
@@ -14,8 +15,8 @@ Adds a certificate to a key vault.
1415

1516
```
1617
Add-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String>
17-
[[-CertificatePolicy] <KeyVaultCertificatePolicy>] [-Tag <Hashtable>] [-WhatIf] [-Confirm]
18-
[<CommonParameters>]
18+
[[-CertificatePolicy] <KeyVaultCertificatePolicy>] [-Tag <Hashtable>]
19+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1920
```
2021

2122
## DESCRIPTION
@@ -93,12 +94,27 @@ Parameter Sets: (All)
9394
Aliases:
9495

9596
Required: False
96-
Position: 3
97+
Position: 2
9798
Default value: None
9899
Accept pipeline input: True (ByPropertyName)
99100
Accept wildcard characters: False
100101
```
101102
103+
### -DefaultProfile
104+
The credentials, account, tenant, and subscription used for communication with azure
105+
106+
```yaml
107+
Type: IAzureContextContainer
108+
Parameter Sets: (All)
109+
Aliases: AzureRmContext, AzureCredential
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
102118
### -Name
103119
Specifies the name of the certificate to add.
104120
@@ -108,7 +124,7 @@ Parameter Sets: (All)
108124
Aliases: CertificateName
109125

110126
Required: True
111-
Position: 2
127+
Position: 1
112128
Default value: None
113129
Accept pipeline input: True (ByPropertyName)
114130
Accept wildcard characters: False
@@ -140,7 +156,7 @@ Parameter Sets: (All)
140156
Aliases:
141157

142158
Required: True
143-
Position: 1
159+
Position: 0
144160
Default value: None
145161
Accept pipeline input: True (ByPropertyName)
146162
Accept wildcard characters: False

‎src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificateContact.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml
3+
Module Name: AzureRM.KeyVault
34
ms.assetid: 2D3021B3-12C5-4797-8BF2-800E3CEAC56C
45
online version:
56
schema: 2.0.0
@@ -13,8 +14,8 @@ Adds a contact for certificate notifications.
1314
## SYNTAX
1415

1516
```
16-
Add-AzureKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <String> [-PassThru] [-WhatIf]
17-
[-Confirm] [<CommonParameters>]
17+
Add-AzureKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <String> [-PassThru]
18+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -33,6 +34,21 @@ This command adds Patti Fuller as a certificate contact for the ContosoKV01 key
3334

3435
## PARAMETERS
3536

37+
### -DefaultProfile
38+
The credentials, account, tenant, and subscription used for communication with azure
39+
40+
```yaml
41+
Type: IAzureContextContainer
42+
Parameter Sets: (All)
43+
Aliases: AzureRmContext, AzureCredential
44+
45+
Required: False
46+
Position: Named
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
3652
### -EmailAddress
3753
Specifies the email address of the contact.
3854
@@ -42,7 +58,7 @@ Parameter Sets: (All)
4258
Aliases:
4359

4460
Required: True
45-
Position: 2
61+
Position: 1
4662
Default value: None
4763
Accept pipeline input: True (ByPropertyName)
4864
Accept wildcard characters: False
@@ -73,7 +89,7 @@ Parameter Sets: (All)
7389
Aliases:
7490

7591
Required: True
76-
Position: 1
92+
Position: 0
7793
Default value: None
7894
Accept pipeline input: True (ByPropertyName)
7995
Accept wildcard characters: False

‎src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultKey.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml
3+
Module Name: AzureRM.KeyVault
34
ms.assetid: 846F781C-73A3-4BBE-ABD9-897371109FBE
45
online version: http://go.microsoft.com/fwlink/?LinkId=690295
56
schema: 2.0.0
@@ -15,15 +16,16 @@ Creates a key in a key vault or imports a key into a key vault.
1516
### Create (Default)
1617
```
1718
Add-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> -Destination <String> [-Disable]
18-
[-KeyOps <String[]>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-WhatIf] [-Confirm]
19-
[<CommonParameters>]
19+
[-KeyOps <String[]>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>]
20+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2021
```
2122

2223
### Import
2324
```
2425
Add-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> -KeyFilePath <String>
2526
[-KeyFilePassword <SecureString>] [-Destination <String>] [-Disable] [-KeyOps <String[]>]
26-
[-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
27+
[-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>]
28+
[-WhatIf] [-Confirm] [<CommonParameters>]
2729
```
2830

2931
## DESCRIPTION
@@ -141,13 +143,13 @@ stored in $tags.
141143

142144
## PARAMETERS
143145

144-
### -Confirm
145-
Prompts you for confirmation before running the cmdlet.
146+
### -DefaultProfile
147+
The credentials, account, tenant, and subscription used for communication with azure
146148

147149
```yaml
148-
Type: SwitchParameter
150+
Type: IAzureContextContainer
149151
Parameter Sets: (All)
150-
Aliases: cf
152+
Aliases: AzureRmContext, AzureCredential
151153

152154
Required: False
153155
Position: Named
@@ -177,7 +179,7 @@ extension, it imports the key as a software-protected key.
177179
```yaml
178180
Type: String
179181
Parameter Sets: Create
180-
Aliases:
182+
Aliases:
181183
Accepted values: HSM, Software
182184

183185
Required: True
@@ -190,7 +192,7 @@ Accept wildcard characters: False
190192
```yaml
191193
Type: String
192194
Parameter Sets: Import
193-
Aliases:
195+
Aliases:
194196
Accepted values: HSM, Software
195197

196198
Required: False
@@ -207,7 +209,7 @@ the key will fail. Use this parameter if you are preloading keys that you intend
207209
```yaml
208210
Type: SwitchParameter
209211
Parameter Sets: (All)
210-
Aliases:
212+
Aliases:
211213

212214
Required: False
213215
Position: Named
@@ -225,7 +227,7 @@ parameter, the key does not expire.
225227
```yaml
226228
Type: DateTime
227229
Parameter Sets: (All)
228-
Aliases:
230+
Aliases:
229231
230232
Required: False
231233
Position: Named
@@ -243,7 +245,7 @@ name extension.
243245
```yaml
244246
Type: SecureString
245247
Parameter Sets: Import
246-
Aliases:
248+
Aliases:
247249
248250
Required: False
249251
Position: Named
@@ -267,7 +269,7 @@ When you specify this parameter, the *Destination* parameter is optional.
267269
```yaml
268270
Type: String
269271
Parameter Sets: Import
270-
Aliases:
272+
Aliases:
271273
272274
Required: True
273275
Position: Named
@@ -295,7 +297,7 @@ the [JSON Web Key (JWK) specification](http://go.microsoft.com/fwlink/?LinkID=61
295297
```yaml
296298
Type: String[]
297299
Parameter Sets: (All)
298-
Aliases:
300+
Aliases:
299301
300302
Required: False
301303
Position: Named
@@ -330,7 +332,7 @@ parameter, the key can be used immediately.
330332
```yaml
331333
Type: DateTime
332334
Parameter Sets: (All)
333-
Aliases:
335+
Aliases:
334336
335337
Required: False
336338
Position: Named
@@ -363,7 +365,7 @@ FQDN of a key vault based on the name that this parameter specifies and your cur
363365
```yaml
364366
Type: String
365367
Parameter Sets: (All)
366-
Aliases:
368+
Aliases:
367369
368370
Required: True
369371
Position: 0
@@ -372,6 +374,21 @@ Accept pipeline input: True (ByPropertyName)
372374
Accept wildcard characters: False
373375
```
374376

377+
### -Confirm
378+
Prompts you for confirmation before running the cmdlet.
379+
380+
```yaml
381+
Type: SwitchParameter
382+
Parameter Sets: (All)
383+
Aliases: cf
384+
385+
Required: False
386+
Position: Named
387+
Default value: None
388+
Accept pipeline input: False
389+
Accept wildcard characters: False
390+
```
391+
375392
### -WhatIf
376393
Shows what would happen if the cmdlet runs.
377394
The cmdlet is not run.

‎src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultManagedStorageAccount.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml
3+
Module Name: AzureRM.KeyVault
34
online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx
45
schema: 2.0.0
56
---
@@ -14,7 +15,8 @@ Adds an existing Azure Storage Account to the specified key vault for its keys t
1415
```
1516
Add-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String>
1617
[-AccountResourceId] <String> [-ActiveKeyName] <String> [-DisableAutoRegenerateKey]
17-
[-RegenerationPeriod <TimeSpan>] [-Disable] [-Tag <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-RegenerationPeriod <TimeSpan>] [-Disable] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>]
19+
[-WhatIf] [-Confirm] [<CommonParameters>]
1820
```
1921

2022
## DESCRIPTION
@@ -86,7 +88,7 @@ Name of the storage account key that must be used for generating sas tokens.
8688
```yaml
8789
Type: String
8890
Parameter Sets: (All)
89-
Aliases:
91+
Aliases:
9092

9193
Required: True
9294
Position: 3
@@ -95,13 +97,13 @@ Accept pipeline input: True (ByPropertyName)
9597
Accept wildcard characters: False
9698
```
9799
98-
### -Confirm
99-
Prompts you for confirmation before running the cmdlet.
100+
### -DefaultProfile
101+
The credentials, account, tenant, and subscription used for communication with azure
100102
101103
```yaml
102-
Type: SwitchParameter
104+
Type: IAzureContextContainer
103105
Parameter Sets: (All)
104-
Aliases: cf
106+
Aliases: AzureRmContext, AzureCredential
105107

106108
Required: False
107109
Position: Named
@@ -116,7 +118,7 @@ Disables the use of managed storage account's key for generation of sas tokens.
116118
```yaml
117119
Type: SwitchParameter
118120
Parameter Sets: (All)
119-
Aliases:
121+
Aliases:
120122

121123
Required: False
122124
Position: Named
@@ -133,7 +135,7 @@ storage account are not auto regenerated.
133135
```yaml
134136
Type: SwitchParameter
135137
Parameter Sets: (All)
136-
Aliases:
138+
Aliases:
137139

138140
Required: False
139141
Position: Named
@@ -149,7 +151,7 @@ which managed storage account's inactive keygets auto regenerated and becomes th
149151
```yaml
150152
Type: TimeSpan
151153
Parameter Sets: (All)
152-
Aliases:
154+
Aliases:
153155

154156
Required: False
155157
Position: Named
@@ -182,7 +184,7 @@ Cmdlet constructs the FQDN of a vault based on the name and currently selected e
182184
```yaml
183185
Type: String
184186
Parameter Sets: (All)
185-
Aliases:
187+
Aliases:
186188

187189
Required: True
188190
Position: 0
@@ -191,6 +193,21 @@ Accept pipeline input: True (ByPropertyName)
191193
Accept wildcard characters: False
192194
```
193195
196+
### -Confirm
197+
Prompts you for confirmation before running the cmdlet.
198+
199+
```yaml
200+
Type: SwitchParameter
201+
Parameter Sets: (All)
202+
Aliases: cf
203+
204+
Required: False
205+
Position: Named
206+
Default value: None
207+
Accept pipeline input: False
208+
Accept wildcard characters: False
209+
```
210+
194211
### -WhatIf
195212
Shows what would happen if the cmdlet runs.
196213
The cmdlet is not run.

0 commit comments

Comments
 (0)