Get-Secret

Modul:

Microsoft.PowerShell.SecretManagement

Sucht und gibt einen geheimen Schlüssel anhand des Namens aus registrierten Tresoren zurück.

Syntax

Get-Secret
   [-Name] <String>
   [[-Vault] <String>]
   [-AsPlainText]
   [<CommonParameters>]

Get-Secret
   [-InputObject] <SecretInformation>
   [-AsPlainText]
   [<CommonParameters>]

Beschreibung

Dieses Cmdlet findet und gibt den ersten geheimen Schlüssel zurück, der dem angegebenen Namen entspricht. Wenn ein Tresorname angegeben ist, wird nur dieser Tresor durchsucht. Andernfalls durchsucht er alle Tresore und gibt das erste übereinstimmende Ergebnis zurück. Wenn die Tresorregistrierung über einen Standardtresor verfügt, durchsucht das Cmdlet diesen Tresor vor einem anderen registrierten Tresor. Geheime Schlüssel, die String-- oder SecureString- Typen sind, werden standardmäßig als SecureString--Objekte zurückgegeben.

Beispiele

Beispiel 1

Get-Secret -Name Secret1 -Vault CredMan
Get-Secret -Name Secret1 -Vault CredMan -AsPlainText

System.Security.SecureString
PlainTextSecretString

In diesem Beispiel wird nach einem geheimen Schlüssel mit dem Namen Secret1gesucht, bei dem es sich um einen String- Geheimschlüssel handelt. Der erste Befehl gibt den geheimen Schlüssel als SecureString--Objekt zurück. Der zweite Befehl verwendet den parameter AsPlainText, um den geheimen Schlüssel stattdessen als String-Objekt zurückzugeben, das stattdessen in der Konsole als Nur-Text angezeigt wird.

Beispiel 2

Get-SecretInfo -Name Secret2 -Vault SecretStore | Get-Secret -AsPlainText

In diesem Beispiel werden geheime Informationen für den geheimen Secret2 im Tresor mit dem Namen SecretStoreabgerufen. Anschließend wird das Ergebnis über die Pipeline an Get-Secretgesendet, das nach dem geheimen Schlüssel sucht und als Nur-Text zurückgibt.

Parameter

-AsPlainText

Gibt an, dass ein geheimer Schlüssel, dessen Typ String oder SecureString- als String- (in Nur-Text) anstelle eines SecureString-zurückgegeben werden soll. Wenn der geheime Schlüssel, der abgerufen wird, kein String- oder SecureString-ist, hat dieser Parameter keine Auswirkung.

Vorsicht

Um die Sicherheit zu gewährleisten, sollten Sie möglichst keine Nur-Text-Zeichenfolgen verwenden.

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

-InputObject

Gibt ein SecretInformation -Objekt an, das einen Tresorschlüssel darstellt, anstatt die Parameter Name und Vault anzugeben. Sie können ein SecretInformation--Objekt mit dem Cmdlet Get-SecretInfo abrufen.

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

-Name

Gibt den Namen des abzurufenden geheimen Schlüssels an. Wildcardzeichen sind nicht zulässig.

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

-Vault

Gibt den Namen des registrierten Tresors an, aus dem der geheime Schlüssel abgerufen werden soll. Wenn kein Tresorname angegeben ist, werden alle registrierten Tresore durchsucht. Wenn die Tresorregistrierung über einen Standardtresor verfügt und dieser Parameter nicht angegeben ist, wird der Standardtresor vor den anderen registrierten Tresoren durchsucht.

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

Eingaben

String

Microsoft.PowerShell.SecretManagement.SecretInformation

Ausgaben

Object