Megosztás a következőn keresztül:

Add-AzKeyVaultKey

  • Referencia
Modul:
Az.KeyVault

Létrehoz egy kulcsot egy kulcstartóban, vagy importál egy kulcsot egy kulcstartóba.

Syntax

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

Az Add-AzKeyVaultKey parancsmag létrehoz egy kulcsot egy kulcstartóban az Azure Key Vaultban, vagy importál egy kulcsot egy kulcstartóba. Ezzel a parancsmaggal adhat hozzá kulcsokat az alábbi módszerek bármelyikével:

  • Hozzon létre egy kulcsot egy hardveres biztonsági modulban (HSM) a Key Vault szolgáltatásban.
  • Hozzon létre egy kulcsot a szoftverben a Key Vault szolgáltatásban.
  • Importáljon egy kulcsot a saját hardveres biztonsági moduljából (HSM) a Key Vault szolgáltatás HSM-jeibe.
  • Importáljon egy kulcsot egy .pfx fájlból a számítógépen.
  • Importáljon egy kulcsot a számítógépen található .pfx fájlból a Key Vault szolgáltatás hardveres biztonsági moduljaiba (HSM-ek). Ezen műveletek bármelyikéhez megadhat kulcsattribútumokat, vagy elfogadhatja az alapértelmezett beállításokat. Ha olyan kulcsot hoz létre vagy importál, amelynek neve megegyezik a kulcstartóban lévő meglévő kulccsal, az eredeti kulcs frissül az új kulcshoz megadott értékekkel. Az előző értékeket a kulcs adott verziójához tartozó verzióspecifikus URI használatával érheti el. A kulcsverziók és az URI-struktúra megismeréséhez tekintse meg a Key Vault REST API dokumentációjának Kulcsok és titkos kulcsok című témakörét. Megjegyzés: Ha saját hardveres biztonsági modulból szeretne kulcsot importálni, először létre kell hoznia egy BYOK-csomagot (egy .byok fájlnévkiterjesztéssel rendelkező fájlt) az Azure Key Vault BYOK-eszközkészletével. További információ: HSM által védett kulcsok létrehozása és átvitele az Azure Key Vaulthoz. Ajánlott eljárásként készítsen biztonsági másolatot a kulcsról a létrehozása vagy frissítése után a Backup-AzKeyVaultKey parancsmag használatával. Nincs nem használható funkció, ezért ha véletlenül törli vagy törli a kulcsot, majd meggondolja magát, a kulcs csak akkor állítható helyre, ha biztonsági másolatot készít róla, amelyet visszaállíthat.

Példák

1. példa: Kulcs létrehozása

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           :

Ez a parancs létrehoz egy ITSoftware nevű szoftver által védett kulcsot a Contoso nevű kulcstartóban.

2. példa: EC-kulcs létrehozása

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           :

Ez a parancs létrehoz egy test-kv nevű, szoftver által védett EC-kulcsot a test-kv nevű kulcstartóban. A görbe neve alapértelmezés szerint P-256.

3. példa: HSM által védett kulcs létrehozása

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           :

Ez a parancs létrehoz egy HSM által védett kulcsot a Contoso nevű kulcstartóban.

4. példa: Kulcs létrehozása nem alapértelmezett értékekkel

$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

Az első parancs tárolja a visszafejtési és ellenőrzési értékeket a $KeyOperations változóban. A második parancs létrehoz egy UTC-ben definiált DateTime-objektumot a Get-Date parancsmag használatával. Ez az objektum két évet határoz meg a jövőben. A parancs a dátumot a $Expires változóban tárolja. További információkért írja be a következőt Get-Help Get-Date: A harmadik parancs létrehoz egy DateTime-objektumot a Get-Date parancsmag használatával. Ez az objektum az aktuális UTC-időt adja meg. A parancs a dátumot a $NotBefore változóban tárolja. Az utolsó parancs létrehoz egy ITHsmNonDefault nevű kulcsot, amely egy HSM által védett kulcs. A parancs a $KeyOperations tárolt engedélyezett kulcsműveletek értékeit határozza meg. A parancs megadja az előző parancsokban létrehozott Lejáratok és NotBefore paraméterek időpontját, valamint a magas súlyosságú és informatikai címkéket. Az új kulcs le van tiltva. Ezt a Set-AzKeyVaultKey parancsmaggal engedélyezheti.

5. példa: HSM által védett kulcs importálása

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           :

Ez a parancs importálja az ITByok nevű kulcsot a KeyFilePath paraméter által megadott helyről. Az importált kulcs egy HSM által védett kulcs. Ha saját hardveres biztonsági modulból szeretne kulcsot importálni, először létre kell hoznia egy BYOK-csomagot (egy .byok fájlnévkiterjesztéssel rendelkező fájlt) az Azure Key Vault BYOK-eszközkészletével. További információ: HSM által védett kulcsok létrehozása és átvitele az Azure Key Vaulthoz.

6. példa: Szoftver által védett kulcs importálása

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

Az első parancs a ConvertTo-SecureString parancsmaggal biztonságos sztringgé alakítja át a sztringet, majd a sztringet a $Password változóban tárolja. További információkért írja be a következőt Get-Help ConvertTo-SecureString: A második parancs létrehoz egy szoftverjelszót a Contoso kulcstartójában. A parancs megadja a kulcs helyét és a $Password tárolt jelszót.

7. példa: Kulcs importálása és attribútumok hozzárendelése

$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

Az első parancs a ConvertTo-SecureString parancsmaggal biztonságos sztringgé alakítja át a sztringet, majd a sztringet a $Password változóban tárolja. A második parancs létrehoz egy DateTime objektumot a Get-Date parancsmaggal, majd az objektumot a $Expires változóban tárolja. A harmadik parancs létrehozza a $tags változót a magas súlyosságú és informatikai címkék beállításához. Az utolsó parancs HSM-kulcsként importál egy kulcsot a megadott helyről. A parancs megadja a $Expires tárolt lejárati időt és a $Password tárolt jelszót, és alkalmazza a $tags tárolt címkéket.

8. példa: Kulcscserekulcs (KEK) létrehozása a "saját kulcs használata" (BYOK) funkcióhoz

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

Létrehoz egy kulcsot (más néven kulcscserekulcsot (KEK). A KEK-nek olyan RSA-HSM-kulcsnak kell lennie, amely csak az importálási kulcs műveletével rendelkezik. Csak a Key Vault Premium termékváltozat támogatja az RSA-HSM kulcsokat. További részletekért lásd: https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys

9. példa: Biztonságos kulcs létrehozása felügyelt hsm-ben

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

Hozzon létre egy biztonságos kulcsot a testmhsm nevű felügyelt hsm-ben. Neve tesztkulcs, típusa RSA.

10. példa: Titkos virtuális gép kulcsának hozzáadása egy kulcstartóhoz.

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           :

Paraméterek

-Confirm

Jóváhagyást kér a parancsmag futtatása előtt.

Típus:SwitchParameter
Aliasok:cf
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-CurveName

Megadja a három pontból álló görbe titkosításának görbenevét. Ez az érték akkor érvényes, ha a KeyType EC.

Típus:String
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-DefaultProfile

Az Azure-ral való kommunikációhoz használt hitelesítő adatok, fiók, bérlő és előfizetés

Típus:IAzureContextContainer
Aliasok:AzContext, AzureRmContext, AzureCredential
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-Destination

Megadja, hogy a kulcsot szoftveresen védett kulcsként vagy HSM-védelem alatt álló kulcsként kell-e hozzáadni a Key Vault szolgáltatásban. Az érvényes értékek a következők: HSM és Software. Megjegyzés: A HSM célként való használatához rendelkeznie kell egy HSM-eket támogató kulcstartóval. Az Azure Key Vault szolgáltatási szintjeiről és képességeiről az Azure Key Vault díjszabási webhelyén talál további információt. Ez a paraméter új kulcs létrehozásakor szükséges. Ha a KeyFilePath paraméterrel importál egy kulcsot, ez a paraméter nem kötelező:

  • Ha nem adja meg ezt a paramétert, és ez a parancsmag egy .byok fájlnévkiterjesztéssel rendelkező kulcsot importál, azt HSM által védett kulcsként importálja. A parancsmag nem tudja szoftveres védelem alatt álló kulcsként importálni a kulcsot.
  • Ha nem adja meg ezt a paramétert, és ez a parancsmag egy .pfx fájlnévkiterjesztéssel rendelkező kulcsot importál, a kulcsot szoftveresen védett kulcsként importálja.
Típus:String
Elfogadott értékek:HSM, Software, HSM, Software
Position:Named
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-Disable

Azt jelzi, hogy a hozzáadott kulcs a letiltott állapot kezdeti állapotára van állítva. A kulcs használatára tett kísérletek sikertelenek lesznek. Ezt a paramétert akkor használja, ha előre betölti azokat a kulcsokat, amelyeket később engedélyezni szeretne.

Típus:SwitchParameter
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-Expires

A parancsmag által hozzáadott kulcs lejárati idejét adja meg UTC-ben DateTime-objektumként. Ha nincs megadva, a kulcs nem jár le. DateTime-objektum beszerzéséhez használja a Get-Date parancsmagot. További információkért írja be a következőt Get-Help Get-Date: Vegye figyelembe, hogy a BYOK-folyamatban használt Kulcscsere-kulcs esetében a lejáratok figyelmen kívül lesznek hagyva.

Típus:Nullable<T>[DateTime]
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-Exportable

Azt jelzi, hogy a titkos kulcs exportálható-e.

Típus:SwitchParameter
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-HsmName

HSM-név. A parancsmag egy felügyelt HSM teljes tartománynevét hozza létre a név és az aktuálisan kiválasztott környezet alapján.

Típus:String
Position:Named
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-HsmObject

HSM-objektum.

Típus:PSManagedHsm
Position:0
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:True
Helyettesítő karakterek elfogadása:False

-HsmResourceId

A HSM erőforrás-azonosítója.

Típus:String
Position:Named
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:True
Helyettesítő karakterek elfogadása:False

-Immutable

A kiadási szabályzatot módosíthatatlan állapotként állítja be. A nem módosítható megjelölés után ez a jelző nem állítható alaphelyzetbe, és a szabályzat semmilyen körülmények között nem módosítható.

Típus:SwitchParameter
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-InputObject

Tárolóobjektum.

Típus:PSKeyVault
Position:0
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:True
Helyettesítő karakterek elfogadása:False

-KeyFilePassword

Megadja az importált fájl jelszavát SecureString-objektumként. SecureString-objektum beszerzéséhez használja a ConvertTo-SecureString parancsmagot. További információkért írja be a következőt Get-Help ConvertTo-SecureString: Ezt a jelszót meg kell adnia egy .pfx kiterjesztésű fájl importálásához.

Típus:SecureString
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-KeyFilePath

Megadja a parancsmag által importált kulcsfontosságú anyagokat tartalmazó helyi fájl elérési útját. Az érvényes fájlnévkiterjesztések a .byok és a .pfx.

  • Ha a fájl .byok fájl, az importálás után a rendszer automatikusan védi a kulcsot a HSM-ekkel, és ezt az alapértelmezett beállítást nem bírálhatja felül.
  • Ha a fájl .pfx fájl, a kulcsot az importálás után a szoftver automatikusan védi. Az alapértelmezett érték felülbírálásához állítsa a Cél paramétert HSM-re, hogy a kulcs HSM-védelem alatt legyen. A paraméter megadásakor a Cél paraméter megadása nem kötelező.
Típus:String
Position:Named
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-KeyOps

A parancsmag által hozzáadott kulccsal végrehajtható műveletek tömbje. Ha nem adja meg ezt a paramétert, minden művelet végrehajtható. A paraméter elfogadható értékei a JSON Web Key (JWK) specifikációja által meghatározott kulcsműveletek vesszővel tagolt listája:

  • encrypt
  • visszafejt
  • wrapKey
  • unwrapKey
  • jel
  • igazol
  • importálás (csak KEK esetén lásd a 7. példát)
Típus:String[]
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-KeyType

A kulcs kulcstípusát adja meg. BYOK-kulcsok importálásakor alapértelmezés szerint az "RSA" lesz.

Típus:String
Position:Named
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-Name

Megadja a kulcstartóhoz hozzáadni kívánt kulcs nevét. Ez a parancsmag egy kulcs teljes tartománynevét (FQDN) hozza létre a paraméter által megadott név, a kulcstartó neve és az aktuális környezet alapján. A névnek 1–63 karakter hosszúságú sztringnek kell lennie, amely csak 0-9, a-z, A-Z és - karaktert (a kötőjelet) tartalmaz.

Típus:String
Aliasok:KeyName
Position:1
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-NotBefore

Dátum/idő objektumként azt az időt adja meg, amely előtt a kulcs nem használható. Ez a paraméter UTC-t használ. DateTime-objektum beszerzéséhez használja a Get-Date parancsmagot. Ha nem adja meg ezt a paramétert, a kulcs azonnal használható.

Típus:Nullable<T>[DateTime]
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-ReleasePolicyPath

Egy JSON-szabályzatdefiníciót tartalmazó fájl elérési útja. Azok a szabályzatszabályok, amelyek alapján a kulcs exportálható.

Típus:String
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-ResourceId

Tároló erőforrás-azonosítója.

Típus:String
Position:0
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:True
Helyettesítő karakterek elfogadása:False

-Size

RSA kulcsméret bitekben. Ha nincs megadva, a szolgáltatás biztonságos alapértelmezett értéket biztosít.

Típus:Nullable<T>[Int32]
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-Tag

Kulcs-érték párok kivonattábla formájában. Például: @{key0="value0"; key1=$null; key2="value2"}

Típus:Hashtable
Aliasok:Tags
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-UseDefaultCVMPolicy

Megadja az alapértelmezett házirend használatát, amely alatt a kulcs exportálható a CVM-lemeztitkosításhoz.

Típus:SwitchParameter
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-VaultName

Megadja annak a kulcstartónak a nevét, amelyhez a parancsmag hozzáadja a kulcsot. Ez a parancsmag egy kulcstartó teljes tartománynevét hozza létre a paraméter által megadott név és az aktuális környezet alapján.

Típus:String
Position:0
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-WhatIf

Bemutatja, mi történne a parancsmag futtatásakor. A parancsmag nem fut.

Típus:SwitchParameter
Aliasok:wi
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

Bevitelek

PSKeyVault

PSManagedHsm

String

Kimenetek

PSKeyVaultKey