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

此 Cmdlet 會依名稱將秘密值新增至保存庫。 未指定保存庫名稱時，密碼會新增至預設保存庫。 如果具有該名稱的秘密存在，則會覆寫它。 如果擴充保存庫支援，可以將其他數據包含在秘密中。

默認參數集會採用 SecureString 物件。 如果您執行命令而不指定秘密值，Cmdlet 會提示您輸入 SecureString。 在控制台中看不到字串的文字。

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

System.Security.SecureString

本範例會新增名為 Secret1 且純文本值為 SecretValue的秘密。 由於未指定保存庫名稱，因此密碼會新增至目前用戶的預設保存庫。 Get-Secret 顯示已新增秘密。

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

本範例會將名為 Secret2 的秘密新增至 LocalStore 保存庫。 由於未提供秘密值，因此 Cmdlet 會提示輸入 SecureString 值。 主控台會在輸入字串時隱藏字串值。 Get-Secret 顯示已新增秘密。

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

本範例會將名為 TargetSecret 的秘密新增至 LocalStore 保存庫，其中元數據表示密碼的到期日。 Get-SecretInfo 擷取新建立秘密的元數據。

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

此範例會將名為 PublishSecret 的秘密新增至具有額外元數據的 LocalStore2 保存庫。 不過，保存庫 LocalStore2 不支援秘密元數據，而且作業會傳回錯誤。

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

當您使用 Set-Secret 參數執行 以指定秘密的名稱時，Cmdlet 會呼叫保存庫擴充功能所實作的 GetSecret()。 Set-Secret 傳遞使用者所提供的名稱。 保存庫延伸模組會依該名稱查閱秘密。 如果 GetSecret() 傳回相符專案，除非您使用 Set-Secret 參數，否則 會覆寫秘密。 保存庫延伸模組一律會寫入它收到的秘密資訊。

由保存庫延伸模組實作決定是否要在名稱上使用區分大小寫的比較。 例如，Microsoft.PowerShell.SecretStore 擴充保存庫中的秘密名稱不區分大小寫。 如果您傳遞至 Set-Secret 的名稱只因 SecretStore 保存庫中現有秘密的名稱而有所不同，則會以您提供的新值覆寫名稱。