Set-SecretInfo

Módulo:

Microsoft.PowerShell.SecretManagement

Agrega o reemplaza metadatos secretos adicionales a un secreto almacenado actualmente en un almacén.

Syntax

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

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

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

Description

Este cmdlet agrega información de metadatos adicional a un secreto almacenado. La compatibilidad con metadatos es una característica opcional para un almacén de extensiones. Si un almacén no admite metadatos secretos, el cmdlet devuelve un error.

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

Ejemplos

Ejemplo 1

Set-SecretInfo -Name Secret1 -Vault Vault1 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Get-SecretInfo -Name Secret1 -Vault Vault1 | Select-Object Name,Metadata

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

En este ejemplo se agregan metadatos al secreto almacenado en Vault1 el Secret1 almacén. Get-SecretInfo recupera los metadatos para Secret1 que muestren los metadatos agregados.

Ejemplo 2

Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }

Set-SecretInfo: Cannot set secret metadata Secret2. Vault Vault2 does not support secret metadata.

En este ejemplo se agregan metadatos al secreto almacenado en Vault2 el Secret2 almacén. Sin embargo, Vault2 no admite metadatos. El comando produce un error y devuelve un error.

Parámetros

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

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

-Metadata

Especifica una tabla hash 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 devuelve un error. Los valores de cualquier metadato de la tabla hash deben ser uno de los siguientes tipos:

• string
• int
• DateTime

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

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

-Name

Especifica el nombre del secreto al que se van a agregar metadatos. No se permiten caracteres comodín (*).

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

-NoClobber

Indica que el comando debe producir 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.

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

-Secret

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

• Byte[]
• String
• SecureString
• PSCredential
• Hashtable

Type:	Object
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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.

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

-SecureStringSecret

Especifica el valor del secreto como un objeto SecretString .

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

-Vault

Especifica el nombre del almacén que contiene el secreto para el que se van a agregar o actualizar los metadatos. No se permiten caracteres comodín (*). De forma predeterminada, este cmdlet busca el secreto en el almacén predeterminado del usuario actual.

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

-WhatIf

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

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

Entradas

Hashtable

Salidas

None