Set-Secret

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

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

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

Cette applet de commande ajoute une valeur secrète par nom à un coffre. Quand aucun nom de coffre n’est spécifié, le secret est ajouté au coffre par défaut. Si un secret portant ce nom existe, il est remplacé. Des données supplémentaires peuvent être incluses dans le secret si elles sont prises en charge par le coffre d’extensions.

Le jeu de paramètres par défaut prend un objet SecureString. Si vous exécutez la commande sans spécifier la valeur secrète, l’applet de commande vous invite à entrer un SecureString. Le texte de la chaîne n’est pas visible dans la console.

Set-Secret -Name Secret1 -Secret "SecretValue"
Get-Secret -Name Secret1

System.Security.SecureString

Cet exemple montre comment ajouter un secret nommé Secret1 avec une valeur de texte brut de SecretValue. Étant donné qu’aucun nom de coffre n’a été spécifié, le secret est ajouté au coffre par défaut de l’utilisateur actuel. Get-Secret montre que le secret a été ajouté.

PS C:\> Set-Secret -Name Secret2 -Vault LocalStore

cmdlet Set-Secret at command pipeline position 1
Supply values for the following parameters:
SecureStringSecret: ***********

PS C:\> Get-Secret -Name Secret2
System.Security.SecureString

Cet exemple montre comment ajouter un secret nommé Secret2 au coffre LocalStore. Étant donné qu’aucune valeur secrète n’a été fournie, l’applet de commande demande une valeur SecureString. La console masque la valeur de chaîne telle qu’elle est tapée. Get-Secret montre que le secret a été ajouté.

$Metadata = @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Set-Secret -Name TargetSecret -Secret $targetToken -Vault LocalStore -Metadata $Metadata
Get-SecretInfo -Name TargetSecret | Select-Object Name,Metadata

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

Cet exemple montre comment ajouter un secret nommé TargetSecret au coffre LocalStore avec des métadonnées indiquant la date d’expiration du secret. Get-SecretInfo récupère les métadonnées du secret nouvellement créé.

$Metadata = @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Set-Secret -Name PublishSecret -Secret $targetToken -Vault LocalStore2 -Metadata $Metadata

Set-Secret: Can't store secret PublishSecret. Vault LocalStore2 doesn't support secret metadata.

Cet exemple montre comment ajouter un secret nommé PublishSecret au coffre LocalStore2 avec des métadonnées supplémentaires. Toutefois, le coffre LocalStore2 ne prend pas en charge les métadonnées secrètes et l’opération retourne une erreur.

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Lorsque vous exécutez Set-Secret avec le paramètre Name pour spécifier le nom du secret, l’applet de commande appelle GetSecret() implémentée par l’extension du coffre. Set-Secret passe par le nom fourni par l’utilisateur. L’extension de coffre recherche le secret par ce nom. Si GetSecret() retourne une correspondance, Set-Secret remplace le secret, sauf si vous utilisez le paramètre NoClobber. L’extension de coffre écrit toujours les informations secrètes qu’elle reçoit.

Il appartient à l’implémentation de l’extension du coffre de décider s’il faut ou non utiliser une comparaison sensible à la casse sur le nom. Par exemple, les noms de secrets dans Microsoft.PowerShell.SecretStore coffre d’extensions ne respectent pas la casse. Si le nom que vous passez à Set-Secret diffère uniquement par le cas avec le nom d’un secret existant dans un coffre SecretStore, le nom est remplacé par la nouvelle valeur que vous avez fournie.