Get-AzKeyVaultKey

Referenz

Modul:: Az.KeyVault

Ruft Schlüsseltresorschlüssel ab. Bitte beachten Sie, dass detaillierte Informationen zu einem Schlüssel, z. B. Schlüsseltyp oder Schlüsselgröße, nur verfügbar sind, wenn eine bestimmte Schlüsselversion angefordert wird.

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>]

Beschreibung

Das Cmdlet "Get-AzKeyVaultKey " ruft Azure Key Vault-Schlüssel ab. Dieses Cmdlet ruft ein bestimmtes Microsoft.Azure.Commands.KeyVault.Models.KeyBundle-Objekt oder eine Liste aller KeyBundle-Objekte in einem Schlüsseltresor oder nach Version ab.

Beispiele

Beispiel 1: Abrufen aller Schlüssel in einem Schlüsseltresor

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           :

Dieser Befehl ruft alle Schlüssel im Schlüsseltresor namens Contoso ab.

Beispiel 2: Abrufen der aktuellen Version eines Schlüssels

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           :

Dieser Befehl ruft die aktuelle Version des Schlüssels "test1" im Schlüsseltresor "Contoso" ab.

Beispiel 3: Abrufen aller Versionen eines Schlüssels

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           :

Dieser Befehl ruft alle Versionen des Schlüssels "ITPfx" im Schlüsseltresor "Contoso" ab.

Beispiel 4: Abrufen einer bestimmten Version eines Schlüssels

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           :

Dieser Befehl ruft eine bestimmte Version des Schlüssels mit dem Namen "test1" im Schlüsseltresor "Contoso" ab. Nachdem Sie diesen Befehl ausgeführt haben, können Sie verschiedene Eigenschaften des Schlüssels überprüfen, indem Sie im $Key-Objekt navigieren.

Beispiel 5: Abrufen aller schlüssel, die gelöscht, aber nicht für diesen Schlüsseltresor gelöscht wurden

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                 :

Dieser Befehl ruft alle Schlüssel ab, die zuvor gelöscht, aber nicht gelöscht wurden, im Schlüsseltresor namens Contoso.

Beispiel 6: Ruft den itPfx-Schlüssel ab, der gelöscht, aber nicht für diesen Schlüsseltresor gelöscht wurde.

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                 :

Dieser Befehl ruft den Schlüsseltest3 ab, der zuvor gelöscht, aber nicht gelöscht wurde, im Schlüsseltresor namens Contoso. Mit diesem Befehl werden Metadaten wie das Löschdatum und das geplante Löschdatum dieses gelöschten Schlüssels zurückgegeben.

Beispiel 7: Abrufen aller Schlüssel in einem Schlüsseltresor mithilfe von Filtern

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           :

Dieser Befehl ruft alle Schlüssel im Schlüsseltresor namens Contoso ab, die mit "test" beginnen.

Beispiel 8: Herunterladen eines öffentlichen Schlüssels als PEM-Datei

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

Sie können den öffentlichen Schlüssel eines RSA-Schlüssels herunterladen, indem Sie den -OutFile Parameter angeben. Dies ist ein Schritt beim Importieren von HSM-geschützten Schlüsseln in Azure Key Vault. Informationen finden Sie unter https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys.

Parameter

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Typ:	IAzureContextContainer
Aliase:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-HsmName

HSM-Name. Cmdlet erstellt den FQDN eines verwalteten HSM basierend auf dem Namen und der aktuell ausgewählten Umgebung.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-HsmObject

HSM-Objekt.

Typ:	PSManagedHsm
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-HsmResourceId

HSM-Ressourcen-ID.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-IncludeVersions

Gibt an, dass dieses Cmdlet alle Versionen eines Schlüssels abruft. Die aktuelle Version eines Schlüssels ist die erste in der Liste. Wenn Sie diesen Parameter angeben, müssen Sie auch die Parameter Name und VaultName angeben. Wenn Sie den Parameter IncludeVersions nicht angeben, ruft dieses Cmdlet die aktuelle Version des Schlüssels mit dem angegebenen Namen ab.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-InputObject

KeyVault-Objekt.

Typ:	PSKeyVault
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-InRemovedState

Gibt an, ob die zuvor gelöschten Schlüssel in der Ausgabe angezeigt werden sollen.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Name

Gibt den Namen des abzurufenden Schlüsselbundles an.

Typ:	String
Aliase:	KeyName
Position:	1
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	True

-OutFile

Gibt die Ausgabedatei an, für die dieses Cmdlet den Schlüssel speichert. Der öffentliche Schlüssel wird standardmäßig im PEM-Format gespeichert.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-ResourceId

KeyVault-Ressourcen-ID.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-VaultName

Gibt den Namen des Schlüsseltresors an, aus dem dieses Cmdlet Schlüssel abruft. Dieses Cmdlet erstellt den vollqualifizierten Domänennamen (Fully Qualified Domain Name, FQDN) eines Schlüsseltresors basierend auf dem Namen, den dieser Parameter angibt, und die ausgewählte Umgebung.

Typ:	String
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Version

Gibt die Schlüsselversion an. Dieses Cmdlet erstellt den FQDN eines Schlüssels basierend auf dem Schlüsseltresornamen, der aktuell ausgewählten Umgebung, dem Schlüsselnamen und der Schlüsselversion.

Typ:	String
Aliase:	KeyVersion
Position:	2
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

Eingaben

PSKeyVault

String

Ausgaben

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey

Freigeben über

Get-AzKeyVaultKey

Syntax

Beschreibung

Beispiele

Beispiel 1: Abrufen aller Schlüssel in einem Schlüsseltresor

Beispiel 2: Abrufen der aktuellen Version eines Schlüssels

Beispiel 3: Abrufen aller Versionen eines Schlüssels

Beispiel 4: Abrufen einer bestimmten Version eines Schlüssels

Beispiel 5: Abrufen aller schlüssel, die gelöscht, aber nicht für diesen Schlüsseltresor gelöscht wurden

Beispiel 6: Ruft den itPfx-Schlüssel ab, der gelöscht, aber nicht für diesen Schlüsseltresor gelöscht wurde.

Beispiel 7: Abrufen aller Schlüssel in einem Schlüsseltresor mithilfe von Filtern

Beispiel 8: Herunterladen eines öffentlichen Schlüssels als PEM-Datei

Parameter

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Eingaben

Ausgaben

Zusätzliche Ressourcen

Freigeben über

Get-AzKeyVaultKey

Syntax

Beschreibung

Beispiele

Beispiel 1: Abrufen aller Schlüssel in einem Schlüsseltresor

Beispiel 2: Abrufen der aktuellen Version eines Schlüssels

Beispiel 3: Abrufen aller Versionen eines Schlüssels

Beispiel 4: Abrufen einer bestimmten Version eines Schlüssels

Beispiel 5: Abrufen aller schlüssel, die gelöscht, aber nicht für diesen Schlüsseltresor gelöscht wurden

Beispiel 6: Ruft den itPfx-Schlüssel ab, der gelöscht, aber nicht für diesen Schlüsseltresor gelöscht wurde.

Beispiel 7: Abrufen aller Schlüssel in einem Schlüsseltresor mithilfe von Filtern

Beispiel 8: Herunterladen eines öffentlichen Schlüssels als PEM-Datei

Parameter

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Eingaben

Ausgaben

Ähnliche Themen

Zusätzliche Ressourcen