Set-SecretInfo

Referenz

Modul:: Microsoft.PowerShell.SecretManagement

Fügt einem Geheimnis, das derzeit in einem Tresor gespeichert ist, zusätzliche Geheimmetadaten hinzu oder ersetzt sie.

Syntax

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

Beschreibung

Dieses Cmdlet fügt einem gespeicherten Geheimnis zusätzliche Metadateninformationen hinzu. Metadatenunterstützung ist ein optionales Feature für einen Erweiterungstresor. Wenn ein Tresor keine geheimen Metadaten unterstützt, gibt das Cmdlet einen Fehler zurück.

Metadaten werden nicht sicher in einem Tresor gespeichert. Metadaten sollten keine vertraulichen Informationen enthalten.

Beispiele

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

In diesem Beispiel werden dem Secret1 im Vault1 Tresor gespeicherten Geheimnis Metadaten hinzugefügt. Get-SecretInfo ruft die Metadaten für Secret1 ab, um die hinzugefügten Metadaten anzuzeigen.

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

In diesem Beispiel werden dem Secret2 im Vault2 Tresor gespeicherten Geheimnis Metadaten hinzugefügt. Metadaten werden jedoch Vault2 nicht unterstützt. Der Befehl schlägt fehl und gibt einen Fehler zurück.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Metadata

Gibt eine Hashtabelle an, die Schlüssel-Wert-Paare enthält, die dem Geheimnis im Tresor zugeordnet werden sollen. Der angegebene Erweiterungstresor unterstützt möglicherweise keine geheimen Metadaten. Wenn der Tresor keine Metadaten unterstützt, schlägt der Vorgang fehl und gibt einen Fehler zurück. Die Werte aller Metadaten in der Hashtabelle müssen einer der folgenden Typen sein:

string
int
DateTime

Metadaten werden nicht sicher in einem Tresor gespeichert. Metadaten sollten keine vertraulichen Informationen enthalten.

Type:	Hashtable
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Gibt den Namen des Geheimnisses an, dem Metadaten hinzugefügt werden sollen. Wildcardzeichen (*) sind nicht zulässig.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoClobber

Gibt an, dass der Befehl einen Fehler ausführen soll, wenn bereits ein Geheimnis mit demselben Namen im Tresor vorhanden ist. Standardmäßig aktualisiert dieses Cmdlet das Geheimnis mit dem neuen Wert, sofern er bereits vorhanden ist.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Secret

Gibt den Wert des Geheimnisses an. Der Objekttyp muss einer der unterstützten Typen sein:

Byte[]
String
SecureString
PSCredential
Hashtable

Type:	Object
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SecretInfo

Gibt ein SecretInformation-Objekt an, das ein gespeichertes Geheimnis beschreibt, das von zurückgegeben wird Get-SecretInfo. Dies ermöglicht das Kopieren von Geheimnissen aus einem Erweiterungstresor in einen anderen.

Type:	SecretInformation
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SecureStringSecret

Gibt den Wert des Geheimnisses als SecretString-Objekt an.

Type:	SecureString
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Vault

Gibt den Namen des Tresors an, der das Geheimnis enthält, für das die Metadaten hinzugefügt oder aktualisiert werden sollen. Wildcardzeichen (*) sind nicht zulässig. Standardmäßig sucht dieses Cmdlet nach dem Geheimnis im Standardtresor des aktuellen Benutzers.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Eingaben

Hashtable

Ausgaben

None

Freigeben über