Update Key Rotation Policy - Update Key Rotation Policy

Služba:

Key Vault

Verze rozhraní API:

2025-07-01

Aktualizuje zásady rotace klíče.
Nastavte určené členy v zásadách klíče. Ostatní ponechte jako nedefinované. Tato operace vyžaduje oprávnění klíče nebo aktualizace.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
key-name	path	True	string	Název klíče v daném trezoru.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
attributes	KeyRotationPolicyAttributes	Atributy zásad rotace klíčů.
lifetimeActions	LifetimeActions[]	Akce, které bude Key Vault provádět po celou dobu životnosti klíče. V náhledu může mít vlastnost lifetimeActions maximálně dvě položky: jednu pro otočení, jednu pro upozornění. Čas oznámení by byl ve výchozím nastavení 30 dní před vypršením platnosti a nelze jej konfigurovat.

Odpovědi

Name	Typ	Description
200 OK	KeyRotationPolicy	Požadavek byl úspěšný.
Other Status Codes	KeyVaultError	Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://vault.azure.net/.default

Příklady

UpdateKeyRotationPolicy

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Error
KeyRotationPolicy	Zásady správy pro klíč.
KeyRotationPolicyAction	Typ akce. Hodnota by se měla porovnávat bez rozlišování velkých a malých písmen.
KeyRotationPolicyAttributes	Atributy zásad rotace klíčů.
KeyVaultError	Výjimka chyby trezoru klíčů.
LifetimeActions	Akce a její trigger, který bude Key Vault provádět po celou dobu životnosti klíče.
LifetimeActionsTrigger	Podmínka, která musí být splněna pro provedení akce.
LifetimeActionsType	Akce, která bude provedena.

Error

Objekt

Name	Typ	Description
code	string	Kód chyby.
innererror	Error	Chyba serveru trezoru klíčů.
message	string	Chybová zpráva.

KeyRotationPolicy

Objekt

Zásady správy pro klíč.

Name	Typ	Description
attributes	KeyRotationPolicyAttributes	Atributy zásad rotace klíčů.
id	string	ID klíčové zásady.
lifetimeActions	LifetimeActions[]	Akce, které bude Key Vault provádět po celou dobu životnosti klíče. V náhledu může mít vlastnost lifetimeActions maximálně dvě položky: jednu pro otočení, jednu pro upozornění. Čas oznámení by byl ve výchozím nastavení 30 dní před vypršením platnosti a nelze jej konfigurovat.

KeyRotationPolicyAction

Výčet

Typ akce. Hodnota by se měla porovnávat bez rozlišování velkých a malých písmen.

Hodnota	Description
Rotate	Otočte klíč na základě zásad klíče.
Notify	Aktivujte události Event Gridu. Výchozí hodnota je 30 dní před vypršením platnosti. Pouze Key Vault.

KeyRotationPolicyAttributes

Objekt

Atributy zásad rotace klíčů.

Name	Typ	Description
created	integer (unixtime)	Čas vytvořený v zásadách rotace klíčů ve formátu UTC.
expiryTime	string	U nové verze klíče se použije hodnota expiryTime. Mělo by to být alespoň 28 dní. Bude ve formátu ISO 8601. Příklady: 90 dní: P90D, 3 měsíce: P3M, 48 hodin: PT48H, 1 rok a 10 dní: P1Y10D
updated	integer (unixtime)	Čas poslední aktualizace zásad střídání klíčů ve formátu UTC.

KeyVaultError

Objekt

Výjimka chyby trezoru klíčů.

Name	Typ	Description
error	Error	Chyba serveru trezoru klíčů.

LifetimeActions

Objekt

Akce a její trigger, který bude Key Vault provádět po celou dobu životnosti klíče.

Name	Typ	Description
action	LifetimeActionsType	Akce, která bude provedena.
trigger	LifetimeActionsTrigger	Podmínka, která provede akci.

LifetimeActionsTrigger

Objekt

Podmínka, která musí být splněna pro provedení akce.

Name	Typ	Description
timeAfterCreate	string	Čas po vytvoření se pokusit o rotaci. Platí jenom pro otáčení. Bude ve formátu doby trvání ISO 8601. Příklad: 90 dní : "P90D"
timeBeforeExpiry	string	Čas před vypršením platnosti pokusu o rotaci nebo oznámení. Bude ve formátu doby trvání ISO 8601. Příklad: 90 dní : "P90D"

LifetimeActionsType

Objekt

Akce, která bude provedena.

Name	Typ	Description
type	KeyRotationPolicyAction	Typ akce. Hodnota by se měla porovnávat bez rozlišování velkých a malých písmen.