Share via


Get-Secret

Trova e restituisce un segreto in base al nome degli insiemi di credenziali registrati.

Sintassi

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

Descrizione

Questo cmdlet trova e restituisce il primo segreto corrispondente al nome specificato. Se viene specificato un nome dell'insieme di credenziali, viene eseguita solo la ricerca nell'insieme di credenziali. In caso contrario, cerca tutti gli insiemi di credenziali e restituisce il primo risultato corrispondente. Se il Registro di sistema dell'insieme di credenziali ha un insieme di credenziali predefinito, il cmdlet cerca tale insieme di credenziali prima di qualsiasi altro insieme di credenziali registrato. I segreti che sono tipi String o SecureString vengono restituiti come oggetti SecureString per impostazione predefinita.

Esempio

Esempio 1

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

System.Security.SecureString
PlainTextSecretString

In questo esempio viene eseguita la ricerca di un segreto con il nome Secret1, che è un segreto di tipo String . Il primo comando restituisce il segreto come oggetto SecureString . Il secondo comando usa invece il parametro AsPlainText per restituire il segreto come oggetto String , visualizzando nella console come testo normale.

Esempio 2

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

In questo esempio vengono recuperate informazioni segrete per il segreto denominato Secret2 nell'insieme di credenziali denominato SecretStore. Invia quindi il risultato tramite la pipeline a Get-Secret, che cerca il segreto e lo restituisce come testo normale.

Parametri

-AsPlainText

Specifica che un segreto il cui tipo è String o SecureString deve essere restituito come string (in testo normale) anziché come SecureString. Se il segreto recuperato non è string oSecureString, questo parametro non ha alcun effetto.

Attenzione

Per garantire la sicurezza, è consigliabile evitare di usare stringhe di testo non crittografato quando possibile.

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

-InputObject

Specifica un oggetto SecretInformation che rappresenta un segreto dell'insieme di credenziali anziché specificare i parametri Name e Vault . Puoi ottenere un oggetto SecretInformation con il Get-SecretInfo cmdlet .

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

-Name

Specifica il nome del segreto da recuperare. I caratteri jolly non sono consentiti.

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

-Vault

Specifica il nome dell'insieme di credenziali registrato da cui recuperare il segreto. Se non viene specificato alcun nome dell'insieme di credenziali, viene eseguita la ricerca in tutti gli insiemi di credenziali registrati. Se il Registro di sistema dell'insieme di credenziali ha un insieme di credenziali predefinito e questo parametro non viene specificato, l'insieme di credenziali predefinito viene cercato prima degli altri insiemi di credenziali registrati.

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

Input

String

Microsoft.PowerShell.SecretManagement.SecretInformation

Output

Object