Get-Secret

Odwołanie

Moduł:: Microsoft.PowerShell.SecretManagement

Wyszukuje i zwraca wpis tajny według nazwy z zarejestrowanych magazynów.

Składnia

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

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

Opis

To polecenie cmdlet znajduje i zwraca pierwszy wpis tajny zgodny z podaną nazwą. Jeśli określono nazwę magazynu, przeszukiwany jest tylko ten magazyn. W przeciwnym razie przeszukuje wszystkie magazyny i zwraca pierwszy pasujący wynik. Jeśli rejestr magazynu ma magazyn domyślny, polecenie cmdlet wyszukuje ten magazyn przed jakimkolwiek innym zarejestrowanym magazynem. Wpisy tajne, które są typami String lub SecureString , są domyślnie zwracane jako obiekty SecureString .

Przykłady

Przykład 1

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

System.Security.SecureString
PlainTextSecretString

W tym przykładzie wyszukiwany jest wpis tajny o nazwie Secret1, który jest wpisem tajnym typu Ciąg . Pierwsze polecenie zwraca wpis tajny jako obiekt SecureString . Drugie polecenie używa parametru AsPlainText , aby zamiast tego zwrócić wpis tajny jako obiekt String , wyświetlając w konsoli jako zwykły tekst.

Przykład 2

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

Ten przykład pobiera informacje o wpisie tajnym dla wpisu tajnego o nazwie Secret2 w magazynie o nazwie SecretStore. Następnie wysyła wynik za pośrednictwem potoku do Get-Secretelementu , który wyszukuje wpis tajny i zwraca go jako zwykły tekst.

Parametry

-AsPlainText

Określa, że wpis tajny, którego typem jest Ciąg lub SecureString , powinien być zwracany jako ciąg (w postaci zwykłego tekstu) zamiast ciągu SecureString. Jeśli pobierany wpis tajny nie jest ciągiem ani ciągiem SecureString, ten parametr nie ma wpływu.

Przestroga

Aby zapewnić bezpieczeństwo, należy unikać używania ciągów w postaci zwykłego tekstu zawsze, gdy jest to możliwe.

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

-InputObject

Określa obiekt SecretInformation reprezentujący wpis tajny magazynu zamiast określać parametry Name i Vault . Obiekt SecretInformation można uzyskać za Get-SecretInfo pomocą polecenia cmdlet .

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

-Name

Określa nazwę wpisu tajnego do pobrania. Symbole wieloznaczne nie są dozwolone.

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

-Vault

Określa nazwę zarejestrowanego magazynu do pobrania wpisu tajnego z. Jeśli nazwa magazynu nie zostanie określona, przeszukiwane są wszystkie zarejestrowane magazyny. Jeśli rejestr magazynu ma magazyn domyślny i ten parametr nie zostanie określony, magazyn domyślny zostanie przeszukany przed innymi zarejestrowanymi magazynami.

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

Dane wejściowe

String

Microsoft.PowerShell.SecretManagement.SecretInformation

Dane wyjściowe

Object

Udostępnij za pośrednictwem