Set-SecretInfo

Référence

Module:: Microsoft.PowerShell.SecretManagement

Ajoute ou remplace des métadonnées de secret supplémentaires à un secret actuellement stocké dans un coffre.

Syntaxe

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

Cette applet de commande ajoute des informations de métadonnées supplémentaires à un secret stocké. La prise en charge des métadonnées est une fonctionnalité facultative pour un coffre d’extensions. Si un coffre ne prend pas en charge les métadonnées secrètes, l’applet de commande retourne une erreur.

Les métadonnées ne sont pas stockées en toute sécurité dans un coffre. Les métadonnées ne doivent pas contenir d’informations sensibles.

Exemples

Exemple 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]}

Cet exemple ajoute des métadonnées au secret Secret1 stocké dans Vault1 coffre. Get-SecretInfo récupère les métadonnées de Secret1 pour afficher les métadonnées ajoutées.

Exemple 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.

Cet exemple ajoute des métadonnées au secret Secret2 stocké dans Vault2 coffre. Toutefois, Vault2 ne prend pas en charge les métadonnées. La commande échoue et retourne une erreur.

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Alias:	cf
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Metadata

Spécifie une table de hachage contenant des paires clé-valeur à associer au secret dans le coffre. Le coffre d’extensions spécifié peut ne pas prendre en charge les métadonnées secrètes. Si le coffre ne prend pas en charge les métadonnées, l’opération échoue et retourne une erreur. Les valeurs de toutes les métadonnées de la table de hachage doivent être l’un des types suivants :

chaîne
int
DateTime

Les métadonnées ne sont pas stockées en toute sécurité dans un coffre. Les métadonnées ne doivent pas contenir d’informations sensibles.

Type:	Hashtable
Position:	1
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Name

Spécifie le nom du secret à laquelle ajouter des métadonnées. Les caractères génériques (*) ne sont pas autorisés.

Type:	String
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-NoClobber

Indique que la commande doit s’erreur si un secret portant le même nom existe déjà dans le coffre. Par défaut, cette applet de commande met à jour le secret avec la nouvelle valeur s’il existe déjà.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Secret

Spécifie la valeur du secret. Le type d’objet doit être l’un des types pris en charge :

byte[]
chaîne
secureString
PSCredential
de table de hachage

Type:	Object
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-SecretInfo

Spécifie un objet SecretInformation décrivant un secret stocké retourné par Get-SecretInfo. Cela permet de copier des secrets d’un coffre d’extensions vers un autre.

Type:	SecretInformation
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-SecureStringSecret

Spécifie la valeur du secret en tant qu’objet SecretString.

Type:	SecureString
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Vault

Spécifie le nom du coffre contenant le secret pour lequel ajouter ou mettre à jour les métadonnées. Les caractères génériques (*) ne sont pas autorisés. Par défaut, cette applet de commande recherche le secret dans le coffre par défaut de l’utilisateur actuel.

Type:	String
Position:	2
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Alias:	wi
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

Entrées

Hashtable

Sorties

None

Partager via