Invoke-AzKeyVaultKeyRotation

  • リファレンス
モジュール:
Az.KeyVault

Key Vault に新しいキー バージョンを作成し、それを格納してから、新しいキーを返します。

構文

Invoke-AzKeyVaultKeyRotation
      [-VaultName] <String>
      [-Name] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzKeyVaultKeyRotation
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

コマンドレットは、キー ポリシーに基づいてキーをローテーションします。 これには、キー/回転アクセス許可が必要です。 回転キーの新しいバージョンが返されます。

例

例 1

Invoke-AzKeyVaultKeyRotation -VaultName test-kv -Name test-key

Vault/HSM Name : test-kv
Name           : test-key
Key Type       : RSA
Key Size       : 2048
Curve Name     :
Version        : xxxxxxxxxxxxxx4939xxxxxxxxxxxxxxxx
Id             : https://test-kv.vault.azure.net:443/keys/test-key/xxxxxxxxxxxxxx4939xxxxxxxxxxxxxxxx
Enabled        : True
Expires        :
Not Before     :
Created        : 12/10/2021 2:57:58 AM
Updated        : 12/10/2021 2:57:58 AM
Recovery Level : Recoverable+Purgeable
Tags           :

このコマンドレットは、test-key の新しいキー バージョンを作成します。

パラメーター

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

キー オブジェクト

型:PSKeyVaultKeyIdentityItem
Aliases:Key
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

キー名。

型:String
Aliases:KeyName
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-VaultName

コンテナー名。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

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

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PSKeyVaultKeyIdentityItem

出力

PSKeyVaultKey