Set-SecretInfo
Adiciona ou substitui metadados secretos adicionais a um segredo atualmente armazenado em um cofre.
Sintaxe
NameParameterSet (Predefinição)
Set-SecretInfo
[-Name] <String>
[-Metadata] <Hashtable>
[[-Vault] <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InfoParameterSet
Set-SecretInfo
[-Metadata] <Hashtable>
-InputObject <SecretInformation>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Este cmdlet adiciona metadados secretos adicionais a um segredo existente. O suporte a metadados é um recurso opcional para um cofre de extensão. O comando lança um erro se um cofre não suportar metadados secretos. Metadata é um objeto Hashtable que contém pares Name/Value. Os metadados são armazenados sem encriptação. Você não deve armazenar informações confidenciais nos metadados.
Exemplos
Exemplo 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]}
Este exemplo adiciona metadados ao segredo de Secret1 armazenado em Vault1 cofre.
Get-SecretInfo recupera os metadados para Secret1 mostrar os metadados adicionados.
Exemplo 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.
Este exemplo adiciona metadados ao segredo de Secret2 armazenado em Vault2 cofre. No entanto, Vault2 não suporta metadados. O comando falha e retorna um erro.
Exemplo 3
Get-SecretInfo -Name Secret3 |
Set-SecretInfo -Metadata @{ Created = (Get-Date) }
Este exemplo canaliza um objeto SecretInformation para o Set-SecretInfo comando e adiciona metadados ao segredo associado.
Parâmetros
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Cf. |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-InputObject
Esse parâmetro usa um objeto SecretInformation que define o segredo a ser atualizado.
Propriedades dos parâmetros
| Tipo: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
InfoParameterSet
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Metadata
Especifica um Hashtable contendo pares chave-valor a serem associados ao segredo no cofre. O cofre de extensão especificado pode não suportar metadados secretos. Se o cofre não oferecer suporte a metadados, a operação falhará e retornará um erro. Os valores de quaisquer metadados na hashtable devem ser de um dos seguintes tipos:
- string
- int
- Data/Hora
Os metadados não são armazenados de forma segura num cofre. Os metadados não devem conter informações confidenciais.
Propriedades dos parâmetros
| Tipo: | Hashtable |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
NameParameterSet
| Position: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
System.Collections.Hashtable
| Position: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Name
Especifica o nome do segredo ao qual adicionar metadados. Caracteres curinga (*) não são permitidos.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
NameParameterSet
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Vault
Especifica o nome do cofre que contém o segredo para adicionar ou atualizar os metadados. Caracteres curinga (*) não são permitidos. Por padrão, esse cmdlet procura o segredo no cofre padrão do usuário atual.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
NameParameterSet
| Position: | 2 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Wi |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
