Add-AzKeyVaultKey

模組:: Az.KeyVault Module

在金鑰保存庫中建立金鑰，或將金鑰匯入金鑰保存庫。

語法

InteractiveCreate (預設值)

Add-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    -Destination <String>
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-Size <Int32>]
    [-KeyType <String>]
    [-CurveName <String>]
    [-Exportable]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-UseDefaultCVMPolicy]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InteractiveImport

Add-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    -KeyFilePath <String>
    [-KeyFilePassword <SecureString>]
    [-Destination <String>]
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-KeyType <String>]
    [-CurveName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmInteractiveCreate

Add-AzKeyVaultKey
    [-Name] <String>
    -HsmName <String>
    -KeyType <String>
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-Size <Int32>]
    [-CurveName <String>]
    [-Exportable]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-UseDefaultCVMPolicy]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmInteractiveImport

Add-AzKeyVaultKey
    [-Name] <String>
    -HsmName <String>
    -KeyFilePath <String>
    [-KeyFilePassword <SecureString>]
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectCreate

Add-AzKeyVaultKey
    [-InputObject] <PSKeyVault>
    [-Name] <String>
    -Destination <String>
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-Size <Int32>]
    [-KeyType <String>]
    [-CurveName <String>]
    [-Exportable]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-UseDefaultCVMPolicy]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectImport

Add-AzKeyVaultKey
    [-InputObject] <PSKeyVault>
    [-Name] <String>
    -KeyFilePath <String>
    [-KeyFilePassword <SecureString>]
    [-Destination <String>]
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-KeyType <String>]
    [-CurveName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmInputObjectCreate

Add-AzKeyVaultKey
    [-HsmObject] <PSManagedHsm>
    [-Name] <String>
    -KeyType <String>
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-Size <Int32>]
    [-CurveName <String>]
    [-Exportable]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-UseDefaultCVMPolicy]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmInputObjectImport

Add-AzKeyVaultKey
    [-HsmObject] <PSManagedHsm>
    [-Name] <String>
    -KeyFilePath <String>
    [-KeyFilePassword <SecureString>]
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceIdCreate

Add-AzKeyVaultKey
    [-ResourceId] <String>
    [-Name] <String>
    -Destination <String>
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-Size <Int32>]
    [-KeyType <String>]
    [-CurveName <String>]
    [-Exportable]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-UseDefaultCVMPolicy]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceIdImport

Add-AzKeyVaultKey
    [-ResourceId] <String>
    [-Name] <String>
    -KeyFilePath <String>
    [-KeyFilePassword <SecureString>]
    [-Destination <String>]
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-KeyType <String>]
    [-CurveName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmResourceIdCreate

Add-AzKeyVaultKey
    [-Name] <String>
    -HsmResourceId <String>
    -KeyType <String>
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-Size <Int32>]
    [-CurveName <String>]
    [-Exportable]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-UseDefaultCVMPolicy]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmResourceIdImport

Add-AzKeyVaultKey
    [-Name] <String>
    -HsmResourceId <String>
    -KeyFilePath <String>
    [-KeyFilePassword <SecureString>]
    [-Disable]
    [-KeyOps <String[]>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-Tag <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Add-AzKeyVaultKey Cmdlet 會在 Azure 金鑰保存庫的金鑰保存庫中建立金鑰，或將金鑰匯入金鑰保存庫。使用此 Cmdlet ，使用下列任一方法來新增金鑰：

在 Key Vault 服務的硬體安全性模組（HSM）中建立金鑰。
在 Key Vault 服務的軟體中建立金鑰。
將金鑰從您自己的硬體安全性模組（HSM）匯入金鑰保存庫服務中的 HSM。
從電腦上的 .pfx 檔案匯入金鑰。
將金鑰從電腦上的 .pfx 檔案匯入 Key Vault 服務中的硬體安全性模組（HSM）。對於任何這些作業，您可以提供索引鍵屬性或接受預設設定。如果您建立或匯入與金鑰保存庫中現有金鑰同名的金鑰，原始金鑰會更新為您為新金鑰指定的值。您可以使用該版本索引鍵的版本特定 URI 來存取先前的值。若要瞭解金鑰版本和 URI 結構，請參閱金鑰保存庫 REST API 檔中的關於金鑰和秘密。附註：若要從您自己的硬體安全性模組匯入金鑰，您必須先使用 Azure 金鑰保存庫 BYOK 工具集產生 BYOK 套件（副檔名為 .byok 的檔案）。如需詳細資訊，請參閱如何產生和傳輸 Azure 金鑰保存庫的 HSM-Protected 金鑰。最佳做法是在建立或更新金鑰之後，使用 Backup-AzKeyVaultKey Cmdlet 來備份金鑰。沒有取消刪除功能，因此如果您不小心刪除了金鑰或刪除了金鑰然後改變主意，則該金鑰將無法恢復，除非您有可以恢復的金鑰備份。

範例

範例 1：建立金鑰

Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITSoftware' -Destination 'Software'

Vault/HSM Name : contoso
Name           : ITSoftware
Key Type       : RSA
Key Size       : 2048
Curve Name     :
Version        : 67da57e9cadf48a2ad8d366b115843ab
Id             : https://contoso.vault.azure.net:443/keys/ITSoftware/67da57e9cadf48a2ad8d366b115843ab
Enabled        : True
Expires        :
Not Before     :
Created        : 5/21/2018 11:10:58 PM
Updated        : 5/21/2018 11:10:58 PM
Purge Disabled : False
Tags           :

此命令會在名為 Contoso 的金鑰保存庫中建立名為 ITSoftware 的軟體保護金鑰。

範例 2：建立 EC 金鑰

Add-AzKeyVaultKey -VaultName test-kv -Name test-key -Destination Software -KeyType EC

Vault/HSM Name : test-kv
Name           : test-key
Key Type       : EC
Key Size       :
Curve Name     : P-256
Version        : 4da74af2b4fd47d6b1aa0b05c9a2ed13
Id             : https://test-kv.vault.azure.net:443/keys/test-key/4da74af2b4fd47d6b1aa0b05c9a2ed13
Enabled        : True
Expires        :
Not Before     :
Created        : 8/24/2021 6:38:34 AM
Updated        : 8/24/2021 6:38:34 AM
Recovery Level : Recoverable+Purgeable
Tags           :

此命令會在名為 test-kv 的金鑰保存庫中建立名為 test-key 的受軟體保護的 EC 金鑰。預設情況下，其曲線名稱為 P-256。

範例 3：建立受 HSM 保護的金鑰

Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITHsm' -Destination 'HSM'

Vault Name     : contoso
Name           : ITHsm
Version        : 67da57e9cadf48a2ad8d366b115843ab
Id             : https://contoso.vault.azure.net:443/keys/ITSoftware/67da57e9cadf48a2ad8d366b115843ab
Enabled        : True
Expires        :
Not Before     :
Created        : 5/21/2018 11:10:58 PM
Updated        : 5/21/2018 11:10:58 PM
Purge Disabled : False
Tags           :

此命令會在名為 Contoso 的金鑰保存庫中建立受 HSM 保護的金鑰。

範例 4：建立具有非預設值的索引鍵

$KeyOperations = 'decrypt', 'verify'
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$NotBefore = (Get-Date).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = "true"}
Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITHsmNonDefault' -Destination 'HSM' -Expires $Expires -NotBefore $NotBefore -KeyOps $KeyOperations -Disable -Tag $Tags

Vault/HSM Name : contoso
Name           : ITHsmNonDefault
Key Type       : RSA
Key Size       : 2048
Version        : 929bfc14db84439b823ffd1bedadaf5f
Id             : https://contoso.vault.azure.net:443/keys/ITHsmNonDefault/929bfc14db84439b823ffd1bedadaf5f
Enabled        : False
Expires        : 5/21/2020 11:12:43 PM
Not Before     : 5/21/2018 11:12:50 PM
Created        : 5/21/2018 11:13:17 PM
Updated        : 5/21/2018 11:13:17 PM
Purge Disabled : False
Tags           : Name        Value
                 Severity    high
                 Accounting  true

第一個命令將值解密和驗證儲存在$KeyOperations變數中。第二個命令會使用 Get-Date Cmdlet 建立以 UTC 定義的 DateTime 物件。該物件指定未來兩年的時間。此指令會將該日期儲存在$Expires變數中。如需詳細資訊，請鍵入 Get-Help Get-Date。第三個命令會使用 Get-Date Cmdlet 建立 DateTime 物件。該物件會指定目前的 UTC 時間。此指令會將該日期儲存在 $NotBefore 變數中。最後一個命令會建立名為 ITHsmNonDefault 的金鑰，這是受 HSM 保護的金鑰。此指令會指定儲存$KeyOperations的容許索引鍵作業值。此命令會指定在先前命令中建立的 Expires 和 NotBefore 參數的時間，以及高嚴重性和 IT 的標籤。新金鑰已停用。您可以使用 Set-AzKeyVaultKey Cmdlet 來啟用它。

範例 5：匯入受 HSM 保護的金鑰

Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITByok' -KeyFilePath 'C:\Contoso\ITByok.byok' -Destination 'HSM'

Vault Name     : contoso
Name           : ITByok
Version        : 67da57e9cadf48a2ad8d366b115843ab
Id             : https://contoso.vault.azure.net:443/keys/ITByok/67da57e9cadf48a2ad8d366b115843ab
Enabled        : True
Expires        :
Not Before     :
Created        : 5/21/2018 11:10:58 PM
Updated        : 5/21/2018 11:10:58 PM
Purge Disabled : False
Tags           :

此命令會從 KeyFilePath 參數指定的位置匯入名為 ITByok 的索引鍵。匯入的金鑰是受 HSM 保護的金鑰。若要從您自己的硬體安全性模組匯入金鑰，您必須先使用 Azure 金鑰保存庫 BYOK 工具集產生 BYOK 套件（副檔名為 .byok 的檔案）。如需詳細資訊，請參閱如何產生和傳輸 Azure 金鑰保存庫的 HSM-Protected 金鑰。

範例 6：匯入受軟體保護的金鑰

$Password = ConvertTo-SecureString -String "****" -AsPlainText -Force
Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITPfx' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password

Vault Name     : contoso
Name           : ITPfx
Version        : 67da57e9cadf48a2ad8d366b115843ab
Id             : https://contoso.vault.azure.net:443/keys/ITPfx/67da57e9cadf48a2ad8d366b115843ab
Enabled        : True
Expires        :
Not Before     :
Created        : 5/21/2018 11:10:58 PM
Updated        : 5/21/2018 11:10:58 PM
Purge Disabled : False
Tags           :

第一個命令會使用 ConvertTo-SecureString Cmdlet 將字串轉換成安全字串，然後將該字串儲存在 $Password 變數中。如需詳細資訊，請鍵入 Get-Help ConvertTo-SecureString。第二個命令會在 Contoso 金鑰保存庫中建立軟體密碼。此指令會指定金鑰的位置，以及儲存在$Password中的密碼。

範例 7：匯入索引鍵並指派屬性

$Password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{ 'Severity' = 'high'; 'Accounting' = "true" }
Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITPfxToHSM' -Destination 'HSM' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password -Expires $Expires -Tag $Tags

Vault Name     : contoso
Name           : ITPfxToHSM
Version        : 929bfc14db84439b823ffd1bedadaf5f
Id             : https://contoso.vault.azure.net:443/keys/ITPfxToHSM/929bfc14db84439b823ffd1bedadaf5f
Enabled        : True
Expires        : 5/21/2020 11:12:43 PM
Not Before     :
Created        : 5/21/2018 11:13:17 PM
Updated        : 5/21/2018 11:13:17 PM
Purge Disabled : False
Tags           : Name        Value
                 Severity    high
                 Accounting  true

第一個命令會使用 ConvertTo-SecureString Cmdlet 將字串轉換成安全字串，然後將該字串儲存在 $Password 變數中。第二個命令會使用 Get-Date Cmdlet 建立 DateTime 物件，然後將該物件儲存在 $Expires 變數中。第三個命令會建立$tags變數，以設定高嚴重性和 IT 的標籤。最後一個命令會從指定位置匯入金鑰作為 HSM 金鑰。此指令會指定儲存在$Expires中的到期時間，以及儲存在$Password中的密碼，並套用儲存在$tags中的標籤。

範例 8：產生「自備金鑰」（BYOK）功能的金鑰交換金鑰（KEK）

$key = Add-AzKeyVaultKey -VaultName $vaultName -Name $keyName -Destination HSM -Size 2048 -KeyOps "import"

產生金鑰（稱為金鑰交換金鑰（KEK））。 KEK 必須是只有匯入金鑰作業的 RSA-HSM 金鑰。只有 Key Vault 進階 SKU 支援 RSA-HSM 金鑰。更多詳情請參閱 https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys

範例 9：在受管 hsm 中建立安全金鑰

<# release_policy_template.json
{
  "anyOf": [
    {
      "allOf": [
        {
          "claim": "<claim name>",
          "equals": "<value to match>"
        }
      ],
      "authority": "<issuer>"
    }
  ],
  "version": "1.0.0"
}
#>
Add-AzKeyVaultKey -HsmName testmhsm -Name test-key -KeyType RSA -Exportable -ReleasePolicyPath release_policy.json

Vault/HSM Name : testmhsm
Name           : test-key
Key Type       : RSA
Key Size       : 2048
Curve Name     :
Version        : ed6b026bf0a605042006635713d33ef6
Id             : https://testmhsm.managedhsm.azure.net:443/keys/test-key/ed6b026bf0a605042006635713d33ef6
Enabled        : True
Expires        :
Not Before     :
Created        : 6/2/2022 7:14:37 AM
Updated        : 6/2/2022 7:14:37 AM
Recovery Level : Recoverable+Purgeable
Release Policy :
                 Content Type   : application/json; charset=utf-8
                 Policy Content : {"anyOf":[{"allOf":[{"claim":"x-ms-sgx-is-debuggable","equals":"true"}],"authority":"htt
                 ps://sharedeus.eus.attest.azure.net/"}],"version":"1.0.0"}
                 Immutable      : False


Tags           :

在名為 testmhsm 的受控 hsm 中建立安全金鑰。其名稱為 test-key，類型為 RSA。

範例 10：將機密 VM 的金鑰新增至金鑰保存庫。

New-AzKeyVault -Name $keyVaultName -Location $location -ResourceGroupName $resourceGroupName -Sku Premium -EnablePurgeProtection -EnabledForDiskEncryption;
$cvmAgent = Get-AzADServicePrincipal -ApplicationId '00001111-aaaa-2222-bbbb-3333cccc4444';
Set-AzKeyVaultAccessPolicy -VaultName $keyVaultName -ResourceGroupName $resourceGroupName -ObjectId $cvmAgent.id -PermissionsToKeys get,release;

$keySize = 3072;
Add-AzKeyVaultKey -VaultName $keyVaultName -Name $keyName -Size $keySize -KeyOps wrapKey,unwrapKey -KeyType RSA -Destination HSM -Exportable -UseDefaultCVMPolicy;

Vault/HSM Name : <Vault Name>
Name           : <Key Name>
Key Type       : RSA
Key Size       : 3072
Curve Name     :
Version        : <Version>
Id             : <Id>
Enabled        : True
Expires        :
Not Before     :
Created        : 9/9/2022 8:36:00 PM
Updated        : 9/9/2022 8:36:00 PM
Recovery Level : Recoverable
Release Policy :
                 Content Type   : application/json; charset=utf-8
                 Policy Content : <Policy Content>
                 Immutable      : False
Tags           :

參數

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	參見

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CurveName

指定橢圓曲線加密的曲線名稱，當 KeyType 為 EC 時，此值有效。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InteractiveImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-DefaultProfile

用來與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶

參數屬性

類型:	IAzureContextContainer
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	AzContext, AzureRmContext, AzureCredential

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Destination

指定是否要將金鑰新增為軟體保護的金鑰，或 Key Vault 服務中的 HSM 保護金鑰。有效值為：HSM 和 Software。附註：若要使用 HSM 作為目的地，您必須擁有支援 HSM 的金鑰保存庫。如需 Azure 金鑰保存庫服務層級和功能的詳細資訊，請參閱 Azure 金鑰保存庫定價網站。當您建立新索引鍵時，此參數是必需的。如果您使用 KeyFilePath 參數匯入索引鍵，則此參數是選擇性的：

如果您未指定此參數，且此 Cmdlet 匯入副檔名為 .byok 的金鑰，則會將該金鑰匯入為受 HSM 保護的金鑰。 Cmdlet 無法將該金鑰匯入為受軟體保護的金鑰。
如果您未指定此參數，且此 Cmdlet 會匯入副檔名為 .pfx 的金鑰，則會將金鑰匯入為受軟體保護的金鑰。

參數屬性

類型:	String
預設值:	None
接受的值:	HSM, Software
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectCreate

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdCreate

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Disable

表示您要新增的金鑰已設定為停用的初始狀態。任何使用金鑰的嘗試都會失敗。如果您要預先載入想要稍後啟用的索引鍵，請使用此參數。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Expires

針對此 Cmdlet 新增的索引鍵，指定索引鍵的到期時間（ 以 UTC 形式作為 DateTime 物件）。如果未指定，金鑰將不會過期。若要取得 DateTime 物件，請使用 Get-Date Cmdlet。如需詳細資訊，請鍵入 Get-Help Get-Date。請注意，BYOK程式中使用的金鑰交換金鑰會忽略過期。

參數屬性

類型:	Nullable<T>[DateTime]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Exportable

指出是否可以匯出私鑰。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-HsmName

HSM 名稱。 Cmdlet 會根據名稱和目前選取的環境來建構受控 HSM 的 FQDN。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

HsmInteractiveCreate

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveImport

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-HsmObject

HSM 物件。

參數屬性

類型:	PSManagedHsm
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

HsmInputObjectCreate

Position:	0
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectImport

Position:	0
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-HsmResourceId

HSM 的資源識別碼。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

HsmResourceIdCreate

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

HsmResourceIdImport

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Immutable

將發行原則設定為不可變狀態。一旦標示為不可變，此旗標就無法重設，而且在任何情況下都無法變更原則。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-InputObject

Vault 物件。

參數屬性

類型:	PSKeyVault
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InputObjectCreate

Position:	0
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectImport

Position:	0
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-KeyFilePassword

將匯入檔案的密碼指定為 SecureString 物件。若要取得 SecureString 物件，請使用 ConvertTo-SecureString Cmdlet。如需詳細資訊，請鍵入 Get-Help ConvertTo-SecureString。您必須指定此密碼，才能匯入副檔名為 .pfx 的檔案。

參數屬性

類型:	SecureString
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmResourceIdImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-KeyFilePath

指定包含此 Cmdlet 匯入之金鑰資料的本機檔案路徑。有效的副檔名是 .byok 和 .pfx。

如果檔案是 .byok 檔案，則金鑰會在匯入後自動受到 HSM 的保護，而且您無法覆寫此預設值。
如果檔案是 .pfx 檔案，則金鑰會在匯入後由軟體自動保護。若要覆寫此預設值，請將 Destination 參數設定為 HSM，讓金鑰受 HSM 保護。當您指定此參數時， 目的地 參數是選用的。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveImport

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveImport

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectImport

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectImport

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdImport

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmResourceIdImport

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-KeyOps

指定可以使用此 Cmdlet 新增的索引鍵來執行的作業陣列。如果未指定此參數，則可以執行所有作業。此參數的可接受值是 JSON Web 金鑰（JWK）規格所定義的索引鍵作業的逗號分隔清單：

加密
解密
包裝密鑰 (wrapKey)
unwrapKey
標誌
verify
import （僅適用於 KEK，請參閱範例 7）

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-KeyType

指定此索引鍵的索引鍵類型。匯入 BYOK 金鑰時，預設為「RSA」。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InteractiveImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdImport

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Name

指定要新增至金鑰保存庫的金鑰名稱。此 Cmdlet 會根據此參數指定的名稱、金鑰保存庫的名稱，以及您目前的環境，建構金鑰的完整網域名稱（FQDN）。名稱必須是長度為 1 到 63 個字元的字串，且僅包含 0-9、a-z、A-Z 和 - （破折號符號）。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	鍵名

參數集

(All)

Position:	1
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-NotBefore

指定時間做為 DateTime 物件，在此之前無法使用索引鍵。此參數使用 UTC。若要取得 DateTime 物件，請使用 Get-Date Cmdlet。如果您未指定此參數，則可以立即使用索引鍵。

參數屬性

類型:	Nullable<T>[DateTime]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ReleasePolicyPath

包含 JSON 原則定義之檔案的路徑。可匯出金鑰的原則規則。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ResourceId

保存庫資源 ID。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ResourceIdCreate

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ResourceIdImport

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Size

RSA 金鑰大小（以位為單位）。如果未指定，服務會提供安全的預設值。

參數屬性

類型:	Nullable<T>[Int32]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Tag

雜湊表形式的鍵值對。例如：@{key0=“value0”;key1=$null;key2=“值2”}

參數屬性

類型:	Hashtable
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	Tags

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-UseDefaultCVMPolicy

指定使用預設原則、根據該原則可匯出金鑰以進行 CVM 磁碟加密。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInteractiveCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmInputObjectCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

ResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

HsmResourceIdCreate

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-VaultName

指定此 Cmdlet 新增金鑰的金鑰保存庫名稱。此 Cmdlet 會根據此參數指定的名稱和您目前的環境來建構金鑰保存庫的 FQDN。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

InteractiveCreate

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

InteractiveImport

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。指令未執行。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	威斯康辛

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。如需詳細資訊，請參閱 about_CommonParameters。

輸出

PSKeyVaultKey

意見反應

此頁面對您有幫助嗎？

共用方式為

Add-AzKeyVaultKey

語法

InteractiveCreate (預設值)

InteractiveImport

HsmInteractiveCreate

HsmInteractiveImport

InputObjectCreate

InputObjectImport

HsmInputObjectCreate

HsmInputObjectImport

ResourceIdCreate

ResourceIdImport

HsmResourceIdCreate

HsmResourceIdImport

Description

範例

範例 1：建立金鑰

範例 2：建立 EC 金鑰

範例 3：建立受 HSM 保護的金鑰

範例 4：建立具有非預設值的索引鍵

範例 5：匯入受 HSM 保護的金鑰

範例 6：匯入受軟體保護的金鑰

範例 7：匯入索引鍵並指派屬性

範例 8：產生「自備金鑰」（BYOK） 功能的金鑰交換金鑰 （KEK）

範例 9：在受管 hsm 中建立安全金鑰

範例 10：將機密 VM 的金鑰新增至金鑰保存庫。

參數

-Confirm

參數屬性

參數集

-CurveName

參數屬性

參數集

-DefaultProfile

參數屬性

參數集

-Destination

參數屬性

參數集

-Disable

參數屬性

參數集

-Expires

參數屬性

參數集

-Exportable

參數屬性

參數集

-HsmName

參數屬性

參數集

-HsmObject

參數屬性

參數集

-HsmResourceId

參數屬性

參數集

-Immutable

參數屬性

參數集

-InputObject

參數屬性

參數集

-KeyFilePassword

參數屬性

參數集

-KeyFilePath

參數屬性

參數集

-KeyOps

參數屬性

參數集

-KeyType

參數屬性

參數集

-Name

參數屬性

參數集

-NotBefore

範例 8：產生「自備金鑰」（BYOK）功能的金鑰交換金鑰（KEK）