Set-Secret

Referencia

Modul:: Microsoft.PowerShell.SecretManagement

Titkos kulcsot ad hozzá a SecretManagement regisztrált tárolóhoz.

Syntax

Set-Secret
   [-Name] <String>
   -SecureStringSecret <SecureString>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Secret
   [-Name] <String>
   -Secret <Object>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Secret
   -SecretInfo <SecretInformation>
   [-Vault] <String>
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Ez a parancsmag név szerint hozzáad egy titkos értéket egy tárolóhoz. Ha nincs megadva tárolónév, a titkos kód hozzá lesz adva az alapértelmezett tárolóhoz. Ha létezik ilyen nevű titkos kód, azt felülírja a program. Ha a bővítménytároló támogatja, további adatok is szerepelhetnek a titkos kódban.

Az alapértelmezett paraméterkészlet egy SecureString objektumot vesz fel. Ha a parancsot a titkos kód értékének megadása nélkül futtatja, a parancsmag a SecureString megadását kéri. A sztring szövege nem látható a konzolon.

Példák

1\. példa

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

System.Security.SecureString

Ez a példa egy nevű Secret1 titkos kódot ad hozzá egyszerű szöveges értékkel SecretValue. Mivel nem adott meg tárolónevet, a rendszer hozzáadja a titkos kódot az aktuális felhasználó alapértelmezett tárolóhoz. Get-Secret A a titkos kód hozzáadását mutatja.

2\. példa

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

Ez a példa egy nevű Secret2 titkos kulcsot ad hozzá a LocalStore tárolóhoz. Mivel nem adott meg titkos értéket, a parancsmag SecureString értéket kér. A konzol gépelés közben elrejti a sztringértéket. Get-Secret A a titkos kód hozzáadását mutatja.

3\. példa

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

Ez a példa egy nevű TargetSecret titkos kulcsot ad hozzá a LocalStore tárolóhoz a titkos kód lejárati dátumát jelző metaadatokkal. Get-SecretInfo lekéri az újonnan létrehozott titkos kód metaadatait.

4\. példa

$Metadata = @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Set-Secret -Name PublishSecret -Secret $targetToken -Vault LocalStore2 -Metadata $Metadata

Set-Secret: Cannot store secret PublishSecret. Vault LocalStore2 does not support secret metadata.

Ez a példa egy nevű PublishSecret titkos kulcsot ad hozzá a LocalStore2 tárolóhoz további metaadatokkal. A tároló LocalStore2 azonban nem támogatja a titkos metaadatokat, és a művelet hibát ad vissza.

Paraméterek

-Confirm

Jóváhagyást kér a parancsmag futtatása előtt.

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

-Metadata

Egy kulcs-érték párokat tartalmazó kivonattáblát ad meg, amelyet társítani kell a tárolóban lévő titkos kóddal. Előfordulhat, hogy a megadott bővítménytároló nem támogatja a titkos metaadatokat. Ha a tároló nem támogatja a metaadatokat, a művelet meghiúsul, és hibát ad vissza. A kivonattáblában szereplő metaadatok értékeinek a következő típusok egyikének kell lenniük:

sztring
Int
Dátum/idő

A metaadatok nincsenek biztonságosan tárolva egy tárolóban. A metaadatok nem tartalmazhatnak bizalmas információkat.

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

-Name

Megadja a hozzáadni vagy frissíteni kívánt titkos kód nevét. A helyettesítő karakterek (*) nem engedélyezettek.

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

-NoClobber

A parancs hibát ad vissza, ha már létezik ilyen nevű titkos kód a tárolóban. Alapértelmezés szerint ez a parancsmag frissíti a titkos kódot az új értékkel, ha már létezik.

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

-Secret

A titkos kód értékét adja meg. Az objektumnak az egyik támogatott típusnak kell lennie:

Bájt[]
Sztring
SecureString
PSCredential
Hashtable

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

-SecretInfo

A által visszaadott Get-SecretInfotárolt titkos kulcsot leíró SecretInformation objektumot adja meg. Ez lehetővé teszi a titkos kulcsok másolását az egyik bővítménytárolóból a másikba.

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

-SecureStringSecret

A titkos kód értékét Adja meg SecretString objektumként.

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

-Vault

Megadja annak a tárolónak a nevét, amelyben hozzá szeretné adni vagy frissíteni szeretné a titkos kódot. A helyettesítő karakterek (*) nem engedélyezettek. A titkos kód alapértelmezés szerint az aktuális felhasználó alapértelmezett tárolójában lesz hozzáadva vagy frissítve.

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

-WhatIf

Bemutatja, mi történne a parancsmag futtatásakor. A parancsmag nem fut.

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

Bevitelek

Hashtable

Kimenetek

None

Jegyzetek

Amikor a Name paraméterrel futtatja Set-Secret a titkos kód nevét, a parancsmag meghívja GetSecret() a tárolóbővítmény által implementált parancsmagot. Set-Secret továbbítja a felhasználó által megadott nevet. A tárolóbővítmény ezzel a névvel keresi meg a titkos kódot. Ha GetGecret() egyezést ad vissza, felülírja a titkos kódot, Set-Secret kivéve, ha a NoClobber paramétert használja. A tárolóbővítmény mindig megírja a kapott titkos információkat.

A tárolóbővítmény implementálásán múlik, hogy a név megkülönbözteti-e a kis- és nagybetűk összehasonlítását. A Microsoft.PowerShell.SecretStore bővítménytároló titkos nevei például nem különböztetik meg a kis- és nagybetűket. Ha a megadott Set-Secret név csak a SecretStore-tárolóban meglévő titkos kulcs nevétől függően különbözik, a rendszer felülírja a nevet a megadott új értékkel.

Megosztás a következőn keresztül: