Skip to content

Commit 998801f

Browse files
committed
Merge branch 'patch-63' of https://github.com/jackrichins/azure-docs-pr into mhsm-jrichins
2 parents b09ec7b + f3ed42a commit 998801f

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

articles/key-vault/keys/hsm-protected-keys-byok.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: azure-resource-manager
99
ms.service: key-vault
1010
ms.subservice: keys
1111
ms.topic: tutorial
12-
ms.date: 11/21/2022
12+
ms.date: 03/07/2023
1313
ms.author: mbaldwin
1414

1515
---
@@ -104,11 +104,22 @@ Use the [az keyvault key create](/cli/azure/keyvault/key#az-keyvault-key-create)
104104
```azurecli
105105
az keyvault key create --kty RSA-HSM --size 4096 --name KEKforBYOK --ops import --vault-name ContosoKeyVaultHSM
106106
```
107+
or in PowerShell
108+
109+
```azurepowershell
110+
Add-AzKeyVaultKey -VaultName 'ContosoKeyVaultHSM' -Name 'KEKforBYOK' -Destination 'HSM' -Size 4096 -KeyOps 'import'
111+
```
112+
107113
or for Managed HSM
108114

109115
```azurecli
110116
az keyvault key create --kty RSA-HSM --size 4096 --name KEKforBYOK --ops import --hsm-name ContosoKeyVaultHSM
111117
```
118+
or in PowerShell for Managed HSM
119+
120+
```azurepowershell
121+
Add-AzKeyVaultKey -HsmName 'ContosoKeyVaultHSM' -Name 'KEKforBYOK' -Destination 'HSM' -Size 4096 -KeyOps 'import'
122+
```
112123

113124
### Download the KEK public key
114125

@@ -117,13 +128,24 @@ Use [az keyvault key download](/cli/azure/keyvault/key#az-keyvault-key-download)
117128
```azurecli
118129
az keyvault key download --name KEKforBYOK --vault-name ContosoKeyVaultHSM --file KEKforBYOK.publickey.pem
119130
```
131+
or in PowerShell
132+
133+
```azurepowershell
134+
Get-AzKeyVaultKey -VaultName 'ContosoKeyVaultHSM' -KeyName 'KEKforBYOK' -OutFile 'KEKforBYOK.publickey.pem'
135+
```
120136

121137
or for Managed HSM
122138

123139
```azurecli
124140
az keyvault key download --name KEKforBYOK --hsm-name ContosoKeyVaultHSM --file KEKforBYOK.publickey.pem
125141
```
126142

143+
or in PowerShell for Managed HSM
144+
145+
```azurepowershell
146+
Get-AzKeyVaultKey -HsmName 'ContosoKeyVaultHSM' -KeyName 'KEKforBYOK' -OutFile 'KEKforBYOK.publickey.pem'
147+
```
148+
127149
Transfer the KEKforBYOK.publickey.pem file to your offline computer. You will need this file in the next step.
128150

129151
### Generate and prepare your key for transfer
@@ -147,16 +169,33 @@ To import an RSA key use following command. Parameter --kty is optional and defa
147169
az keyvault key import --vault-name ContosoKeyVaultHSM --name ContosoFirstHSMkey --byok-file KeyTransferPackage-ContosoFirstHSMkey.byok
148170
```
149171

172+
or in PowerShell
173+
174+
```azurepowershell
175+
Add-AzKeyVaultKey -VaultName 'ContosoKeyVaultHSM' -KeyName 'ContosoFirstHSMkey' -KeyFilePath 'KeyTransferPackage-ContosoFirstHSMkey.byok'
176+
```
177+
150178
or for Managed HSM
151179

152180
```azurecli
153181
az keyvault key import --hsm-name ContosoKeyVaultHSM --name ContosoFirstHSMkey --byok-file KeyTransferPackage-ContosoFirstHSMkey.byok
154182
```
183+
or in PowerShell for Managed HSM
184+
185+
```azurepowershell
186+
Add-AzKeyVaultKey -HsmName 'ContosoKeyVaultHSM' -KeyName 'ContosoFirstHSMkey' -KeyFilePath 'KeyTransferPackage-ContosoFirstHSMkey.byok'
187+
```
155188

156189
To import an EC key, you must specify key type and the curve name.
157190

158191
```azurecli
159-
az keyvault key import --vault-name ContosoKeyVaultHSM --name ContosoFirstHSMkey --byok-file --kty EC-HSM --curve-name "P-256" KeyTransferPackage-ContosoFirstHSMkey.byok
192+
az keyvault key import --vault-name ContosoKeyVaultHSM --name ContosoFirstHSMkey --kty EC-HSM --curve-name "P-256" --byok-file KeyTransferPackage-ContosoFirstHSMkey.byok
193+
```
194+
195+
or in PowerShell
196+
197+
```azurepowershell
198+
Add-AzKeyVaultKey -VaultName 'ContosoKeyVaultHSM' -KeyName 'ContosoFirstHSMkey' -KeyType EC -CurveName P-256 -KeyFilePath 'KeyTransferPackage-ContosoFirstHSMkey.byok'
160199
```
161200

162201
or for Managed HSM
@@ -165,6 +204,12 @@ or for Managed HSM
165204
az keyvault key import --hsm-name ContosoKeyVaultHSM --name ContosoFirstHSMkey --byok-file --kty EC-HSM --curve-name "P-256" KeyTransferPackage-ContosoFirstHSMkey.byok
166205
```
167206

207+
or in PowerShell for Managed HSM
208+
209+
```azurepowershell
210+
Add-AzKeyVaultKey -HsmName 'ContosoKeyVaultHSM' -KeyName 'ContosoFirstHSMkey' -KeyType EC -CurveName P-256 -KeyFilePath 'KeyTransferPackage-ContosoFirstHSMkey.byok'
211+
```
212+
168213
If the upload is successful, Azure CLI displays the properties of the imported key.
169214

170215
## Next steps

0 commit comments

Comments
 (0)