Set-Secret
SecretManagement kayıtlı kasasına gizli dizi ekler.
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
Bu cmdlet, kasaya ada göre bir gizli dizi değeri ekler. Kasa adı belirtilmediğinde gizli dizi varsayılan kasaya eklenir. Bu adda bir gizli dizi varsa üzerine yazılır. Uzantı kasası tarafından destekleniyorsa gizli diziye ek veriler eklenebilir.
Varsayılan parametre kümesi bir SecureString nesnesi alır. Komutu gizli dizi değerini belirtmeden çalıştırırsanız, cmdlet bir SecureString girmenizi ister. Dizenin metni konsolda görünmez.
Örnekler
Örnek 1
Set-Secret -Name Secret1 -Secret "SecretValue"
Get-Secret -Name Secret1
System.Security.SecureString
Bu örnek, düz metin değerine SecretValue
sahip adlı Secret1
bir gizli dizi ekler. Kasa adı belirtilmediğinden, gizli dizi geçerli kullanıcının varsayılan kasasına eklenir. Get-Secret
gizli dizinin eklendiğini gösterir.
Örnek 2
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
Bu örnek, kasaya LocalStore
adlı Secret2
bir gizli dizi ekler. Gizli dizi değeri sağlanmadığından, cmdlet bir SecureString değeri ister. Konsol, yazıldığı dize değerini gizler. Get-Secret
gizli dizinin eklendiğini gösterir.
Örnek 3
$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]}
Bu örnek, gizli dizinin son kullanma tarihini belirten meta verileri içeren adlı TargetSecret
LocalStore
bir gizli diziyi kasaya ekler. Get-SecretInfo
yeni oluşturulan gizli dizi için meta verileri alır.
Örnek 4
$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.
Bu örnek, ek meta verilerle kasaya LocalStore2
adlı PublishSecret
bir gizli dizi ekler.
Ancak kasa LocalStore2
gizli meta verileri desteklemez ve işlem bir hata döndürür.
Parametreler
-Confirm
Cmdlet'i çalıştırmadan önce sizden onay ister.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Metadata
Kasadaki gizli diziyle ilişkilendirilecek anahtar-değer çiftlerini içeren bir Hashtable belirtir. Belirtilen uzantı kasası gizli meta verileri desteklemiyor olabilir. Kasa meta verileri desteklemiyorsa işlem başarısız olur ve bir hata döndürür. Karma tablodaki herhangi bir meta verinin değerleri aşağıdaki türlerden biri olmalıdır:
- Dize
- Int
- Tarih Saat
Meta veriler kasada güvenli bir şekilde depolanmaz. Meta veriler hassas bilgiler içermemelidir.
Type: | Hashtable |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Eklenecek veya güncelleştirilecek gizli dizinin adını belirtir. Joker karakterlere (*
) izin verilmez.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoClobber
Kasada aynı ada sahip bir gizli dizi zaten varsa komutun hata döndürmesine neden olur. Varsayılan olarak, bu cmdlet zaten varsa gizli diziyi yeni değerle güncelleştirir.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Secret
Gizli dizinin değerini belirtir. Nesne desteklenen türlerden biri olmalıdır:
- Bayt[]
- Dize
- Securestring
- PSCredential
- Hashtable
Type: | Object |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SecretInfo
tarafından Get-SecretInfo
döndürülen saklı gizli diziyi açıklayan secretInformation nesnesini belirtir.
Bu, gizli dizilerin bir uzantı kasasından diğerine kopyalanmasını sağlar.
Type: | SecretInformation |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SecureStringSecret
SecretString nesnesi olarak gizli dizinin değerini belirtir.
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Vault
Gizli dizinin ekleneceği veya güncelleştirilecek kasanın adını belirtir. Joker karakterlere (*
) izin verilmez. Varsayılan olarak, gizli dizi geçerli kullanıcının varsayılan kasasına eklenir veya güncelleştirilir.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Cmdlet çalıştırılıyorsa ne olacağını gösterir. Cmdlet çalıştırılmıyor.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Girişler
Çıkışlar
None
Notlar
Gizli dizinin adını belirtmek için Name parametresiyle çalıştırdığınızdaSet-Secret
, cmdlet kasa uzantısı tarafından uygulanan çağrıları GetSecret()
çağırır. Set-Secret
kullanıcı tarafından sağlanan adı geçirir. Kasa uzantısı gizli diziyi bu ada göre arar. Eşleşme döndürürse GetGecret()
, Set-Secret
NoClobber parametresini kullanmadığınız sürece gizli dizinin üzerine yazar. Kasa uzantısı her zaman aldığı gizli bilgileri yazar.
Ad üzerinde büyük/küçük harfe duyarlı bir karşılaştırma kullanıp kullanmamaya karar vermek kasa uzantısı uygulamasına bağlıdır. Örneğin, Microsoft.PowerShell.SecretStore uzantı kasasındaki gizli dizi adları büyük/küçük harfe duyarlı değildir. Geçirdiğiniz Set-Secret
ad yalnızca SecretStore kasasında var olan bir gizli dizinin adıyla farklıysa, sağladığınız yeni değerle adın üzerine yazılır.
PowerShell