Get-AzureKeyVaultSecret

Ruft die Geheimnisse in einem Schlüsseltresor ab.

Wichtig

Die Az PowerShell-Module bieten nun die gleichen Funktionen wie AzureRM PowerShell-Module und weitere Funktionen, daher werden die AzureRM PowerShell-Module am 29 Februar 2024 ausgemustert.

Um Dienstunterbrechungen zu vermeiden, müssen Sie bis zum 29. Februar 2024 die Skripts aktualisieren, die AzureRM PowerShell-Module verwenden. Befolgen Sie zum automatischen Aktualisieren Ihrer Skripts die Schnellstartanleitung.

Syntax

Get-AzureKeyVaultSecret
   [-VaultName] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-Version] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [[-Name] <String>]
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-Version] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-ResourceId] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-ResourceId] <String>
   [-Name] <String>
   [-Version] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-ResourceId] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Get-AzureKeyVaultSecret ruft geheime Schlüssel in einem Schlüsseltresor ab. Dieses Cmdlet ruft einen bestimmten Geheimschlüssel oder alle geheimen Schlüssel in einem Schlüsseltresor ab.

Beispiele

Beispiel 1: Abrufen aller aktuellen Versionen aller geheimen Schlüsselschlüssel in einem Schlüsseltresor

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso'

Vault Name   : contoso
Name         : secret1
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret1
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret2
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret2
Enabled      : True
Expires      :
Not Before   :
Created      : 4/11/2018 11:45:06 PM
Updated      : 4/11/2018 11:45:06 PM
Content Type :
Tags         :

Dieser Befehl ruft die aktuellen Versionen aller Geheimen im Schlüsseltresor "Contoso" ab.

Beispiel 2: Abrufen aller Versionen eines bestimmten geheimen Schlüssels

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -IncludeVersions

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret1
Version      : 5d1a74ba2c454439886fb8509b6cab3c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c
Enabled      : True
Expires      :
Not Before   :
Created      : 4/5/2018 11:44:50 PM
Updated      : 4/5/2018 11:44:50 PM
Content Type :
Tags         :

Dieser Befehl ruft alle Versionen des geheimen Schlüsselschlüssels mit dem Namen "Secret1" im Schlüsseltresor "Contoso" ab.

Beispiel 3: Abrufen der aktuellen Version eines bestimmten geheimen Schlüssels

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

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

Beispiel 4: Abrufen einer bestimmten Version eines bestimmten geheimen Schlüssels

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -Version '5d1a74ba2c454439886fb8509b6cab3c'

Vault Name   : contoso
Name         : secret1
Version      : 5d1a74ba2c454439886fb8509b6cab3c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c
Enabled      : True
Expires      :
Not Before   :
Created      : 4/5/2018 11:44:50 PM
Updated      : 4/5/2018 11:44:50 PM
Content Type :
Tags         :

Dieser Befehl ruft eine bestimmte Version des geheimen Schlüsselschlüssels mit dem Namen "Secret1" im Schlüsseltresor "Contoso" ab.

Beispiel 5: Abrufen des Nur-Text-Werts der aktuellen Version eines bestimmten geheimen Schlüssels

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret'
PS C:\> Write-Host "Secret Value is:" $secret.SecretValueText

Secret Value is: P@ssw0rd

Diese Befehle erhalten die aktuelle Version eines geheimen Schlüssels namens ITSecret, und zeigt dann den Nur-Text-Wert dieses geheimen Schlüssels an.

Beispiel 6: Abrufen aller geheimen Schlüssel, die gelöscht wurden, aber nicht für diesen Schlüsseltresor gelöscht wurden.

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -InRemovedState

Vault Name           : contoso
Name                 : secret1
Id                   : https://contoso.vault.azure.net:443/secrets/secret1
Deleted Date         : 4/4/2018 8:51:58 PM
Scheduled Purge Date : 7/3/2018 8:51:58 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/4/2018 8:51:03 PM
Updated              : 4/4/2018 8:51:03 PM
Content Type         :
Tags                 :

Vault Name           : contoso
Name                 : secret2
Id                   : https://contoso.vault.azure.net:443/secrets/secret2
Deleted Date         : 5/7/2018 7:56:34 PM
Scheduled Purge Date : 8/5/2018 7:56:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/6/2018 8:39:15 PM
Updated              : 4/6/2018 10:11:24 PM
Content Type         : 
Tags                 :

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

Beispiel 7: Ruft den geheimen ITSecret ab, der gelöscht wurde, aber nicht für diesen Schlüsseltresor gelöscht wurde.

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -KeyName 'secret1' -InRemovedState

Vault Name           : contoso
Name                 : secret1
Version              : 689d23346e9c42a2a64f4e3d75094dcc
Id                   : https://contoso.vault.azure.net:443/secrets/secret1/689d23346e9c42a2a64f4e3d75094dcc
Deleted Date         : 4/4/2018 8:51:58 PM
Scheduled Purge Date : 7/3/2018 8:51:58 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/4/2018 8:51:03 PM
Updated              : 4/4/2018 8:51:03 PM
Content Type         :
Tags                 :

Dieser Befehl ruft den geheimen Schlüssel "secret1" ab, der zuvor gelöscht wurde, aber nicht gelöscht wurde, im Schlüsseltresor "Contoso". Dieser Befehl gibt Metadaten wie das Löschdatum und das geplante Löschdatum dieses gelöschten Schlüssels zurück.

Parameter

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IncludeVersions

Gibt an, dass dieses Cmdlet alle Versionen eines geheimen Schlüssels abruft. Die aktuelle Version eines geheimen 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 geheimen Schlüssels mit dem angegebenen Namen ab.

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

KeyVault-Objekt.

Type:PSKeyVault
Position:0
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Name

Gibt den Namen des geheimen Schlüssels an, der abgerufen werden soll.

Type:String
Aliases:SecretName
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

KeyVault-Ressourcen-ID.

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

Gibt den Namen des Schlüsseltresors an, zu dem der Geheime gehört. Dieses Cmdlet erstellt den vollqualifizierten Domänennamen (FQDN) eines Schlüsseltresors basierend auf dem Namen, den dieser Parameter angibt, und Ihre aktuelle Umgebung.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Version

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

Type:String
Aliases:SecretVersion
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

PSKeyVault

Parameter: InputObject (ByValue)

String

Ausgaben

PSKeyVaultSecretIdentityItem

PSKeyVaultSecret

PSDeletedKeyVaultSecretIdentityItem

PSDeletedKeyVaultSecret