Set-Secret

Referencia

Módulo:: Microsoft.PowerShell.SecretManagement

Agrega un secreto a un almacén registrado de SecretManagement.

Sintaxis

Set-Secret
   [-Name] <String>
   -SecureStringSecret <SecureString>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Secret
   [-Name] <String>
   -Secret <Object>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Secret
   -SecretInfo <SecretInformation>
   [-Vault] <String>
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Este cmdlet agrega un valor secreto por nombre a un almacén. Cuando no se especifica ningún nombre de almacén, el secreto se agrega al almacén predeterminado. Si existe un secreto con ese nombre, se sobrescribe. Se pueden incluir datos adicionales con el secreto si es compatible con el almacén de extensiones.

El conjunto de parámetros predeterminado toma un objeto SecureString. Si ejecuta el comando sin especificar el valor del secreto, el cmdlet le pide que escriba un SecureString. El texto de la cadena no está visible en la consola.

Ejemplos

Ejemplo 1

Set-Secret -Name Secret1 -Secret "SecretValue"
Get-Secret -Name Secret1

System.Security.SecureString

En este ejemplo se agrega un secreto denominado Secret1 con un valor de texto sin formato de SecretValue. Dado que no se especificó ningún nombre de almacén, el secreto se agrega al almacén predeterminado del usuario actual. Get-Secret muestra que se agregó el secreto.

Ejemplo 2

PS C:\> Set-Secret -Name Secret2 -Vault LocalStore

cmdlet Set-Secret at command pipeline position 1
Supply values for the following parameters:
SecureStringSecret: ***********

PS C:\> Get-Secret -Name Secret2
System.Security.SecureString

En este ejemplo se agrega un secreto denominado Secret2 al almacén de LocalStore. Dado que no se proporcionó ningún valor secreto, el cmdlet solicita un valor de SecureString. La consola oculta el valor de cadena tal como se escribe. Get-Secret muestra que se agregó el secreto.

Ejemplo 3

$Metadata = @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Set-Secret -Name TargetSecret -Secret $targetToken -Vault LocalStore -Metadata $Metadata
Get-SecretInfo -Name TargetSecret | Select-Object Name,Metadata

Name         Metadata
----         --------
TargetSecret {[Expiration, 5/1/2022 12:00:00 AM]}

En este ejemplo se agrega un secreto denominado TargetSecret al almacén de LocalStore con metadatos que indican la fecha de expiración del secreto. Get-SecretInfo recupera los metadatos del secreto recién creado.

Ejemplo 4

$Metadata = @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Set-Secret -Name PublishSecret -Secret $targetToken -Vault LocalStore2 -Metadata $Metadata

Set-Secret: Can't store secret PublishSecret. Vault LocalStore2 doesn't support secret metadata.

En este ejemplo se agrega un secreto denominado PublishSecret al almacén de LocalStore2 con metadatos adicionales. Sin embargo, el almacén LocalStore2 no admite metadatos secretos y la operación devuelve un error.

Parámetros

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Tipo:	SwitchParameter
Alias:	cf
Posición:	Named
Valor predeterminado:	False
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Metadata

Especifica un hashtable que contiene pares clave-valor que se van a asociar al secreto del almacén. Es posible que el almacén de extensiones especificado no admita metadatos secretos. Si el almacén no admite metadatos, se produce un error en la operación y se devuelve un error. Los valores de los metadatos de la tabla hash deben ser uno de los siguientes tipos:

cadena
int
DateTime

Los metadatos no se almacenan de forma segura en un almacén. Los metadatos no deben contener información confidencial.

Tipo:	Hashtable
Posición:	1
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Name

Especifica el nombre del secreto que se va a agregar o actualizar. No se permiten caracteres comodín (*).

Tipo:	String
Posición:	0
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-NoClobber

Hace que el comando devuelva un error si ya existe un secreto con el mismo nombre en el almacén. De forma predeterminada, este cmdlet actualiza el secreto con el nuevo valor si ya existe.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	False
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Secret

Especifica el valor del secreto. El objeto debe ser uno de los tipos admitidos:

Byte[]
cadena
SecureString
PSCredential
hashtable

Tipo:	Object
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-SecretInfo

Especifica un objeto SecretInformation que describe un secreto almacenado devuelto por Get-SecretInfo. Esto permite copiar secretos de un almacén de extensiones a otro.

Tipo:	Microsoft.PowerShell.SecretManagement.SecretInformation
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-SecureStringSecret

Especifica el valor del secreto como un objeto SecretString.

Tipo:	SecureString
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-Vault

Especifica el nombre del almacén en el que se va a agregar o actualizar el secreto. No se permiten caracteres comodín (*). De forma predeterminada, el secreto se agrega o actualiza en el almacén predeterminado del usuario actual.

Tipo:	String
Posición:	2
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-WhatIf

Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

Tipo:	SwitchParameter
Alias:	wi
Posición:	Named
Valor predeterminado:	False
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

Entradas

Hashtable

Salidas

None

Notas

Al ejecutar Set-Secret con el parámetro Name para especificar el nombre del secreto, el cmdlet llama a GetSecret() que implementa la extensión del almacén. Set-Secret pasa por el nombre proporcionado por el usuario. La extensión del almacén busca el secreto por ese nombre. Si GetSecret() devuelve una coincidencia, Set-Secret sobrescribe el secreto a menos que use el parámetro NoClobber. La extensión del almacén siempre escribe la información secreta que recibe.

Depende de la implementación de la extensión del almacén decidir si se debe usar o no una comparación que distingue mayúsculas de minúsculas en el nombre. Por ejemplo, los nombres de secreto de la microsoft.PowerShell.SecretStore almacén de extensiones no distinguen mayúsculas de minúsculas. Si el nombre que pasa a Set-Secret difiere solo por mayúsculas y minúsculas con el nombre de un secreto existente en un almacén de SecretStore, el nombre se sobrescribe con el nuevo valor proporcionado.