Set-SecretInfo

模組:

Microsoft.PowerShell.SecretManagement

將其他秘密中繼資料新增或取代至目前儲存在保存庫中的秘密。

Syntax

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

Description

此 Cmdlet 會將其他中繼資料資訊新增至預存的秘密。 中繼資料支援是擴充功能保存庫的選擇性功能。 如果保存庫不支援秘密中繼資料，Cmdlet 會傳回錯誤。

中繼資料不會安全地儲存在保存庫中。 中繼資料不應包含敏感性資訊。

範例

範例 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]}

本範例會將中繼資料新增至儲存在保存庫中的 Secret1Vault1 秘密。 Get-SecretInfo 擷取 的中繼資料 Secret1 以顯示新增的中繼資料。

範例 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.

本範例會將中繼資料新增至儲存在保存庫中的 Secret2Vault2 秘密。 不過， Vault2 不支援中繼資料。 命令失敗並傳回錯誤。

參數

-Confirm

在執行 Cmdlet 前提示您確認。

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

-Metadata

指定 雜湊表 ，其中包含要與保存庫中秘密產生關聯的索引鍵/值組。 指定的擴充功能保存庫可能不支援秘密中繼資料。 如果保存庫不支援中繼資料，作業會失敗並傳回錯誤。 雜湊表中任何中繼資料的值必須是下列其中一種類型：

• string
• int
• DateTime

中繼資料不會安全地儲存在保存庫中。 中繼資料不應包含敏感性資訊。

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

-Name

指定要新增中繼資料的秘密名稱。 不允許萬用字元 (*) 。

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

-NoClobber

指出如果保存庫中已有相同名稱的秘密，命令應該就會發生錯誤。 根據預設，如果秘密已經存在，此 Cmdlet 會以新的值更新秘密。

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

-Secret

指定秘密的值。 物件類型必須是其中一種支援的類型：

• Byte[]
• 字串
• SecureString
• PSCredential
• Hashtable

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

-SecretInfo

指定 SecretInformation 物件， 描述 所 Get-SecretInfo 傳回的預存秘密。 這可讓您將秘密從一個延伸保存庫複製到另一個擴充保存庫。

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

-SecureStringSecret

將秘密的值指定為 SecretString 物件。

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

-Vault

指定要新增或更新中繼資料之秘密的保存庫名稱。 不允許萬用字元 (*) 。 根據預設，此 Cmdlet 會在目前使用者的預設保存庫中尋找秘密。

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

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。

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

輸入

Hashtable

輸出

None