Skip to content

Commit 3f43365

Browse files
authored
refine help docs (#15597)
1 parent e9f9681 commit 3f43365

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

src/KeyVault/KeyVault/help/Add-AzKeyVaultKey.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,10 @@ backup of it that you can restore.
131131
```powershell
132132
PS C:\> Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITSoftware' -Destination 'Software'
133133
134-
Vault Name : contoso
134+
Vault/HSM Name : contoso
135135
Name : ITSoftware
136+
Key Type : RSA
137+
Key Size : 2048
136138
Version : 67da57e9cadf48a2ad8d366b115843ab
137139
Id : https://contoso.vault.azure.net:443/keys/ITSoftware/67da57e9cadf48a2ad8d366b115843ab
138140
Enabled : True
@@ -173,8 +175,10 @@ PS C:\> $NotBefore = (Get-Date).ToUniversalTime()
173175
PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = "true"}
174176
PS C:\> Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITHsmNonDefault' -Destination 'HSM' -Expires $Expires -NotBefore $NotBefore -KeyOps $KeyOperations -Disable -Tag $Tags
175177
176-
Vault Name : contoso
178+
Vault/HSM Name : contoso
177179
Name : ITHsmNonDefault
180+
Key Type : RSA
181+
Key Size : 2048
178182
Version : 929bfc14db84439b823ffd1bedadaf5f
179183
Id : https://contoso.vault.azure.net:443/keys/ITHsmNonDefault/929bfc14db84439b823ffd1bedadaf5f
180184
Enabled : False

src/KeyVault/KeyVault/help/Get-AzKeyVaultKey.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ schema: 2.0.0
99
# Get-AzKeyVaultKey
1010

1111
## SYNOPSIS
12-
Gets Key Vault keys.
12+
Gets Key Vault keys. Please notes that detailed information about a key, like key type or key size, only available when querying a key in a certain version.
1313

1414
## SYNTAX
1515

@@ -131,7 +131,7 @@ This cmdlet gets a specific **Microsoft.Azure.Commands.KeyVault.Models.KeyBundle
131131
```powershell
132132
PS C:\> Get-AzKeyVaultKey -VaultName 'contoso'
133133
134-
Vault Name : contoso
134+
Vault/HSM Name : contoso
135135
Name : test1
136136
Version :
137137
Id : https://contoso.vault.azure.net:443/keys/test1
@@ -162,8 +162,10 @@ This command gets all the keys in the key vault named Contoso.
162162
```powershell
163163
PS C:\> Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1'
164164
165-
Vault Name : contoso
165+
Vault/HSM Name : contoso
166166
Name : test1
167+
Key Type : RSA
168+
Key Size : 2048
167169
Version : 7fe415d5518240c1a6fce89986b8d334
168170
Id : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
169171
Enabled : True
@@ -181,7 +183,7 @@ This command gets the current version of the key named test1 in the key vault na
181183
```powershell
182184
PS C:\> Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -IncludeVersions
183185
184-
Vault Name : contoso
186+
Vault/HSM Name : contoso
185187
Name : test1
186188
Version : 7fe415d5518240c1a6fce89986b8d334
187189
Id : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
@@ -193,7 +195,7 @@ Updated : 5/24/2018 6:08:13 PM
193195
Purge Disabled : False
194196
Tags :
195197
196-
Vault Name : contoso
198+
Vault/HSM Name : contoso
197199
Name : test1
198200
Version : e4e95940e669407fbdb4298bc21a3e1d
199201
Id : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d
@@ -212,8 +214,10 @@ This command gets all versions the key named ITPfx in the key vault named Contos
212214
```powershell
213215
PS C:\> Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -Version 'e4e95940e669407fbdb4298bc21a3e1d'
214216
215-
Vault Name : contoso
217+
Vault/HSM Name : contoso
216218
Name : test1
219+
Key Type : RSA
220+
Key Size : 2048
217221
Version : e4e95940e669407fbdb4298bc21a3e1d
218222
Id : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d
219223
Enabled : False
@@ -231,8 +235,7 @@ After running this command, you can inspect various properties of the key by nav
231235
### Example 5: Get all the keys that have been deleted but not purged for this key vault
232236
```powershell
233237
PS C:\> Get-AzKeyVaultKey -VaultName 'contoso' -InRemovedState
234-
235-
Vault Name : contoso
238+
Vault/HSM Name : contoso
236239
Name : test3
237240
Id : https://contoso.vault.azure.net:443/keys/test3
238241
Deleted Date : 5/24/2018 8:32:42 PM
@@ -252,7 +255,7 @@ This command gets all the keys that have been previously deleted, but not purged
252255
```powershell
253256
PS C:\> Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test3' -InRemovedState
254257
255-
Vault Name : contoso
258+
Vault/HSM Name : contoso
256259
Name : test3
257260
Id : https://contoso.vault.azure.net:443/keys/test3/1af807cc331a49d0b52b7c75e1b2366e
258261
Deleted Date : 5/24/2018 8:32:42 PM
@@ -273,7 +276,7 @@ This command will return metadata such as the deletion date, and the scheduled p
273276
```powershell
274277
PS C:\> Get-AzKeyVaultKey -VaultName 'contoso' -KeyName "test*"
275278
276-
Vault Name : contoso
279+
Vault/HSM Name : contoso
277280
Name : test1
278281
Version :
279282
Id : https://contoso.vault.azure.net:443/keys/test1
@@ -285,7 +288,7 @@ Updated : 5/24/2018 6:08:13 PM
285288
Purge Disabled : False
286289
Tags :
287290
288-
Vault Name : contoso
291+
Vault/HSM Name : contoso
289292
Name : test2
290293
Version :
291294
Id : https://contoso.vault.azure.net:443/keys/test2

0 commit comments

Comments
 (0)