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

Questo cmdlet aggiunge un valore segreto in base al nome a un insieme di credenziali. Quando non viene specificato alcun nome dell'insieme di credenziali, il segreto viene aggiunto all'insieme di credenziali predefinito. Se esiste un segreto con tale nome, viene sovrascritto. È possibile includere dati aggiuntivi con il segreto, se supportato dall'insieme di credenziali delle estensioni.

Il set di parametri predefinito accetta un oggetto SecureString. Se si esegue il comando senza specificare il valore del segreto, il cmdlet richiede di immettere un SecureString. Il testo della stringa non è visibile nella console.

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

System.Security.SecureString

In questo esempio viene aggiunto un segreto denominato Secret1 con un valore di testo normale di SecretValue. Poiché non è stato specificato alcun nome dell'insieme di credenziali, il segreto viene aggiunto all'insieme di credenziali predefinito dell'utente corrente. Get-Secret mostra che il segreto è stato aggiunto.

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

In questo esempio viene aggiunto un segreto denominato Secret2 all'insieme di credenziali LocalStore. Poiché non è stato specificato alcun valore segreto, il cmdlet richiede un valore SecureString. La console nasconde il valore stringa durante la digitazione. Get-Secret mostra che il segreto è stato aggiunto.

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

In questo esempio viene aggiunto un segreto denominato TargetSecret all'insieme di credenziali LocalStore con metadati che indicano la data di scadenza del segreto. Get-SecretInfo recupera i metadati per il segreto appena creato.

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

In questo esempio viene aggiunto un segreto denominato PublishSecret all'insieme di credenziali LocalStore2 con metadati aggiuntivi. Tuttavia, l'insieme di credenziali LocalStore2 non supporta i metadati segreti e l'operazione restituisce un errore.

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Quando si esegue Set-Secret con il parametro nome per specificare il nome del segreto, il cmdlet chiama GetSecret() implementato dall'estensione dell'insieme di credenziali. Set-Secret passa attraverso il nome fornito dall'utente. L'estensione dell'insieme di credenziali cerca il segreto in base a tale nome. Se GetSecret() restituisce una corrispondenza, Set-Secret sovrascrive il segreto a meno che non si usi il parametro NoClobber. L'estensione dell'insieme di credenziali scrive sempre le informazioni segrete ricevute.

Spetta all'implementazione dell'estensione dell'insieme di credenziali decidere se usare o meno un confronto con distinzione tra maiuscole e minuscole sul nome. Ad esempio, i nomi dei segreti nell'insieme di credenziali delle estensioni di Microsoft.PowerShell.SecretStore non fanno distinzione tra maiuscole e minuscole. Se il nome passato a Set-Secret differisce solo per caso con il nome di un segreto esistente in un insieme di credenziali secretStore, il nome viene sovrascritto con il nuovo valore specificato.