Get-Secret

Module:

Microsoft.PowerShell.SecretManagement

Recherche et retourne un secret par nom à partir de coffres inscrits.

Syntaxe

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

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

Description

Cette applet de commande recherche et retourne le premier secret qui correspond au nom fourni. Si un nom de coffre est spécifié, seul ce coffre est recherché. Sinon, il recherche tous les coffres et retourne le premier résultat correspondant. Si le registre du coffre possède un coffre par défaut, l’applet de commande recherche ce coffre avant tout autre coffre inscrit. Les secrets string ou types de SecureString sont retournés en tant qu’objets SecureString par défaut.

Exemples

Exemple 1

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

System.Security.SecureString
PlainTextSecretString

Cet exemple recherche un secret portant le nom Secret1, qui est un secret de type string. La première commande retourne le secret sous la forme d’un objet SecureString. La deuxième commande utilise le paramètre AsPlainText pour renvoyer le secret en tant qu’objet string à la place, qui s’affiche dans la console sous forme de texte brut.

Exemple 2

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

Cet exemple récupère des informations secrètes pour le secret nommé Secret2 dans le coffre nommé SecretStore. Il envoie ensuite le résultat via le pipeline à Get-Secret, qui recherche le secret et le retourne sous forme de texte brut.

Paramètres

-AsPlainText

Spécifie qu’un secret dont le type est String ou SecureString doit être retourné en tant que String (en texte brut) au lieu d’un SecureString. Si le secret récupéré n’est pas une chaîne ou secureString, ce paramètre n’a aucun effet.

Prudence

Pour garantir la sécurité, vous devez éviter d’utiliser des chaînes en texte clair dans la mesure du possible.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-InputObject

Spécifie un objet SecretInformation représentant un secret de coffre au lieu de spécifier les paramètres name et Vault. Vous pouvez obtenir un objet SecretInformation avec l’applet de commande Get-SecretInfo.

Type:	SecretInformation
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Name

Spécifie le nom du secret à récupérer. Les caractères génériques ne sont pas autorisés.

Type:	String
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Vault

Spécifie le nom du coffre inscrit à partir duquel récupérer le secret. Si aucun nom de coffre n’est spécifié, tous les coffres inscrits sont recherchés. Si le registre du coffre a un coffre par défaut et que ce paramètre n’est pas spécifié, le coffre par défaut est recherché avant les autres coffres inscrits.

Type:	String
Position:	1
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

Entrées

String

Microsoft.PowerShell.SecretManagement.SecretInformation

Sorties

Object