Get-AzureKeyVaultKey

Referenz

Modul:: AzureRM.KeyVault

Ruft Schlüsseltresorschlüssel ab.

Warnung

Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.

Obwohl das AzureRM-Modul weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

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

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

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

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

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

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

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

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

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

Beschreibung

Das Cmdlet "Get-AzureKeyVaultKey " 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

PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso'

Vault 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

PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1'

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

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

Beispiel 3: Abrufen aller Versionen eines Schlüssels

PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -IncludeVersions

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

Mit diesem Befehl werden alle Versionen des Schlüssels "ITPfx" im Schlüsseltresorname Contoso abgerufen.

Beispiel 4: Abrufen einer bestimmten Version eines Schlüssels

PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -Version 'e4e95940e669407fbdb4298bc21a3e1d'

Vault 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 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.

PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -InRemovedState

Vault 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.

PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test3' -InRemovedState

Vault 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.

Parameter

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

KeyVault-Objekt.

Type:	PSKeyVault
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InRemovedState

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Gibt den Namen des abzurufenden Schlüsselbundles an.

Type:	String
Aliases:	KeyName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

KeyVault-Ressourcen-ID.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VaultName

Gibt den Namen des Schlüsseltresors an, aus dem dieses Cmdlet Schlüssel abruft. Dieses Cmdlet erstellt den vollqualifizierten Do Standard namen (FQDN) eines Schlüsseltresors basierend auf dem Namen, den dieser Parameter angibt, und der ausgewählten Umgebung.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.