Set-SecretInfo

Módulo:

Microsoft.PowerShell.SecretManagement

Adiciona ou substitui metadados secretos adicionais a um segredo atualmente armazenado num cofre.

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 adiciona informações de metadados adicionais a um segredo armazenado. O suporte de metadados é uma funcionalidade opcional para um cofre de extensões. Se um cofre não suportar metadados secretos, o cmdlet devolve um erro.

Os metadados não são armazenados de forma segura num cofre. Os metadados não devem conter informações confidenciais.

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 Secret1 segredo armazenado no Vault1 cofre. Get-SecretInfo obtém 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: Cannot set secret metadata Secret2. Vault Vault2 does not support secret metadata.

Este exemplo adiciona metadados ao Secret2 segredo armazenado no Vault2 cofre. No entanto, Vault2 não suporta metadados. O comando falha e devolve um erro.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

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

-Metadata

Especifica uma Tabela Hash que contém pares chave-valor para associar ao segredo no cofre. O cofre de extensões especificado pode não suportar metadados secretos. Se o cofre não suportar metadados, a operação falha e devolve um erro. Os valores de quaisquer metadados na tabela hash têm de ser um dos seguintes tipos:

• string
• int
• DateTime

Os metadados não são armazenados de forma segura num cofre. Os metadados não devem conter informações confidenciais.

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

-Name

Especifica o nome do segredo ao que pretende adicionar metadados. Os carateres universais (*) não são permitidos.

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

-NoClobber

Indica que o comando deve efetuar um erro se já existir um segredo com o mesmo nome no cofre. Por predefinição, este cmdlet atualiza o segredo com o novo valor, se já existir.

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

-Secret

Especifica o valor do segredo. O tipo de objeto tem de ser um dos tipos suportados:

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

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

-SecretInfo

Especifica um objeto SecretInformation que descreve um segredo armazenado devolvido por Get-SecretInfo. Isto permite copiar segredos de um cofre de extensão para outro.

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

-SecureStringSecret

Especifica o valor do segredo como um objeto SecretString .

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

-Vault

Especifica o nome do cofre que contém o segredo para adicionar ou atualizar os metadados. Os carateres universais (*) não são permitidos. Por predefinição, este cmdlet procura o segredo no cofre predefinido do utilizador atual.

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

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

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

Entradas

Hashtable

Saídas

None