Update-AzKeyVaultKey

リファレンス

モジュール:: Az.KeyVault

キーコンテナー内のキーの属性を更新します。

構文

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

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

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

説明

Update-AzKeyVaultKey コマンドレットは、キーコンテナー内のキーの編集可能な属性を更新します。

例

例 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 コマンドレットを使用して DateTime オブジェクトを作成します。そのオブジェクトは、2 年後の時刻を指定します。このコマンドは、その日付を $Expires 変数に格納します。詳細を表示するには「Get-Help Get-Date」を入力します。 2 番目のコマンドは、重大度が高いタグ値とアカウンティングを格納する変数を作成します。最後のコマンドは、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

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Enable

値が true の場合、キーが有効になり、値が false の場合はキーが無効になります。指定しない場合、既存の有効/無効状態メイン変更されません。

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Expires

キーの有効期限 (UTC 時刻)。指定しない場合、キーの既存の有効期限は変更されませんメイン。 BYOK プロセスで使用されるキー交換キーの有効期限は無視されます。

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HsmName

HSM 名。コマンドレットは、名前と現在選択されている環境に基づいて、マネージド HSM の FQDN を構築します。

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

-Immutable

リリースポリシーを変更できない状態として設定します。変更不可としてマークされると、このフラグをリセットできず、どのような状況でもポリシーを変更することはできません。

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

-InputObject

キーオブジェクト

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

-KeyOps

キーで実行できる操作。指定しない場合、キーの既存のキー操作メイン変更されません。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

キー名。コマンドレットは、コンテナー名 (現在選択されている環境とキー名) からキーの FQDN を構築します。

Type:	String
Aliases:	KeyName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NotBefore

キーを使用できない UTC 時刻。指定しない場合、キーの既存の NotBefore 属性メイン変更されません。

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

コマンドレットは、既定ではオブジェクトを返しません。このスイッチが指定されている場合は、更新されたキーバンドルオブジェクトを返します。

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

-ReleasePolicyPath

JSON ポリシー定義を含むファイルへのパス。キーをエクスポートできるポリシールール。

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

-Tag

ハッシュテーブルはキータグを表します。指定しない場合、キーの既存のタグメイン変更されません。

Type:	Hashtable
Aliases:	Tags
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultName

コンテナー名。コマンドレットは、名前と現在選択されている環境に基づいて、コンテナーの FQDN を構築します。

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

-Version

キーのバージョン。コマンドレットは、コンテナー名、現在選択されている環境、キー名、およびキーのバージョンからキーの FQDN を構築します。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

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

入力

PSKeyVaultKeyIdentityItem

出力

PSKeyVaultKey