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

Met deze cmdlet wordt een geheime waarde op naam aan een kluis toegevoegd. Wanneer er geen kluisnaam is opgegeven, wordt het geheim toegevoegd aan de standaardkluis. Als er een geheim met die naam bestaat, wordt het overschreven. Aanvullende gegevens kunnen worden opgenomen in het geheim als deze worden ondersteund door de extensiekluis.

De standaardparameterset heeft een SecureString--object. Als u de opdracht uitvoert zonder de geheime waarde op te geven, wordt u door de cmdlet gevraagd een SecureString-in te voeren. De tekst van de tekenreeks is niet zichtbaar in de console.

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

System.Security.SecureString

In dit voorbeeld wordt een geheim met de naam Secret1 toegevoegd met een tekst zonder opmaakwaarde van SecretValue. Omdat er geen kluisnaam is opgegeven, wordt het geheim toegevoegd aan de standaardkluis van de huidige gebruiker. Get-Secret geeft aan dat het geheim is toegevoegd.

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 dit voorbeeld wordt een geheim met de naam Secret2 toegevoegd aan de LocalStore kluis. Omdat er geen geheime waarde is opgegeven, vraagt de cmdlet om een SecureString--waarde. De console verbergt de tekenreekswaarde terwijl deze wordt getypt. Get-Secret geeft aan dat het geheim is toegevoegd.

$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 dit voorbeeld wordt een geheim met de naam TargetSecret toegevoegd aan de LocalStore kluis met metagegevens die de vervaldatum van het geheim aangeven. Get-SecretInfo de metagegevens voor het zojuist gemaakte geheim ophaalt.

$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 dit voorbeeld wordt een geheim met de naam PublishSecret toegevoegd aan de LocalStore2 kluis met extra metagegevens. Kluis LocalStore2 biedt echter geen ondersteuning voor geheime metagegevens en de bewerking retourneert een fout.

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Wanneer u Set-Secret uitvoert met de parameter Name om de naam van het geheim op te geven, roept de cmdlet GetSecret() aan die is geïmplementeerd door de kluisextensie. Set-Secret de naam doorgeeft zoals opgegeven door de gebruiker. De kluisextensie zoekt het geheim op met die naam. Als GetSecret() een overeenkomst retourneert, overschrijft Set-Secret het geheim, tenzij u de parameter NoClobber gebruikt. De kluisextensie schrijft altijd de geheime informatie die wordt ontvangen.

Het is aan de implementatie van de kluisextensie om te bepalen of een hoofdlettergevoelige vergelijking op de naam moet worden gebruikt. Geheime namen in de Microsoft.PowerShell.SecretStore extensiekluis zijn bijvoorbeeld niet hoofdlettergevoelig. Als de naam die u doorgeeft aan Set-Secret alleen verschilt per geval met de naam van een bestaand geheim in een SecretStore-kluis, wordt de naam overschreven met de nieuwe waarde die u hebt opgegeven.