Set-SecretInfo
將其他秘密元數據新增或取代至目前儲存在保存庫中的秘密。
語法
NameParameterSet (預設值)
Set-SecretInfo
[-Name] <String>
[-Metadata] <Hashtable>
[[-Vault] <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InfoParameterSet
Set-SecretInfo
[-Metadata] <Hashtable>
-InputObject <SecretInformation>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
此 cmdlet 將其他機密元數據添加到現有機密中。 元數據支援是擴充功能保存庫的選擇性功能。 如果檔庫不支援機密元數據，該命令將引發錯誤。 元數據是包含名稱/值對的 Hashtable 物件。 元數據以未加密的方式存儲。 您不應在元數據中存儲敏感資訊。
範例
範例 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]}
本範例會將元數據新增至儲存在 Secret1 保存庫中的 Vault1 秘密。
Get-SecretInfo 擷取 Secret1 的元數據，以顯示新增的元數據。
範例 2
Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{
Expiration = ([datetime]::new(2022, 5, 1))
}
Set-SecretInfo: Can't set secret metadata Secret2. Vault Vault2 doesn't support secret metadata.
本範例會將元數據新增至儲存在 Secret2 保存庫中的 Vault2 秘密。 不過，Vault2 不支持元數據。 命令失敗並傳回錯誤。
範例 3
Get-SecretInfo -Name Secret3 |
Set-SecretInfo -Metadata @{ Created = (Get-Date) }
此示例通過管道將 SecretInformation 對象傳遞給命令， Set-SecretInfo 並將元數據添加到關聯的密鑰中。
參數
-Confirm
在執行 Cmdlet 之前，提示您進行確認。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | cf |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-InputObject
此參數採用定義要更新的密鑰的 SecretInformation 物件。
參數屬性
| 類型: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
InfoParameterSet
| Position: | Named |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Metadata
指定 哈希表 包含金鑰/值組，以與保存庫中的秘密產生關聯。 指定的擴充功能保存庫可能不支援秘密元數據。 如果保存庫不支援元數據，則作業會失敗並傳回錯誤。 哈希表中任何元數據的值必須是下列其中一種類型：
- 字串
- int
- 日期時間
元數據不會安全地儲存在保存庫中。 元數據不應包含敏感性資訊。
參數屬性
| 類型: | Hashtable |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
NameParameterSet
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
System.Collections.Hashtable
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
指定要新增元數據的秘密名稱。 不允許通配符（*）。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
NameParameterSet
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Vault
指定要新增或更新元數據之秘密的保存庫名稱。 不允許通配符（*）。 根據預設，此 Cmdlet 會在目前用戶的預設保存庫中尋找秘密。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
NameParameterSet
| Position: | 2 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 該 Cmdlet 未被執行。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 無線 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
