Update Key Rotation Policy - Update Key Rotation Policy

リファレンス

Service:: Key Vault

API Version:: 7.4

キーのローテーションポリシーを更新します。
キーポリシーで指定されたメンバーを設定します。他のユーザーは未定義のままにします。この操作には、キー/更新アクセス許可が必要です。

PUT {vaultBaseUrl}/keys/{key-name}/rotationpolicy?api-version=7.4

URI パラメーター

名前	/	必須	型	説明
key-name	path	True	string	指定されたコンテナー内のキーの名前。
vaultBaseUrl	path	True	string	コンテナー名 (例: https://myvault.vault.azure.net)。
api-version	query	True	string	クライアント API バージョン。

要求本文

名前	型	説明
attributes	KeyRotationPolicyAttributes	キーローテーションポリシー属性。
lifetimeActions	LifetimeActions[]	キーの有効期間中にKey Vaultによって実行されるアクション。プレビューの場合、lifetimeActions は最大で 2 つの項目のみを持つことができます。1 つは回転用、もう 1 つは通知用です。通知時間は既定で有効期限の 30 日前に設定され、構成できません。

応答

名前	型	説明
200 OK	KeyRotationPolicy	キーのポリシー。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明するエラー応答をKey Vaultします。

例

UpdateKeyRotationPolicy

Sample Request

HTTP

PUT https://myvault.vault.azure.net//keys/updateKey01/rotationpolicy?api-version=7.4

{
  "lifetimeActions": [
    {
      "trigger": {
        "timeAfterCreate": "P90D"
      },
      "action": {
        "type": "Rotate"
      }
    },
    {
      "trigger": {
        "timeBeforeExpiry": "P30D"
      },
      "action": {
        "type": "Notify"
      }
    }
  ],
  "attributes": {
    "expiryTime": "P2Y"
  }
}

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/keys/updateKey01/rotationpolicy",
  "lifetimeActions": [
    {
      "trigger": {
        "timeAfterCreate": "P90D"
      },
      "action": {
        "type": "Rotate"
      }
    },
    {
      "trigger": {
        "timeBeforeExpiry": "P30D"
      },
      "action": {
        "type": "Notify"
      }
    }
  ],
  "attributes": {
    "expiryTime": "P2Y",
    "created": 1482188947,
    "updated": 1482188948
  }
}

定義

名前	説明
ActionType	アクションの種類。値は大文字と小文字を区別せずに比較する必要があります。
Error	キーコンテナーサーバーエラー。
KeyRotationPolicy	キーの管理ポリシー。
KeyRotationPolicyAttributes	キーローテーションポリシー属性。
KeyVaultError	キーコンテナーエラー例外。
LifetimeActions	キーの有効期間にわたってKey Vaultによって実行されるアクションとそのトリガー。
LifetimeActionsTrigger	アクションを実行するために満たす条件。
LifetimeActionsType	実行されるアクション。

ActionType

アクションの種類。値は大文字と小文字を区別せずに比較する必要があります。

名前	型	説明
Notify	string	Event Grid イベントをトリガーします。既定値は有効期限の 30 日前です。 Key Vaultのみ。
Rotate	string	キーポリシーに基づいてキーをローテーションします。

Error

キーコンテナーサーバーエラー。

名前	型	説明
code	string	エラーコード。
innererror	Error	キーコンテナーサーバーエラー。
message	string	エラーメッセージ。

KeyRotationPolicy

キーの管理ポリシー。

名前	型	説明
attributes	KeyRotationPolicyAttributes	キーローテーションポリシー属性。
id	string	キーポリシー ID。
lifetimeActions	LifetimeActions[]	キーの有効期間中にKey Vaultによって実行されるアクション。プレビューの場合、lifetimeActions は最大で 2 つの項目のみを持つことができます。1 つは回転用、もう 1 つは通知用です。通知時間は既定で有効期限の 30 日前に設定され、構成できません。

KeyRotationPolicyAttributes

キーローテーションポリシー属性。

名前	型	説明
created	integer	キーローテーションポリシーによって作成された時刻 (UTC)。
expiryTime	string	expiryTime は、新しいキーバージョンに適用されます。少なくとも 28 日である必要があります。 ISO 8601 形式になります。例: 90 日: P90D、3 か月: P3M、48 時間: PT48H、1 年および 10 日: P1Y10D
updated	integer	キーローテーションポリシーの最終更新時刻 (UTC)。

KeyVaultError

キーコンテナーエラー例外。

名前	型	説明
error	Error	キーコンテナーサーバーエラー。

LifetimeActions

キーの有効期間にわたってKey Vaultによって実行されるアクションとそのトリガー。

名前	型	説明
action	LifetimeActionsType	実行されるアクション。
trigger	LifetimeActionsTrigger	アクションを実行する条件。

LifetimeActionsTrigger

アクションを実行するために満たす条件。

名前	型	説明
timeAfterCreate	string	作成後に回転を試みる時間。回転にのみ適用されます。 ISO 8601 の期間形式になります。例: 90 日: "P90D"
timeBeforeExpiry	string	ローテーションまたは通知を試みる有効期限の前の時間。 ISO 8601 の期間形式になります。例: 90 日: "P90D"

LifetimeActionsType

実行されるアクション。

名前	型	説明
type	ActionType	アクションの種類。値は大文字と小文字を区別せずに比較する必要があります。