Get-Secret

Módulo:

Microsoft.PowerShell.SecretManagement

Busca y devuelve un secreto por nombre de almacenes registrados.

Syntax

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

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

Description

Este cmdlet busca y devuelve el primer secreto que coincide con el nombre proporcionado. Si se especifica un nombre de almacén, solo se busca en ese almacén. De lo contrario, busca en todos los almacenes y devuelve el primer resultado coincidente. Si el registro del almacén tiene un almacén predeterminado, el cmdlet busca ese almacén antes de cualquier otro almacén registrado. Los secretos que son tipos String o SecureString se devuelven como objetos SecureString de forma predeterminada.

Ejemplos

Ejemplo 1

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

System.Security.SecureString
PlainTextSecretString

En este ejemplo se busca un secreto con el nombre Secret1, que es un secreto de tipo String . El primer comando devuelve el secreto como un objeto SecureString . El segundo comando usa el parámetro AsPlainText para devolver el secreto como un objeto String en su lugar, que se muestra en la consola como texto sin formato.

Ejemplo 2

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

En este ejemplo se recupera información secreta del secreto denominado Secret2 en el almacén denominado SecretStore. A continuación, envía el resultado a través de la canalización a Get-Secret, que busca el secreto y lo devuelve como texto sin formato.

Parámetros

-AsPlainText

Especifica que un secreto cuyo tipo es String o SecureString debe devolverse como string ( en texto sin formato) en lugar de secureString. Si el secreto que se recupera no es string oSecureString, este parámetro no tiene ningún efecto.

Precaución

Para garantizar la seguridad, debe evitar el uso de cadenas de texto no cifrado siempre que sea posible.

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

-InputObject

Especifica un objeto SecretInformation que representa un secreto del almacén en lugar de especificar los parámetros Name y Vault . Puede obtener un objeto SecretInformation con el Get-SecretInfo cmdlet .

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

-Name

Especifica el nombre del secreto que se va a recuperar. No se admite el uso de caracteres comodín.

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

-Vault

Especifica el nombre del almacén registrado del que se va a recuperar el secreto. Si no se especifica ningún nombre de almacén, se busca en todos los almacenes registrados. Si el registro del almacén tiene un almacén predeterminado y no se especifica este parámetro, se busca el almacén predeterminado antes de los demás almacenes registrados.

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

Entradas

String

Microsoft.PowerShell.SecretManagement.SecretInformation

Salidas

Object