Skip to content

Commit f7afb24

Browse files
committed
Merge from upstream dev.
1 parent f471792 commit f7afb24

File tree

49 files changed

+474
-299
lines changed

Some content is hidden

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

49 files changed

+474
-299
lines changed

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

Lines changed: 8 additions & 7 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+
ms.assetid: 89299823-3382-402D-9458-519466748051
34
online version:
45
schema: 2.0.0
56
---
@@ -18,7 +19,7 @@ Add-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String>
1819
```
1920

2021
## DESCRIPTION
21-
The Add-AzureKeyVaultCertificate cmdlet starts the process of enrolling for a certificate in a key vault in Azure Key Vault.
22+
The **Add-AzureKeyVaultCertificate** cmdlet starts the process of enrolling for a certificate in a key vault in Azure Key Vault.
2223

2324
## EXAMPLES
2425

@@ -75,7 +76,7 @@ Updated : 2/8/2016 11:21:45 PM
7576

7677
The first command uses the New-AzureKeyVaultCertificatePolicy cmdlet to create a certificate policy, and then stores it in the $Policy variable.
7778

78-
The second command uses Add-AzureKeyVaultCertificate to start the process to create a certificate.
79+
The second command uses **Add-AzureKeyVaultCertificate** to start the process to create a certificate.
7980

8081
The third command uses the Get-AzureKeyVaultCertificateOperation cmdlet to poll the operation to verify that it's complete.
8182

@@ -84,7 +85,7 @@ The final command uses the Get-AzureKeyVaultCertificate cmdlet to get the certif
8485
## PARAMETERS
8586

8687
### -CertificatePolicy
87-
Specifies a KeyVaultCertificatePolicy object.
88+
Specifies a **KeyVaultCertificatePolicy** object.
8889

8990
```yaml
9091
Type: KeyVaultCertificatePolicy
@@ -144,7 +145,7 @@ Accept wildcard characters: False
144145
```
145146
146147
### -Tag
147-
A hashtable representing certificate tags.
148+
Specifies a hash table that contains certificate tags.
148149
149150
```yaml
150151
Type: Hashtable
@@ -185,9 +186,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
185186
186187
## RELATED LINKS
187188
188-
[Get-AzureKeyVaultCertificate]()
189+
[Get-AzureKeyVaultCertificate](./Get-AzureKeyVaultCertificate.md)
189190
190-
[Import-AzureKeyVaultCertificate]()
191+
[Import-AzureKeyVaultCertificate](./Import-AzureKeyVaultCertificate.md)
191192
192-
[Remove-AzureKeyVaultCertificate]()
193+
[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md)
193194

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

Lines changed: 5 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+
ms.assetid: 2D3021B3-12C5-4797-8BF2-800E3CEAC56C
34
online version:
45
schema: 2.0.0
56
---
@@ -17,7 +18,7 @@ Add-AzureKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <Strin
1718
```
1819

1920
## DESCRIPTION
20-
The Add-AzureKeyVaultCertificateContact cmdlet adds a contact for a key vault for certificate notifications in Azure Key Vault.
21+
The **Add-AzureKeyVaultCertificateContact** cmdlet adds a contact for a key vault for certificate notifications in Azure Key Vault.
2122
The contact receives updates about events such as certificate close to expiry, certificate renewed, and so on.
2223
These events are determined by the certificate policy.
2324

@@ -28,7 +29,7 @@ These events are determined by the certificate policy.
2829
PS C:\>Add-AzureKeyVaultCertificateContact -VaultName "ContosoKV01" -EmailAddress "[email protected]" -PassThru
2930
```
3031

31-
This command adds Patti Fuller as a certificate contact for the ContosoKV01 key vault and returns the KeyVaultCertificateContact object.
32+
This command adds Patti Fuller as a certificate contact for the ContosoKV01 key vault and returns the **KeyVaultCertificateContact** object.
3233

3334
## PARAMETERS
3435

@@ -122,7 +123,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
122123
123124
## RELATED LINKS
124125
125-
[Get-AzureKeyVaultCertificateContact]()
126+
[Get-AzureKeyVaultCertificateContact](./Get-AzureKeyVaultCertificateContact.md)
126127
127-
[Remove-AzureKeyVaultCertificateContact]()
128+
[Remove-AzureKeyVaultCertificateContact](./Remove-AzureKeyVaultCertificateContact.md)
128129

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

Lines changed: 56 additions & 44 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+
ms.assetid: 846F781C-73A3-4BBE-ABD9-897371109FBE
34
online version: http://go.microsoft.com/fwlink/?LinkId=690295
45
schema: 2.0.0
56
---
@@ -26,14 +27,14 @@ Add-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> -KeyFilePath <String
2627
```
2728

2829
## DESCRIPTION
29-
The Add-AzureKeyVaultKey cmdlet creates a key in a key vault in Azure Key Vault, or imports a key into a key vault.
30+
The **Add-AzureKeyVaultKey** cmdlet creates a key in a key vault in Azure Key Vault, or imports a key into a key vault.
3031
Use this cmdlet to add keys by using any of the following methods:
3132

32-
-- Create a key in a hardware security module (HSM) in the Key Vault service.
33-
-- Create a key in software in the Key Vault service.
34-
-- Import a key from your own hardware security module (HSM) to HSMs in the Key Vault service.
35-
-- Import a key from a .pfx file on your computer.
36-
-- Import a key from a .pfx file on your computer to hardware security modules (HSMs) in the Key Vault service.
33+
- Create a key in a hardware security module (HSM) in the Key Vault service.
34+
- Create a key in software in the Key Vault service.
35+
- Import a key from your own hardware security module (HSM) to HSMs in the Key Vault service.
36+
- Import a key from a .pfx file on your computer.
37+
- Import a key from a .pfx file on your computer to hardware security modules (HSMs) in the Key Vault service.
3738

3839
For any of these operations, you can provide key attributes or accept default settings.
3940

@@ -74,27 +75,27 @@ PS C:\> Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITHsmNonDefault' -Desti
7475

7576
The first command stores the values decrypt and verify in the $KeyOperations variable.
7677

77-
The second command creates a DateTime object, defined in UTC, by using the Get-Date cmdlet.
78+
The second command creates a **DateTime** object, defined in UTC, by using the **Get-Date** cmdlet.
7879
That object specifies a time two years in the future.
7980
The command stores that date in the $Expires variable.
80-
For more information, type Get-Help Get-Date.
81+
For more information, type `Get-Help Get-Date`.
8182

82-
The third command creates a DateTime object by using the Get-Date cmdlet.
83+
The third command creates a **DateTime** object by using the **Get-Date** cmdlet.
8384
That object specifies current UTC time.
8485
The command stores that date in the $NotBefore variable.
8586

8687
The final command creates a key named ITHsmNonDefault that is an HSM-protected key.
8788
The command specifies values for allowed key operations stored $KeyOperations.
88-
The command specifies times for the Expires and NotBefore parameters created in the previous commands, and tags for high severity and IT.
89+
The command specifies times for the *Expires* and *NotBefore* parameters created in the previous commands, and tags for high severity and IT.
8990
The new key is disabled.
90-
You can enable it by using the Set-AzureKeyVaultKey cmdlet.
91+
You can enable it by using the **Set-AzureKeyVaultKey** cmdlet.
9192

9293
### Example 4: Import an HSM-protected key
9394
```
9495
PS C:\>Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITByok' -KeyFilePath 'C:\Contoso\ITByok.byok' -Destination 'HSM'
9596
```
9697

97-
This command imports the key named ITByok from the location that the KeyFilePath parameter specifies.
98+
This command imports the key named ITByok from the location that the *KeyFilePath* parameter specifies.
9899
The imported key is an HSM-protected key.
99100

100101
To import a key from your own hardware security module, you must first generate a BYOK package (a file with a .byok file name extension) by using the Azure Key Vault BYOK toolset.
@@ -106,8 +107,8 @@ PS C:\>$Password = ConvertTo-SecureString -String 'Password' -AsPlainText -Force
106107
PS C:\> Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITPfx' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password
107108
```
108109

109-
The first command converts a string into a secure string by using the ConvertTo-SecureString cmdlet, and then stores that string in the $Password variable.
110-
For more information, type Get-Help ConvertTo-SecureString.
110+
The first command converts a string into a secure string by using the **ConvertTo-SecureString** cmdlet, and then stores that string in the $Password variable.
111+
For more information, type `Get-Help ConvertTo-SecureString`.
111112

112113
The second command creates a software password in the Contoso key vault.
113114
The command specifies the location for the key and the password stored in $Password.
@@ -120,9 +121,9 @@ PS C:\> $Tags = @{ 'Severity' = 'high'; 'Accounting' = null }
120121
PS C:\> Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITPfxToHSM' -Destination 'HSM' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password -Expires $Expires -Tags $Tags
121122
```
122123

123-
The first command converts a string into a secure string by using the ConvertTo-SecureString cmdlet, and then stores that string in the $Password variable.
124+
The first command converts a string into a secure string by using the **ConvertTo-SecureString** cmdlet, and then stores that string in the $Password variable.
124125

125-
The second command creates a DateTime object by using the Get-Date cmdlet, and then stores that object in the $Expires variable.
126+
The second command creates a **DateTime** object by using the **Get-Date** cmdlet, and then stores that object in the $Expires variable.
126127

127128
The third command creates the $tags variable to set tags for high severity and IT.
128129

@@ -139,12 +140,12 @@ Note: To use HSM as your destination, you must have a key vault that supports HS
139140
For more information about the service tiers and capabilities for Azure Key Vault, see the Azure Key Vault Pricing website (http://go.microsoft.com/fwlink/?linkid=512521).
140141

141142
This parameter is required when you create a new key.
142-
If you import a key by using the KeyFilePath parameter, this parameter is optional:
143+
If you import a key by using the *KeyFilePath* parameter, this parameter is optional:
143144

144-
-- If you do not specify this parameter, and this cmdlet imports a key that has .byok file name extension, it imports that key as an HSM-protected key.
145+
- If you do not specify this parameter, and this cmdlet imports a key that has .byok file name extension, it imports that key as an HSM-protected key.
145146
The cmdlet cannot import that key as software-protected key.
146147

147-
-- If you do not specify this parameter, and this cmdlet imports a key that has a .pfx file name extension, it imports the key as a software-protected key.
148+
- If you do not specify this parameter, and this cmdlet imports a key that has a .pfx file name extension, it imports the key as a software-protected key.
148149

149150
```yaml
150151
Type: String
@@ -190,10 +191,10 @@ Accept wildcard characters: False
190191
```
191192
192193
### -Expires
193-
Specifies the expiration time, as a DateTime object, for the key that this cmdlet adds.
194+
Specifies the expiration time, as a **DateTime** object, for the key that this cmdlet adds.
194195
This parameter uses Coordinated Universal Time (UTC).
195-
To obtain a DateTime object, use the Get-Date cmdlet.
196-
For more information, type Get-Help Get-Date.
196+
To obtain a **DateTime** object, use the **Get-Date** cmdlet.
197+
For more information, type `Get-Help Get-Date`.
197198
If you do not specify this parameter, the key does not expire.
198199

199200
```yaml
@@ -209,9 +210,9 @@ Accept wildcard characters: False
209210
```
210211

211212
### -KeyFilePassword
212-
Specifies a password for the imported file as a SecureString object.
213-
To obtain a SecureString object, use the ConvertTo-SecureString cmdlet.
214-
For more information, type Get-Help ConvertTo-SecureString.
213+
Specifies a password for the imported file as a **SecureString** object.
214+
To obtain a **SecureString** object, use the **ConvertTo-SecureString** cmdlet.
215+
For more information, type `Get-Help ConvertTo-SecureString`.
215216
You must specify this password to import a file with a .pfx file name extension.
216217

217218
```yaml
@@ -230,12 +231,12 @@ Accept wildcard characters: False
230231
Specifies the path of a local file that contains key material that this cmdlet imports.
231232
The valid file name extensions are .byok and .pfx.
232233

233-
-- If the file is a .byok file, the key is automatically protected by HSMs after the import and you cannot override this default.
234+
- If the file is a .byok file, the key is automatically protected by HSMs after the import and you cannot override this default.
234235

235-
-- If the file is a .pfx file, the key is automatically protected by software after the import.
236-
To override this default, set the Destination parameter to HSM so that the key is HSM-protected.
236+
- If the file is a .pfx file, the key is automatically protected by software after the import.
237+
To override this default, set the *Destination* parameter to HSM so that the key is HSM-protected.
237238

238-
When you specify this parameter, the Destination parameter is optional.
239+
When you specify this parameter, the *Destination* parameter is optional.
239240

240241
```yaml
241242
Type: String
@@ -255,14 +256,14 @@ If you do not specify this parameter, all operations can be performed.
255256

256257
The acceptable values for this parameter are a comma-separated list of key operations as defined by the JSON Web Key (JWK) specification (http://go.microsoft.com/fwlink/?LinkID=613300&clcid=0x409):
257258

258-
-- Encrypt
259-
-- Decrypt
260-
-- Wrap
261-
-- Unwrap
262-
-- Sign
263-
-- Verify
264-
-- Backup
265-
-- Restore
259+
- Encrypt
260+
- Decrypt
261+
- Wrap
262+
- Unwrap
263+
- Sign
264+
- Verify
265+
- Backup
266+
- Restore
266267

267268
```yaml
268269
Type: String[]
@@ -294,9 +295,9 @@ Accept wildcard characters: False
294295
```
295296

296297
### -NotBefore
297-
Specifies the time, as a DateTime object, before which the key cannot be used.
298+
Specifies the time, as a **DateTime** object, before which the key cannot be used.
298299
This parameter uses UTC.
299-
To obtain a DateTime object, use the Get-Date cmdlet.
300+
To obtain a **DateTime** object, use the **Get-Date** cmdlet.
300301
If you do not specify this parameter, the key can be used immediately.
301302

302303
```yaml
@@ -343,7 +344,18 @@ Accept wildcard characters: False
343344
```
344345

345346
### -Tag
346-
A hashtable representing key tags.
347+
Specifies a hash table that contains certificate tags.
348+
349+
To use HSM as your destination, you must have a key vault that supports HSMs.
350+
For more information about the service tiers and capabilities for Azure Key Vault, see the Azure Key Vault Pricing website (http://go.microsoft.com/fwlink/?linkid=512521).
351+
352+
This parameter is required when you create a new key.
353+
If you import a key by using the *KeyFilePath* parameter, this parameter is optional:
354+
355+
- If you do not specify this parameter, and this cmdlet imports a key that has .byok file name extension, it imports that key as an HSM-protected key.
356+
The cmdlet cannot import that key as software-protected key.
357+
358+
- If you do not specify this parameter, and this cmdlet imports a key that has a .pfx file name extension, it imports the key as a software-protected key.
347359

348360
```yaml
349361
Type: Hashtable
@@ -388,11 +400,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
388400

389401
## RELATED LINKS
390402

391-
[Backup-AzureKeyVaultKey]()
403+
[Backup-AzureKeyVaultKey](./Backup-AzureKeyVaultKey.md)
392404

393-
[Get-AzureKeyVaultKey]()
405+
[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md)
394406

395-
[Remove-AzureKeyVaultKey]()
407+
[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md)
396408

397-
[Set-AzureKeyVaultKeyAttribute]()
409+
[Set-AzureKeyVaultKeyAttribute](./Set-AzureKeyVaultKeyAttribute.md)
398410

0 commit comments

Comments
 (0)