Update Key Rotation Policy - Update Key Rotation Policy

Odwołanie

Service:: Key Vault

API Version:: 7.4

Aktualizacje zasady rotacji klucza.
Ustaw określone elementy członkowskie w zasadach klucza. Pozostaw inne osoby jako niezdefiniowane. Ta operacja wymaga uprawnień kluczy/aktualizacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
key-name	path	True	string	Nazwa klucza w danym magazynie.
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
attributes	KeyRotationPolicyAttributes	Atrybuty zasad rotacji kluczy.
lifetimeActions	LifetimeActions[]	Akcje, które będą wykonywane przez Key Vault przez cały okres istnienia klucza. W przypadku wersji zapoznawczej funkcja lifetimeActions może mieć maksymalnie dwa elementy: jedną dla rotacji, jedną dla powiadomienia. Czas powiadomienia będzie domyślnie 30 dni przed wygaśnięciem i nie można go skonfigurować.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	KeyRotationPolicy	Zasady klucza.
Other Status Codes	KeyVaultError	Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Przykłady

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
  }
}

Definicje

Nazwa	Opis
ActionType	Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter.
Error	Błąd serwera magazynu kluczy.
KeyRotationPolicy	Zasady zarządzania klucza.
KeyRotationPolicyAttributes	Atrybuty zasad rotacji kluczy.
KeyVaultError	Wyjątek błędu magazynu kluczy.
LifetimeActions	Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault przez cały okres istnienia klucza.
LifetimeActionsTrigger	Warunek, który ma zostać spełniony, aby wykonać akcję.
LifetimeActionsType	Akcja, która zostanie wykonana.

ActionType

Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter.

Nazwa	Typ	Opis
Notify	string	Wyzwalanie zdarzeń usługi Event Grid. Wartość domyślna to 30 dni przed wygaśnięciem. Key Vault tylko.
Rotate	string	Obracanie klucza na podstawie zasad klucza.

Error

Błąd serwera magazynu kluczy.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Błąd serwera magazynu kluczy.
message	string	Komunikat o błędzie.

KeyRotationPolicy

Zasady zarządzania klucza.

Nazwa	Typ	Opis
attributes	KeyRotationPolicyAttributes	Atrybuty zasad rotacji kluczy.
id	string	Identyfikator zasad klucza.
lifetimeActions	LifetimeActions[]	Akcje, które będą wykonywane przez Key Vault przez cały okres istnienia klucza. W przypadku wersji zapoznawczej funkcja lifetimeActions może mieć maksymalnie dwa elementy: jedną dla rotacji, jedną dla powiadomienia. Czas powiadomienia będzie domyślnie 30 dni przed wygaśnięciem i nie można go skonfigurować.

KeyRotationPolicyAttributes

Atrybuty zasad rotacji kluczy.

Nazwa	Typ	Opis
created	integer	Czas utworzenia zasad rotacji kluczy w formacie UTC.
expiryTime	string	Czas wygaśnięcia zostanie zastosowany w nowej wersji klucza. Powinno to być co najmniej 28 dni. Będzie on w formacie ISO 8601. Przykłady: 90 dni: P90D, 3 miesiące: P3M, 48 godzin: PT48H, 1 rok i 10 dni: P1Y10D
updated	integer	Czas ostatniej aktualizacji zasad rotacji kluczy w formacie UTC.

KeyVaultError

Wyjątek błędu magazynu kluczy.

Nazwa	Typ	Opis
error	Error	Błąd serwera magazynu kluczy.

LifetimeActions

Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault przez cały okres istnienia klucza.

Nazwa	Typ	Opis
action	LifetimeActionsType	Akcja, która zostanie wykonana.
trigger	LifetimeActionsTrigger	Warunek, który wykona akcję.

LifetimeActionsTrigger

Warunek, który ma zostać spełniony, aby wykonać akcję.

Nazwa	Typ	Opis
timeAfterCreate	string	Czas po utworzeniu, aby podjąć próbę rotacji. Dotyczy tylko rotacji. Będzie on w formacie czasu trwania ISO 8601. Przykład: 90 dni: "P90D"
timeBeforeExpiry	string	Czas przed wygaśnięciem próby rotacji lub powiadamiania. Będzie on w formacie czasu trwania ISO 8601. Przykład: 90 dni: "P90D"

LifetimeActionsType

Akcja, która zostanie wykonana.

Nazwa	Typ	Opis
type	ActionType	Typ akcji. Wartość powinna być porównywana bez uwzględniania wielkości liter.