Aracılığıyla paylaş

Add-AzKeyVaultKey

  • Başvuru
Modül:
Az.KeyVault

Anahtar kasasında bir anahtar oluşturur veya anahtarı anahtar kasasına aktarır.

Sözdizimi

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>]
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>]
Add-AzKeyVaultKey
   -HsmName <String>
   [-Name] <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>]
Add-AzKeyVaultKey
   -HsmName <String>
   [-Name] <String>
   -KeyFilePath <String>
   [-KeyFilePassword <SecureString>]
   [-Disable]
   [-KeyOps <String[]>]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
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>]
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>]
Add-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [-Name] <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>]
Add-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [-Name] <String>
   -KeyFilePath <String>
   [-KeyFilePassword <SecureString>]
   [-Disable]
   [-KeyOps <String[]>]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
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>]
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>]
Add-AzKeyVaultKey
   -HsmResourceId <String>
   [-Name] <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>]
Add-AzKeyVaultKey
   -HsmResourceId <String>
   [-Name] <String>
   -KeyFilePath <String>
   [-KeyFilePassword <SecureString>]
   [-Disable]
   [-KeyOps <String[]>]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Add-AzKeyVaultKey cmdlet'i, Azure Key Vault'taki bir anahtar kasasında bir anahtar oluşturur veya bir anahtarı anahtar kasasına aktarır. Aşağıdaki yöntemlerden herhangi birini kullanarak anahtar eklemek için bu cmdlet'i kullanın:

  • Key Vault hizmetinde bir donanım güvenlik modülünde (HSM) anahtar oluşturun.
  • Key Vault hizmetinde yazılımda bir anahtar oluşturun.
  • Anahtarı kendi donanım güvenlik modülünüzden (HSM) Key Vault hizmetindeki HSM'lere aktarın.
  • Bilgisayarınızdaki bir .pfx dosyasından anahtarı içeri aktar.
  • Anahtarı bilgisayarınızdaki bir .pfx dosyasından Key Vault hizmetindeki donanım güvenlik modüllerine (HSM) aktarın. Bu işlemlerden herhangi biri için anahtar öznitelikleri sağlayabilir veya varsayılan ayarları kabul edebilirsiniz. Anahtar kasanızda mevcut bir anahtarla aynı ada sahip bir anahtar oluşturur veya içeri aktarırsanız, özgün anahtar yeni anahtar için belirttiğiniz değerlerle güncelleştirilir. Anahtarın bu sürümü için sürüme özgü URI'yi kullanarak önceki değerlere erişebilirsiniz. Anahtar sürümleri ve URI yapısı hakkında bilgi edinmek için Key Vault REST API belgelerindeki Anahtarlar ve Gizli Diziler Hakkında bölümüne bakın. Not: Kendi donanım güvenlik modülünüzden bir anahtarı içeri aktarmak için önce Azure Key Vault BYOK araç takımını kullanarak bir BYOK paketi (.byok dosya adı uzantısına sahip bir dosya) oluşturmanız gerekir. Daha fazla bilgi için bkz . Azure Key Vault için HSM Korumalı Anahtarlar Oluşturma ve Aktarma. En iyi yöntem olarak, Backup-AzKeyVaultKey cmdlet'ini kullanarak anahtarınızı oluşturulduktan veya güncelleştirildikten sonra yedekleyin. Geri döndürülmeyen bir işlev olmadığından, anahtarınızı yanlışlıkla silerseniz veya silerseniz ve sonra fikrinizi değiştirirseniz, geri yükleyebileceğiniz bir yedeğiniz olmadığı sürece anahtar kurtarılamaz.

Örnekler

Örnek 1: Anahtar oluşturma

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           :

Bu komut, Contoso adlı anahtar kasasında ITSoftware adlı yazılım korumalı bir anahtar oluşturur.

Örnek 2: EC anahtarı oluşturma

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           :

Bu komut, test-kv adlı anahtar kasasında test-key adlı yazılım korumalı bir EC anahtarı oluşturur. Eğri adı varsayılan olarak P-256'dır.

Örnek 3: HSM korumalı anahtar oluşturma

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           :

Bu komut, contoso adlı anahtar kasasında HSM korumalı bir anahtar oluşturur.

Örnek 4: Varsayılan olmayan değerlerle anahtar oluşturma

$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

İlk komut, değerlerin şifresini çözer ve $KeyOperations değişkeninde doğrular. İkinci komut Get-Date cmdlet'ini kullanarak UTC ile tanımlanan bir DateTime nesnesi oluşturur. Bu nesne, gelecekte iki yıl süre belirtir. Komut bu tarihi $Expires değişkeninde depolar. Daha fazla bilgi için yazın Get-Help Get-Date. Üçüncü komut Get-Date cmdlet'ini kullanarak bir DateTime nesnesi oluşturur. Bu nesne geçerli UTC saatini belirtir. Komut bu tarihi $NotBefore değişkeninde depolar. Son komut, HSM korumalı bir anahtar olan ITHsmNonDefault adlı bir anahtar oluşturur. komutu, $KeyOperations depolanan izin verilen anahtar işlemleri için değerleri belirtir. komutu, önceki komutlarda oluşturulan Expires ve NotBefore parametrelerinin zamanlarını, yüksek önem derecesi ve BT için etiketleri belirtir. Yeni anahtar devre dışı bırakıldı. Set-AzKeyVaultKey cmdlet'ini kullanarak etkinleştirebilirsiniz.

Örnek 5: HSM korumalı anahtarı içeri aktarma

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           :

Bu komut, KeyFilePath parametresinin belirttiği konumdan ITByok adlı anahtarı içeri aktarır. İçeri aktarılan anahtar, HSM korumalı bir anahtardır. Kendi donanım güvenlik modülünüzden bir anahtarı içeri aktarmak için önce Azure Key Vault BYOK araç takımını kullanarak bir BYOK paketi (.byok dosya adı uzantısına sahip bir dosya) oluşturmanız gerekir. Daha fazla bilgi için bkz . Azure Key Vault için HSM Korumalı Anahtarlar Oluşturma ve Aktarma.

Örnek 6: Yazılım korumalı anahtarı içeri aktarma

$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           :

İlk komut ConvertTo-SecureString cmdlet'ini kullanarak bir dizeyi güvenli bir dizeye dönüştürür ve ardından bu dizeyi $Password değişkeninde depolar. Daha fazla bilgi için yazın Get-Help ConvertTo-SecureString. İkinci komut Contoso anahtar kasasında bir yazılım parolası oluşturur. komutu, anahtarın konumunu ve $Password depolanan parolayı belirtir.

Örnek 7: Anahtarı içeri aktarma ve öznitelik atama

$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

İlk komut ConvertTo-SecureString cmdlet'ini kullanarak bir dizeyi güvenli bir dizeye dönüştürür ve ardından bu dizeyi $Password değişkeninde depolar. İkinci komut Get-Date cmdlet'ini kullanarak bir DateTime nesnesi oluşturur ve bu nesneyi $Expires değişkeninde depolar. Üçüncü komut, yüksek önem derecesine ve BT'ye yönelik etiketleri ayarlamak için $tags değişkenini oluşturur. Son komut, belirtilen konumdan bir anahtarı HSM anahtarı olarak içeri aktarır. komutu, $Expires depolanan süre sonunu ve $Password depolanan parolayı belirtir ve $tags depolanan etiketleri uygular.

Örnek 8: "Kendi anahtarını getir" (BYOK) özelliği için Anahtar Değişim Anahtarı (KEK) oluşturma

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

Anahtar oluşturur (Anahtar Değişim Anahtarı (KEK) olarak adlandırılır). KEK, yalnızca içeri aktarma anahtarı işlemine sahip bir RSA-HSM anahtarı olmalıdır. Yalnızca Key Vault Premium SKU'su RSA-HSM anahtarlarını destekler. Daha fazla ayrıntı için bkz. https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys

Örnek 9: Yönetilen hsm'de güvenli anahtar oluşturma

<# 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           :

Yönetilen hsm'de testmhsm adlı bir güvenli anahtar oluşturun. Adı test anahtarı ve türü RSA'dır.

Örnek 10: Bir anahtar kasasına Gizli VM için anahtar ekleme.

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           :

Parametreler

-Confirm

Cmdlet'i çalıştırmadan önce sizden onay ister.

Tür:SwitchParameter
Diğer adlar:cf
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-CurveName

Eliptik eğri şifrelemesinin eğri adını belirtir; KeyType EC olduğunda bu değer geçerlidir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-DefaultProfile

Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik

Tür:IAzureContextContainer
Diğer adlar:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Destination

Anahtarın yazılım korumalı anahtar olarak mı yoksa Key Vault hizmetinde HSM korumalı anahtar olarak mı ekleneceğini belirtir. Geçerli değerler şunlardır: HSM ve Yazılım. Not: HSM'yi hedefiniz olarak kullanmak için HSM'leri destekleyen bir anahtar kasanız olmalıdır. Azure Key Vault hizmet katmanları ve özellikleri hakkında daha fazla bilgi için bkz . Azure Key Vault Fiyatlandırma web sitesi. Yeni bir anahtar oluşturduğunuzda bu parametre gereklidir. KeyFilePath parametresini kullanarak bir anahtarı içeri aktarırsanız, bu parametre isteğe bağlıdır:

  • Bu parametreyi belirtmezseniz ve bu cmdlet .byok dosya adı uzantısına sahip bir anahtarı içeri aktarırsa, bu anahtarı HSM korumalı anahtar olarak içeri aktarır. Cmdlet, bu anahtarı yazılım korumalı anahtar olarak içeri aktaramaz.
  • Bu parametreyi belirtmezseniz ve bu cmdlet .pfx dosya adı uzantısına sahip bir anahtarı içeri aktarırsa, anahtarı yazılım korumalı anahtar olarak içeri aktarır.
Tür:String
Kabul edilen değerler:HSM, Software, HSM, Software
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Disable

Eklediğiniz anahtarın ilk devre dışı durumuna ayarlandığını gösterir. Anahtarı kullanma girişimi başarısız olur. Daha sonra etkinleştirmeyi planladığınız anahtarları önceden yüklüyorsanız bu parametreyi kullanın.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Expires

Bu cmdlet'in eklediği anahtar için anahtarın utc olarak sona erme zamanını DateTime nesnesi olarak belirtir. Belirtilmezse anahtarın süresi dolmaz. DateTime nesnesi almak için Get-Date cmdlet'ini kullanın. Daha fazla bilgi için yazın Get-Help Get-Date. BYOK işleminde kullanılan Anahtar Değişim Anahtarı için süre sonunun yoksayıldığını lütfen unutmayın.

Tür:Nullable<T>[DateTime]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Exportable

Özel anahtarın dışarı aktarılıp aktarılamadığını gösterir.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-HsmName

HSM adı. Cmdlet, yönetilen bir HSM'nin FQDN'sini ada ve şu anda seçili ortama göre oluşturur.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-HsmObject

HSM nesnesi.

Tür:PSManagedHsm
Position:0
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-HsmResourceId

HSM'nin kaynak kimliği.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Immutable

Yayın ilkesini sabit durum olarak ayarlar. Sabit olarak işaretlendikten sonra bu bayrak sıfırlanamaz ve ilke hiçbir koşulda değiştirilemez.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-InputObject

Kasa nesnesi.

Tür:PSKeyVault
Position:0
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-KeyFilePassword

İçeri aktarılan dosyanın parolasını SecureString nesnesi olarak belirtir. SecureString nesnesi almak için ConvertTo-SecureString cmdlet'ini kullanın. Daha fazla bilgi için yazın Get-Help ConvertTo-SecureString. .pfx dosya adı uzantısına sahip bir dosyayı içeri aktarmak için bu parolayı belirtmeniz gerekir.

Tür:SecureString
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-KeyFilePath

Bu cmdlet'in içeri aktarıldığı anahtar malzemeyi içeren yerel dosyanın yolunu belirtir. Geçerli dosya adı uzantıları .byok ve .pfx'tir.

  • Dosya bir .byok dosyasıysa, içeri aktarma işleminden sonra anahtar HSM'ler tarafından otomatik olarak korunur ve bu varsayılanı geçersiz kılamazsınız.
  • Dosya bir .pfx dosyasıysa, içeri aktarma işleminden sonra anahtar yazılım tarafından otomatik olarak korunur. Bu varsayılanı geçersiz kılmak için, Anahtar HSM korumalı olacak şekilde Hedef parametresini HSM olarak ayarlayın. Bu parametreyi belirttiğinizde Hedef parametresi isteğe bağlıdır.
Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-KeyOps

Bu cmdlet'in eklediği anahtar kullanılarak gerçekleştirilebilecek bir işlem dizisi belirtir. Bu parametreyi belirtmezseniz, tüm işlemler gerçekleştirilebilir. Bu parametre için kabul edilebilir değerler, JSON Web Anahtarı (JWK) belirtimi tarafından tanımlanan anahtar işlemlerinin virgülle ayrılmış bir listesidir:

  • şifreleme
  • Şifre -sini çöz
  • wrapKey
  • unwrapKey
  • sign
  • verify
  • içeri aktarma (yalnızca KEK için bkz. örnek 7)
Tür:String[]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-KeyType

Bu anahtarın anahtar türünü belirtir. BYOK anahtarları içeri aktarılırken varsayılan olarak 'RSA' olur.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Name

Anahtar kasasına eklenecek anahtarın adını belirtir. Bu cmdlet, bu parametrenin belirttiği ada, anahtar kasasının adına ve geçerli ortamınıza göre bir anahtarın tam etki alanı adını (FQDN) oluşturur. Ad yalnızca 0-9, a-z, A-Z ve - (tire simgesi) içeren 1 ile 63 karakter uzunluğunda bir dize olmalıdır.

Tür:String
Diğer adlar:KeyName
Position:1
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-NotBefore

DateTime nesnesi olarak, anahtarın kullanılamayacağı saati belirtir. Bu parametre UTC kullanır. DateTime nesnesi almak için Get-Date cmdlet'ini kullanın. Bu parametreyi belirtmezseniz anahtar hemen kullanılabilir.

Tür:Nullable<T>[DateTime]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-ReleasePolicyPath

JSON ilke tanımını içeren bir dosyanın yolu. Anahtarın dışarı aktarılabildiği ilke kuralları.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-ResourceId

Kasa Kaynak Kimliği.

Tür:String
Position:0
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Size

Bit cinsinden RSA anahtar boyutu. Belirtilmezse, hizmet güvenli bir varsayılan değer sağlar.

Tür:Nullable<T>[Int32]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Tag

Karma tablo biçiminde anahtar-değer çiftleri. Örneğin: @{key0="value0"; key1=$null; key2="value2"}

Tür:Hashtable
Diğer adlar:Tags
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-UseDefaultCVMPolicy

CVM disk şifrelemesi için anahtarın dışarı aktarılabildiği varsayılan ilkenin kullanılacağını belirtir.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-VaultName

Bu cmdlet'in anahtarı eklediği anahtar kasasının adını belirtir. Bu cmdlet, bu parametrenin belirttiği ada ve geçerli ortamınıza göre bir anahtar kasasının FQDN'sini oluşturur.

Tür:String
Position:0
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-WhatIf

Cmdlet çalıştırılıyorsa ne olacağını gösterir. Cmdlet çalıştırılmaz.

Tür:SwitchParameter
Diğer adlar:wi
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

Girişler

PSKeyVault

PSManagedHsm

String

Çıkışlar

PSKeyVaultKey