Get-Secret
Zoekt en retourneert een geheim op naam uit geregistreerde kluizen.
Syntaxis
NameParameterSet (Standaard)
Get-Secret
[-Name] <String>
[[-Vault] <String>]
[-AsPlainText]
[<CommonParameters>]
InfoParameterSet
Get-Secret
[-InputObject] <SecretInformation>
[-AsPlainText]
[<CommonParameters>]
Description
Met deze cmdlet wordt het eerste geheim gevonden en geretourneerd dat overeenkomt met de opgegeven naam. Als er een kluisnaam is opgegeven, wordt alleen die kluis doorzocht. Anders wordt in alle kluizen gezocht en wordt het eerste overeenkomende resultaat geretourneerd. Als het kluisregister een standaardkluis heeft, zoekt de cmdlet die kluis vóór een andere geregistreerde kluis. Geheimen die tekenreeks of SecureString- zijn, worden standaard geretourneerd als SecureString--objecten.
Voorbeelden
Voorbeeld 1
Get-Secret -Name Secret1 -Vault CredMan
Get-Secret -Name Secret1 -Vault CredMan -AsPlainText
System.Security.SecureString
PlainTextSecretString
In dit voorbeeld wordt gezocht naar een geheim met de naam Secret1. Dit is een tekenreeks typegeheim. De eerste opdracht retourneert het geheim als een SecureString-object. De tweede opdracht maakt gebruik van de parameter AsPlainText- om het geheim als een tekenreeksobject te retourneren, dat in de console wordt weergegeven als tekst zonder opmaak.
Voorbeeld 2
Get-SecretInfo -Name Secret2 -Vault SecretStore |
Get-Secret -AsPlainText
In dit voorbeeld worden geheime gegevens opgehaald voor het geheim met de naam Secret2 in de kluis met de naam SecretStore. Vervolgens wordt het resultaat via de pijplijn verzonden naar Get-Secret, waarmee naar het geheim wordt gezocht en als tekst zonder opmaak wordt geretourneerd.
Parameters
-AsPlainText
Hiermee geeft u op dat een geheim waarvan het type is tekenreeks of SecureString- moet worden geretourneerd als een tekenreeks (in tekst zonder opmaak) in plaats van een SecureString-. Als het geheim dat wordt opgehaald geen String of SecureString is, heeft deze parameter geen effect.
Waarschuwing
Om beveiliging te garanderen, moet u het gebruik van tekenreeksen zonder opmaak vermijden, indien mogelijk.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-InputObject
Hiermee geeft u een SecretInformation-object op dat een kluisgeheim vertegenwoordigt in plaats van de parameters Naam en Vault op te geven. U kunt een SecretInformation-object ophalen met de cmdlet Get-SecretInfo.
Parametereigenschappen
| Type: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
InfoParameterSet
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Name
Hiermee geeft u de naam van het geheim dat moet worden opgehaald. Jokertekens zijn niet toegestaan.
Parametereigenschappen
| Type: | String |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
NameParameterSet
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Vault
Hiermee geeft u de naam van de geregistreerde kluis op waaruit het geheim moet worden opgehaald. Als er geen kluisnaam is opgegeven, worden alle geregistreerde kluizen doorzocht. Als het kluisregister een standaardkluis heeft en deze parameter niet is opgegeven, wordt de standaardkluis doorzocht vóór de andere geregistreerde kluizen.
Parametereigenschappen
| Type: | String |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
NameParameterSet
| Position: | 1 |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
