Get-Secret
Wyszukuje i zwraca wpis tajny według nazwy z zarejestrowanych magazynów.
Składnia
NameParameterSet (Domyślna)
Get-Secret
[-Name] <String>
[[-Vault] <String>]
[-AsPlainText]
[<CommonParameters>]
InfoParameterSet
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 wyszukuje wszystkie magazyny i zwraca pierwszy pasujący wynik. Jeśli rejestr magazynu ma magazyn domyślny, polecenie cmdlet wyszukuje ten magazyn przed dowolnym innym zarejestrowanym magazynem. Wpisy tajne, które są ciągami lub typy 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 String. Pierwsze polecenie zwraca wpis tajny jako obiekt SecureString. Drugie polecenie używa parametru AsPlainText, aby zwrócić wpis tajny jako obiekt String zamiast tego wyświetlany w konsoli jako zwykły tekst.
Przykład 2
Get-SecretInfo -Name Secret2 -Vault SecretStore |
Get-Secret -AsPlainText
W tym przykładzie są pobierane 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-Secret, 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 należy zwrócić jako ciąg (w postaci zwykłego tekstu) zamiast SecureString. Jeśli pobierany wpis tajny nie jest String ani SecureString, ten parametr nie ma wpływu.
Ostrzeżenie
Aby zapewnić bezpieczeństwo, należy unikać używania ciągów w postaci zwykłego tekstu zawsze, gdy jest to możliwe.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-InputObject
Określa obiekt SecretInformation reprezentujący wpis tajny magazynu zamiast określać parametry Name i Vault. Możesz uzyskać obiekt SecretInformation za pomocą polecenia cmdlet Get-SecretInfo.
Właściwości parametru
| Typ: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
InfoParameterSet
| Position: | 0 |
| Obowiązkowy: | True |
| Wartość z potoku: | True |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Name
Określa nazwę wpisu tajnego do pobrania. Symbole wieloznaczne nie są dozwolone.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
NameParameterSet
| Position: | 0 |
| Obowiązkowy: | True |
| Wartość z potoku: | True |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Vault
Określa nazwę zarejestrowanego magazynu do pobrania wpisu tajnego. Jeśli nie określono nazwy magazynu, przeszukiwane są wszystkie zarejestrowane magazyny. Jeśli rejestr magazynu ma magazyn domyślny i ten parametr nie zostanie określony, magazyn domyślny jest przeszukiwany przed innymi zarejestrowanymi magazynami.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
NameParameterSet
| Position: | 1 |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.
