共用方式為

Update-AzKeyVaultKey

模組:
Az.KeyVault Module

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

語法

Default (預設值) 

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

HsmInteractive 

Update-AzKeyVaultKey
    [-Name] <String>
    [[-Version] <String>]
    -HsmName <String>
    [-Enable <Boolean>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-KeyOps <String[]>]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-Tag <Hashtable>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject 

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

Description

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

範例

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

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
Update-AzKeyVaultKey -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：修改索引鍵以刪除所有標籤

Update-AzKeyVaultKey -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
預設值:None
支援萬用字元:False
不要顯示:False
別名:參見

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DefaultProfile

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

參數屬性

類型:IAzureContextContainer
預設值:None
支援萬用字元:False
不要顯示:False
別名:AzContext, AzureRmContext, AzureCredential

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Enable

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

參數屬性

類型:

Nullable<T>[Boolean]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Expires

UTC 時間中金鑰的到期時間。 如果未指定，則金鑰的現有到期時間保持不變。 請注意，BYOK程式中使用的金鑰交換金鑰會忽略過期。

參數屬性

類型:

Nullable<T>[DateTime]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-HsmName

HSM 名稱。 Cmdlet 會根據名稱和目前選取的環境來建構受控 HSM 的 FQDN。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

HsmInteractive
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Immutable

將發行原則設定為不可變狀態。 一旦標示為不可變，此旗標就無法重設，而且在任何情況下都無法變更原則。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

HsmInteractive
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-InputObject

索引鍵物件

參數屬性

類型:PSKeyVaultKeyIdentityItem
預設值:None
支援萬用字元:False
不要顯示:False

參數集

InputObject
Position:0
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-KeyOps

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

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Name

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:鍵名

參數集

Default
Position:1
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
HsmInteractive
Position:1
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-NotBefore

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

參數屬性

類型:

Nullable<T>[DateTime]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PassThru

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ReleasePolicyPath

包含 JSON 原則定義之檔案的路徑。 可匯出金鑰的原則規則。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

HsmInteractive
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Tag

雜湊表代表索引鍵標籤。 如果未指定，則金鑰的現有標籤會保持不變。

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False
別名:Tags

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-VaultName

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Default
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Version

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:金鑰版本

參數集

(All)
Position:2
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元: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。

輸入

PSKeyVaultKeyIdentityItem

輸出

PSKeyVaultKey