Get-Secret
Busca y devuelve un secreto por nombre de los almacenes registrados.
Sintaxis
NameParameterSet (valor predeterminado)
Get-Secret
[-Name] <String>
[[-Vault] <String>]
[-AsPlainText]
[<CommonParameters>]
InfoParameterSet
Get-Secret
[-InputObject] <SecretInformation>
[-AsPlainText]
[<CommonParameters>]
Description
Importante
El equipo de PowerShell ha decidido que los módulos Secret son completos en funciones y que ya no se desarrollarán activamente. Los módulos seguirán siendo compatibles con la seguridad y la corrección de errores críticos. El repositorio de código será archivado.
Las últimas versiones publicadas son:
La naturaleza de los secretos ha cambiado fundamentalmente desde que se diseñó este proyecto. Los métodos de autenticación sin contraseña como las llaves de acceso, el inicio de sesión único y los sistemas federados de credenciales como Microsoft Entra ID, biometría y claves de seguridad hardware son el futuro.
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 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 se string o los tipos de 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 de. 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 un string (en texto sin formato) en lugar de un SecureString. Si el secreto que se recupera no es String o SecureString, 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.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-InputObject
Especifica un objeto SecretInformation que representa un secreto de almacén en lugar de especificar los parámetros Name Name y Vault. Puede obtener un objeto SecretInformation con el cmdlet Get-SecretInfo.
Propiedades de parámetro
| Tipo: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
InfoParameterSet
| Posición: | 0 |
| Obligatorio: | True |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Name
Especifica el nombre del secreto que se va a recuperar. No se admite el uso de caracteres comodín.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | 0 |
| Obligatorio: | True |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | 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 buscarán 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 en el almacén predeterminado antes que en los demás almacenes registrados.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | 1 |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.
