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

Dieses Cmdlet fügt einem Tresor einen geheimen Wert nach Namen hinzu. Wenn kein Tresorname angegeben wird, wird der geheime Schlüssel dem Standardtresor hinzugefügt. Wenn ein Geheimschlüssel mit diesem Namen vorhanden ist, wird er überschrieben. Zusätzliche Daten können im geheimen Schlüssel enthalten sein, wenn sie vom Erweiterungstresor unterstützt werden.

Der Standardparametersatz akzeptiert ein SecureString--Objekt. Wenn Sie den Befehl ausführen, ohne den geheimen Wert anzugeben, werden Sie vom Cmdlet aufgefordert, eine SecureString-einzugeben. Der Text der Zeichenfolge ist in der Konsole nicht sichtbar.

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

System.Security.SecureString

In diesem Beispiel wird ein Geheimschlüssel namens Secret1 mit einem Nur-Text-Wert von SecretValuehinzugefügt. Da kein Tresorname angegeben wurde, wird der geheime Schlüssel dem Standardtresor des aktuellen Benutzers hinzugefügt. Get-Secret zeigt, dass der geheime Schlüssel hinzugefügt wurde.

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 diesem Beispiel wird dem Secret2 Tresor ein Geheimschlüssel mit dem Namen LocalStore hinzugefügt. Da kein geheimer Wert angegeben wurde, fordert das Cmdlet einen SecureString- Wert ein. Die Konsole blendet den Zeichenfolgenwert aus, während er eingegeben wird. Get-Secret zeigt, dass der geheime Schlüssel hinzugefügt wurde.

$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 diesem Beispiel wird dem TargetSecret Tresor ein geheimer LocalStore mit Metadaten hinzugefügt, der das Ablaufdatum des geheimen Schlüssels angibt. Get-SecretInfo ruft die Metadaten für den neu erstellten geheimen Schlüssel ab.

$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 diesem Beispiel wird dem PublishSecret Tresor mit zusätzlichen Metadaten ein Geheimschlüssel mit dem Namen LocalStore2 hinzugefügt. Der Tresor LocalStore2 unterstützt jedoch keine geheimen Metadaten, und der Vorgang gibt einen Fehler zurück.

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Wenn Sie Set-Secret mit dem Parameter Name ausführen, um den Namen des geheimen Schlüssels anzugeben, ruft das Cmdlet GetSecret() auf, das von der Vault-Erweiterung implementiert wird. Set-Secret den Vom Benutzer bereitgestellten Namen durchläuft. Die Tresorerweiterung sucht das Geheimnis anhand dieses Namens. Wenn GetSecret() eine Übereinstimmung zurückgibt, überschreibt Set-Secret den geheimen Schlüssel, es sei denn, Sie verwenden den NoClobber Parameter. Die Tresorerweiterung schreibt immer die geheimen Informationen, die sie empfängt.

Es liegt an der Vault-Erweiterungsimplementierung, um zu entscheiden, ob ein Vergleich zwischen Groß- und Kleinschreibung für den Namen verwendet werden soll. Bei geheimen Namen im Microsoft.PowerShell.SecretStore Erweiterungstresor wird die Groß-/Kleinschreibung nicht beachtet. Wenn sich der Name, den Sie an Set-Secret übergeben, nur nach Groß-/Kleinschreibung mit dem Namen eines vorhandenen geheimen Schlüssels in einem SecretStore-Tresor unterscheidet, wird der Name mit dem von Ihnen angegebenen neuen Wert überschrieben.