你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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[]	将在密钥生存期内由密钥保管库执行的操作。对于预览版，lifetimeActions 最多只能有两个项：一个用于旋转，一个用于通知。通知时间默认为过期前 30 天，不可配置。

响应

名称	类型	说明
200 OK	KeyRotationPolicy	密钥的策略。
Other Status Codes	KeyVaultError	密钥保管库描述操作失败原因的错误响应。

示例

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	操作及其触发器将在密钥的生存期内由密钥保管库执行。
LifetimeActionsTrigger	要为要执行的操作满足的条件。
LifetimeActionsType	将执行的操作。

ActionType

操作的类型。应不区分大小写地比较该值。

名称	类型	说明
Notify	string	触发事件网格事件。默认为到期前 30 天。仅限密钥保管库。
Rotate	string	根据密钥策略轮换密钥。

Error

密钥保管库服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	密钥保管库服务器错误。
message	string	错误消息。

KeyRotationPolicy

密钥的管理策略。

名称	类型	说明
attributes	KeyRotationPolicyAttributes	密钥轮换策略属性。
id	string	密钥策略 ID。
lifetimeActions	LifetimeActions[]	将在密钥生存期内由密钥保管库执行的操作。对于预览版，lifetimeActions 最多只能有两个项：一个用于旋转，一个用于通知。通知时间默认为过期前 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

操作及其触发器将在密钥的生存期内由密钥保管库执行。

名称	类型	说明
action	LifetimeActionsType	将执行的操作。
trigger	LifetimeActionsTrigger	将执行操作的条件。

LifetimeActionsTrigger

要为要执行的操作满足的条件。

名称	类型	说明
timeAfterCreate	string	创建后尝试旋转的时间。它仅适用于旋转。它将采用 ISO 8601 持续时间格式。示例：90 天：“P90D”
timeBeforeExpiry	string	到期前尝试轮换或通知的时间。它将采用 ISO 8601 持续时间格式。示例：90 天：“P90D”

LifetimeActionsType

将执行的操作。

名称	类型	说明
type	ActionType	操作的类型。应不区分大小写地比较该值。

Share via