Set-SecretInfo

Moduł:

Microsoft.PowerShell.SecretManagement

Dodaje lub zastępuje dodatkowe metadane wpisu tajnego do wpisu tajnego aktualnie przechowywanego w magazynie.

Składnia

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

Opis

To polecenie cmdlet dodaje dodatkowe informacje o metadanych do przechowywanego wpisu tajnego. Obsługa metadanych to opcjonalna funkcja magazynu rozszerzeń. Jeśli magazyn nie obsługuje metadanych wpisu tajnego, polecenie cmdlet zwraca błąd.

Metadane nie są bezpiecznie przechowywane w magazynie. Metadane nie powinny zawierać informacji poufnych.

Przykłady

Przykład 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]}

W tym przykładzie dodano metadane do wpisu tajnego przechowywanego Secret1 w Vault1 magazynie. Get-SecretInfo pobiera metadane, Secret1 aby wyświetlić dodane metadane.

Przykład 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.

W tym przykładzie dodano metadane do wpisu tajnego przechowywanego Secret2 w Vault2 magazynie. Vault2 Nie obsługuje jednak metadanych. Polecenie kończy się niepowodzeniem i zwraca błąd.

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

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

-Metadata

Określa tabelę skrótu zawierającą pary klucz-wartość do skojarzenia z wpisem tajnym w magazynie. Określony magazyn rozszerzeń może nie obsługiwać metadanych wpisów tajnych. Jeśli magazyn nie obsługuje metadanych, operacja kończy się niepowodzeniem i zwraca błąd. Wartości wszystkich metadanych w tabeli skrótu muszą być jednym z następujących typów:

• ciąg
• Int
• Data/godzina

Metadane nie są bezpiecznie przechowywane w magazynie. Metadane nie powinny zawierać informacji poufnych.

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

-Name

Określa nazwę wpisu tajnego do dodania metadanych. Symbole wieloznaczne (*) nie są dozwolone.

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

-NoClobber

Wskazuje, że polecenie powinno spowodować błąd, jeśli wpis tajny o tej samej nazwie już istnieje w magazynie. Domyślnie to polecenie cmdlet aktualizuje wpis tajny przy użyciu nowej wartości, jeśli już istnieje.

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

-Secret

Określa wartość wpisu tajnego. Typ obiektu musi być jednym z obsługiwanych typów:

• Bajt[]
• Ciąg
• Securestring
• PSCredential
• Hashtable

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

-SecretInfo

Określa obiekt SecretInformation opisujący przechowywany wpis tajny zwrócony przez .Get-SecretInfo Umożliwia to kopiowanie wpisów tajnych z jednego magazynu rozszerzeń do innego.

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

-SecureStringSecret

Określa wartość wpisu tajnego jako obiekt SecretString .

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

-Vault

Określa nazwę magazynu zawierającego wpis tajny, aby dodać lub zaktualizować metadane. Symbole wieloznaczne (*) nie są dozwolone. Domyślnie to polecenie cmdlet wyszukuje wpis tajny w domyślnym magazynie bieżącego użytkownika.

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

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

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

Dane wejściowe

Hashtable

Dane wyjściowe

None