Set-SecretInfo
Agrega o reemplaza metadatos de secreto adicionales a un secreto almacenado actualmente en un almacén.
Sintaxis
NameParameterSet (Es el valor predeterminado).
Set-SecretInfo
[-Name] <String>
[-Metadata] <Hashtable>
[[-Vault] <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InfoParameterSet
Set-SecretInfo
[-Metadata] <Hashtable>
-InputObject <SecretInformation>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Este cmdlet agrega metadatos de secreto adicionales a un secreto existente. La compatibilidad con metadatos es una característica opcional para un almacén de extensiones. El comando genera un error si un almacén no admite metadatos secretos. Los metadatos son un objeto Hashtable que contiene pares Nombre/Valor. Los metadatos se almacenan sin cifrar. No debe almacenar información confidencial en los metadatos.
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 de Secret1 almacenado en Vault1 almacén.
Get-SecretInfo recupera los metadatos de Secret1 para mostrar los metadatos agregados.
Ejemplo 2
Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{
Expiration = ([datetime]::new(2022, 5, 1))
}
Set-SecretInfo: Can't set secret metadata Secret2. Vault Vault2 doesn't support secret metadata.
En este ejemplo se agregan metadatos al secreto de Secret2 almacenado en Vault2 almacén. Sin embargo, Vault2 no admite metadatos. El comando produce un error y devuelve un error.
Ejemplo 3
Get-SecretInfo -Name Secret3 |
Set-SecretInfo -Metadata @{ Created = (Get-Date) }
En este ejemplo se canaliza un objeto SecretInformation al Set-SecretInfo comando y se agregan metadatos al secreto asociado.
Parámetros
-Confirm
Le pide confirmación antes de ejecutar el cmdlet.
Propiedades del parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | cf |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Mandatory: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-InputObject
Este parámetro toma un objeto SecretInformation que define el secreto que se va a actualizar.
Propiedades del parámetro
| Tipo: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
InfoParameterSet
| Posición: | Named |
| Mandatory: | True |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | 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.
Propiedades del parámetro
| Tipo: | Hashtable |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | 1 |
| Mandatory: | True |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
System.Collections.Hashtable
| Posición: | 1 |
| Mandatory: | 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 al que se van a agregar metadatos. No se permiten caracteres comodín (*).
Propiedades del parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | 0 |
| Mandatory: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | 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.
Propiedades del parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | 2 |
| Mandatory: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-WhatIf
Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.
Propiedades del parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | Wi |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Mandatory: | 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.