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 将覆盖机密，除非使用 NoClobber 参数。 保管库扩展始终写入它收到的机密信息。

由保管库扩展实现决定是否对名称使用区分大小写的比较。 例如，Microsoft.PowerShell.SecretStore 扩展保管库中的机密名称不区分大小写。 如果传递给 Set-Secret 的名称与 SecretStore 保管库中现有机密的名称不同，则名称将覆盖你提供的新值。