Get-AzKeyVaultKey

Referencia

Modul:: Az.KeyVault

Lekéri a Key Vault kulcsait. Vegye figyelembe, hogy egy kulcs részletes információi( például kulcstípus vagy kulcsméret) csak egy adott kulcsverzió lekérdezésekor érhetők el.

Syntax

Get-AzKeyVaultKey
   [-VaultName] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-VaultName] <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-VaultName] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmName <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmName <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmName <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -ResourceId <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -ResourceId <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -ResourceId <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmResourceId <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmResourceId <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmResourceId <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

A Get-AzKeyVaultKey parancsmag megkapja az Azure Key Vault kulcsait. Ez a parancsmag lekéri a Microsoft.Azure.Commands.KeyVault.Models.KeyBundle parancsot, vagy egy kulcstartóban lévő összes KeyBundle-objektum listáját vagy verzióját.

Példák

1. példa: Az összes kulcs lekérése egy kulcstartóban

Get-AzKeyVaultKey -VaultName 'contoso'

Vault/HSM Name : contoso
Name           : test1
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test1
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault Name     : contoso
Name           : test2
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test2
Enabled        : True
Expires        : 11/24/2018 6:09:44 PM
Not Before     : 5/24/2018 5:59:44 PM
Created        : 5/24/2018 6:09:44 PM
Updated        : 5/24/2018 6:09:44 PM
Purge Disabled : False
Tags           :

Ez a parancs lekéri a Contoso nevű kulcstartó összes kulcsát.

2. példa: Kulcs aktuális verziójának lekérése

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1'

Vault/HSM Name : contoso
Name           : test1
Key Type       : RSA
Key Size       : 2048
Version        : 7fe415d5518240c1a6fce89986b8d334
Id             : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Ez a parancs lekéri a teszt1 nevű kulcs aktuális verzióját a Contoso nevű kulcstartóban.

3. példa: Kulcs összes verziójának lekérése

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -IncludeVersions

Vault/HSM Name : contoso
Name           : test1
Version        : 7fe415d5518240c1a6fce89986b8d334
Id             : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault/HSM Name     : contoso
Name           : test1
Version        : e4e95940e669407fbdb4298bc21a3e1d
Id             : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d
Enabled        : False
Expires        : 11/24/2018 6:08:08 PM
Not Before     : 5/24/2018 5:58:08 PM
Created        : 5/24/2018 6:08:08 PM
Updated        : 5/24/2018 6:08:08 PM
Purge Disabled : False
Tags           :

Ez a parancs lekéri az ITPfx nevű kulcsot a Contoso nevű kulcstartóban.

4. példa: Kulcs adott verziójának lekérése

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -Version 'e4e95940e669407fbdb4298bc21a3e1d'

Vault/HSM Name : contoso
Name           : test1
Key Type       : RSA
Key Size       : 2048
Version        : e4e95940e669407fbdb4298bc21a3e1d
Id             : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d
Enabled        : False
Expires        : 11/24/2018 6:08:08 PM
Not Before     : 5/24/2018 5:58:08 PM
Created        : 5/24/2018 6:08:08 PM
Updated        : 5/24/2018 6:08:08 PM
Purge Disabled : False
Tags           :

Ez a parancs lekéri az 1. teszt nevű kulcs egy adott verzióját a Contoso nevű kulcstartóban. A parancs futtatása után megvizsgálhatja a kulcs különböző tulajdonságait a $Key objektum navigálásával.

5. példa: A kulcstartóhoz törölt, de nem törölt összes kulcs lekérése

Get-AzKeyVaultKey -VaultName 'contoso' -InRemovedState

Vault/HSM Name       : contoso
Name                 : test3
Id                   : https://contoso.vault.azure.net:443/keys/test3
Deleted Date         : 5/24/2018 8:32:42 PM
Scheduled Purge Date : 8/22/2018 8:32:42 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 5/24/2018 8:32:27 PM
Updated              : 5/24/2018 8:32:27 PM
Purge Disabled       : False
Tags                 :

Ez a parancs lekéri az összes olyan kulcsot, amelyet korábban töröltek, de nem töröltek a Contoso nevű kulcstartóban.

6. példa: Lekéri a kulcs itPfx kulcsát, amelyet töröltek, de nem töröltek ehhez a kulcstartóhoz.

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test3' -InRemovedState

Vault/HSM Name       : contoso
Name                 : test3
Id                   : https://contoso.vault.azure.net:443/keys/test3/1af807cc331a49d0b52b7c75e1b2366e
Deleted Date         : 5/24/2018 8:32:42 PM
Scheduled Purge Date : 8/22/2018 8:32:42 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 5/24/2018 8:32:27 PM
Updated              : 5/24/2018 8:32:27 PM
Purge Disabled       : False
Tags                 :

Ez a parancs lekéri a korábban törölt, de nem törölt kulcstesztet a Contoso nevű kulcstartóban. Ez a parancs metaadatokat ad vissza, például a törlés dátumát és a törölt kulcs ütemezett törlési dátumát.

7. példa: A kulcstartó összes kulcsának lekérése szűréssel

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName "test*"

Vault/HSM Name : contoso
Name           : test1
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test1
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault/HSM Name : contoso
Name           : test2
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test2
Enabled        : True
Expires        : 11/24/2018 6:09:44 PM
Not Before     : 5/24/2018 5:59:44 PM
Created        : 5/24/2018 6:09:44 PM
Updated        : 5/24/2018 6:09:44 PM
Purge Disabled : False
Tags           :

Ez a parancs lekéri a Contoso nevű kulcstartó összes kulcsát, amely a "teszttel" kezdődik.

8. példa: Nyilvános kulcs letöltése .pem fájlként

$path = "D:\public.pem"
Get-AzKeyVaultKey -VaultName $vaultName -KeyName $keyName -OutFile $path

Az RSA-kulcs nyilvános kulcsát a -OutFile paraméter megadásával töltheti le. Ez a HSM által védett kulcsok Azure Key Vaultba való importálásának egyik lépése. Lásd: https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys

Paraméterek

-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

-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

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

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

-IncludeVersions

Azt jelzi, hogy ez a parancsmag egy kulcs összes verzióját lekéri. A kulcs aktuális verziója az első a listában. Ha ezt a paramétert adja meg, meg kell adnia a Name és a VaultName paramétereket is. Ha nem adja meg az IncludeVersions paramétert, ez a parancsmag lekéri a kulcs aktuális verzióját a megadott névvel.

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

-InputObject

KeyVault objektum.

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

-InRemovedState

Megadja, hogy megjelenjenek-e a korábban törölt kulcsok a kimenetben

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

-Name

Megadja a lekérni kívánt kulcscsomag nevét.

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

-OutFile

Megadja azt a kimeneti fájlt, amelyhez ez a parancsmag menti a kulcsot. A nyilvános kulcs alapértelmezés szerint PEM formátumban van mentve.

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

-ResourceId

KeyVault erőforrás-azonosító.

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

-VaultName

Megadja annak a kulcstartónak a nevét, amelyből a parancsmag kulcsokat kap. Ez a parancsmag egy kulcstartó teljes tartománynevét (FQDN) hozza létre a paraméter által megadott név és a kiválasztott 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

-Version

A kulcsverziót adja meg. Ez a parancsmag a kulcs teljes tartománynevét a kulcstartó neve, a jelenleg kijelölt környezet, a kulcsnév és a kulcsverzió alapján hozza létre.

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

Bevitelek

PSKeyVault

String

Kimenetek

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey

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

Get-AzKeyVaultKey

Syntax

Description

Példák

1. példa: Az összes kulcs lekérése egy kulcstartóban

2. példa: Kulcs aktuális verziójának lekérése

3. példa: Kulcs összes verziójának lekérése

4. példa: Kulcs adott verziójának lekérése

5. példa: A kulcstartóhoz törölt, de nem törölt összes kulcs lekérése

6. példa: Lekéri a kulcs itPfx kulcsát, amelyet töröltek, de nem töröltek ehhez a kulcstartóhoz.

7. példa: A kulcstartó összes kulcsának lekérése szűréssel

8. példa: Nyilvános kulcs letöltése .pem fájlként

Paraméterek

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Bevitelek

Kimenetek

További források

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

Get-AzKeyVaultKey

Syntax

Description

Példák

1. példa: Az összes kulcs lekérése egy kulcstartóban

2. példa: Kulcs aktuális verziójának lekérése

3. példa: Kulcs összes verziójának lekérése

4. példa: Kulcs adott verziójának lekérése

5. példa: A kulcstartóhoz törölt, de nem törölt összes kulcs lekérése

6. példa: Lekéri a kulcs itPfx kulcsát, amelyet töröltek, de nem töröltek ehhez a kulcstartóhoz.

7. példa: A kulcstartó összes kulcsának lekérése szűréssel

8. példa: Nyilvános kulcs letöltése .pem fájlként

Paraméterek

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Bevitelek

Kimenetek

Kapcsolódó hivatkozások

További források