Get Key Rotation Policy - Get Key Rotation Policy

Служба:

Key Vault

Версия API:

2025-07-01

Перечисляет политику для ключа.
Операция GetKeyRotationPolicy возвращает указанные ресурсы политики ключей в указанном хранилище ключей. Для этой операции требуются ключи и разрешения на получение.

GET {vaultBaseUrl}/keys/{key-name}/rotationpolicy?api-version=2025-07-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
key-name	path	True	string	Имя ключа в заданном хранилище ключей.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	KeyRotationPolicy	Запрос выполнен успешно.
Other Status Codes	KeyVaultError	Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://vault.azure.net/.default

Примеры

GetKeyRotationPolicy

Образец запроса

HTTP

GET https://myvault.vault.azure.net//keys/key01/rotationpolicy?api-version=2025-07-01

Пример ответа

Код состояния:

200

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

Определения

Имя	Описание
Error
KeyRotationPolicy	Политика управления ключом.
KeyRotationPolicyAction	Тип действия. Значение должно сравниваться без учета регистра.
KeyRotationPolicyAttributes	Ключевые атрибуты политики ротации.
KeyVaultError	Исключение ошибки хранилища ключей.
LifetimeActions	Действие и его триггер, которые будут выполняться Key Vault в течение всего времени жизни ключа.
LifetimeActionsTrigger	Условие, которое должно быть выполнено для выполнения действия.
LifetimeActionsType	Действие, которое будет выполнено.

Error

Object

Имя	Тип	Описание
code	string	Код ошибки.
innererror	Error	Ошибка сервера хранилища ключей.
message	string	Сообщение об ошибке.

KeyRotationPolicy

Object

Политика управления ключом.

Имя	Тип	Описание
attributes	KeyRotationPolicyAttributes	Ключевые атрибуты политики ротации.
id	string	Идентификатор ключевой политики.
lifetimeActions	LifetimeActions[]	Действия, которые Key Vault будет выполнять в течение всего срока действия ключа. Для предварительного просмотра lifetimeActions может иметь не более двух элементов: один для ротации, один для уведомления. По умолчанию время уведомления будет составлять 30 дней до истечения срока действия, и его нельзя настроить.

KeyRotationPolicyAction

Перечисление

Тип действия. Значение должно сравниваться без учета регистра.

Значение	Описание
Rotate	Поворачивайте ключ в соответствии с политикой ключа.
Notify	Активация событий Сетки событий. По умолчанию за 30 дней до истечения срока действия. Только Key Vault.

KeyRotationPolicyAttributes

Object

Ключевые атрибуты политики ротации.

Имя	Тип	Описание
created	integer (unixtime)	Политика ротации ключей создавала время в формате UTC.
expiryTime	string	Срок действия будет применен к новой версии ключа. Это должно быть не менее 28 дней. Он будет находиться в формате ISO 8601. Примеры: 90 дней: P90D, 3 месяца: P3M, 48 часов: PT48H, 1 год и 10 дней: P1Y10D
updated	integer (unixtime)	Время последнего обновления политики ротации ключей в формате UTC.

KeyVaultError

Object

Исключение ошибки хранилища ключей.

Имя	Тип	Описание
error	Error	Ошибка сервера хранилища ключей.

LifetimeActions

Object

Действие и его триггер, которые будут выполняться Key Vault в течение всего времени жизни ключа.

Имя	Тип	Описание
action	LifetimeActionsType	Действие, которое будет выполнено.
trigger	LifetimeActionsTrigger	Условие, при котором будет выполнено действие.

LifetimeActionsTrigger

Object

Условие, которое должно быть выполнено для выполнения действия.

Имя	Тип	Описание
timeAfterCreate	string	Время после создания для попытки поворота. Она применяется только к повороту. Он будет иметь формат длительности ISO 8601. Пример: 90 дней: "P90D"
timeBeforeExpiry	string	Время до истечения срока действия для попытки ротации или уведомления. Он будет иметь формат длительности ISO 8601. Пример: 90 дней: "P90D"

LifetimeActionsType

Object

Действие, которое будет выполнено.

Имя	Тип	Описание
type	KeyRotationPolicyAction	Тип действия. Значение должно сравниваться без учета регистра.