Update-AzureKeyVaultKey

參考

模組:: AzureRM.KeyVault

更新金鑰保存庫中金鑰的屬性。

警告

自 2024 年 2 月 29 日起，AzureRM PowerShell 模組已正式淘汰。建議使用者從 AzureRM 遷移至 Az PowerShell 模組，以確保持續支援和更新。

雖然 AzureRM 模組可能仍可運作，但不再維護或支援它，但會根據用戶的判斷權和風險放置任何繼續使用。如需轉換至 Az 模組的指引，請參閱我們的移轉資源。

語法

Update-AzureKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-KeyOps <String[]>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update-AzureKeyVaultKey Cmdlet 會更新密鑰保存庫中密鑰的可編輯屬性。

範例

範例 1：修改金鑰以啟用金鑰，並設定到期日和標籤

PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
PS C:\> Update-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru

Vault Name     : Contoso
Name           : ITSoftware
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        : 5/25/2020 7:58:07 PM
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 5/25/2018 7:59:02 PM
Purge Disabled : False
Tags           : Name        Value
                 Severity    high
                 Accounting  true

第一個命令會使用 Get-Date Cmdlet 建立 DateTime 物件。該物件會指定未來兩年的時間。命令會將該日期儲存在$Expires變數中。如需詳細資訊，請輸入 Get-Help Get-Date。第二個命令會建立變數來儲存高嚴重性和會計的標記值。最後一個命令會修改名為 ITSoftware 的金鑰。命令會啟用金鑰、將其到期時間設定為儲存在$Expires的時間，並設定儲存在 $Tags 中的標記。

範例 2：修改索引鍵以刪除所有標記

PS C:\> Update-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{}

Vault Name     : Contoso
Name           : ITSoftware
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        : 5/25/2020 7:58:07 PM
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 5/25/2018 8:00:08 PM
Purge Disabled : False
Tags           :

此命令會刪除名稱為 ITSoftware 之特定金鑰版本的所有標記。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

類型:	SwitchParameter
別名:	cf
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:	IAzureContextContainer
別名:	AzureRmContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Enable

true 的值會啟用索引鍵，而 false 的值會停用索引鍵。如果未指定，現有的啟用/停用狀態會維持不變。

類型:	Nullable<T>[Boolean]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Expires

金鑰的到期時間，以 UTC 時間表示。如果未指定，則金鑰的現有到期時間會保持不變。

類型:	Nullable<T>[DateTime]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-InputObject

Key 物件

類型:	PSKeyVaultKeyIdentityItem
Position:	0
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-KeyOps

可以使用索引鍵執行的作業。如果未指定，則金鑰的現有金鑰作業會保持不變。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Name

索引鍵名稱。 Cmdlet 會從保存庫名稱建構密鑰的 FQDN，目前選取的環境和金鑰名稱。

類型:	String
別名:	KeyName
Position:	1
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-NotBefore

無法使用索引鍵的UTC時間。如果未指定，則索引鍵的現有 NotBefore 屬性會保持不變。

類型:	Nullable<T>[DateTime]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-PassThru

Cmdlet 預設不會傳回物件。如果指定此參數，則會傳回更新的金鑰配套物件。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Tag

哈希表代表索引鍵標記。如果未指定，索引鍵的現有標記會保持不變。

類型:	Hashtable
別名:	Tags
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-VaultName

保存庫名稱。 Cmdlet 會根據名稱和目前選取的環境來建構保存庫的 FQDN。

類型:	String
Position:	0
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-Version

金鑰版本。 Cmdlet 會從保存庫名稱、目前選取的環境、金鑰名稱和金鑰版本建構金鑰的 FQDN。

類型:	String
別名:	KeyVersion
Position:	2
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-WhatIf

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

類型:	SwitchParameter
別名:	wi
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

PSKeyVaultKeyIdentityItem

參數：InputObject （ByValue）

輸出

PSKeyVaultKey

共用方式為