Get-Secret

Referenz

Modul:: Microsoft.PowerShell.SecretManagement

Sucht und gibt ein Geheimnis 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 sucht und gibt das erste Geheimnis zurück, das mit dem angegebenen Namen übereinstimmt. Wenn ein Tresorname angegeben wird, 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 jedem anderen registrierten Tresor. Geheimnisse, 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 Geheimnis mit dem Namen Secret1gesucht, bei dem es sich um ein Geheimnis vom Typ String handelt. Der erste Befehl gibt das Geheimnis als SecureString-Objekt zurück. Der zweite Befehl verwendet den AsPlainText-Parameter , um das Geheimnis stattdessen als String-Objekt zurückzugeben, das in der Konsole als Nur-Text angezeigt wird.

Beispiel 2

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

In diesem Beispiel werden Geheiminformationen für das Geheimnis mit dem Namen Secret2 im Tresor mit dem Namen SecretStoreabgerufen. Anschließend wird das Ergebnis durch die Pipeline an Get-Secretgesendet, die nach dem Geheimnis sucht und es als Nur-Text zurückgibt.

Parameter

-AsPlainText

Gibt an, dass ein Geheimnis, dessen Typ String oder SecureString ist, als String (in Nur-Text) anstelle eines SecureString zurückgegeben werden soll. Wenn das abzurufende Geheimnis kein String oder SecureString ist, hat dieser Parameter keine Auswirkung.

Achtung

Um die Sicherheit zu gewährleisten, sollten Sie möglichst die Verwendung von Klartextzeichenfolgen vermeiden.

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

-InputObject

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

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

-Name

Gibt den Namen des abzurufenden Geheimnisses an. Platzhalterzeichen sind nicht zulässig.

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

-Vault

Gibt den Namen des registrierten Tresors an, aus dem das Geheimnis abgerufen werden soll. Wenn kein Tresorname angegeben wird, 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.

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

Eingaben

String

Microsoft.PowerShell.SecretManagement.SecretInformation

Ausgaben

Object

Freigeben über