Update Key Rotation Policy - Update Key Rotation Policy

Szolgáltatás:

Key Vault

API-verzió:

2025-07-01

Frissíti egy kulcs rotációs szabályzatát.
Állítsa be a megadott tagokat a kulcsházirendben. Hagyjon másokat meghatározatlanként. Ehhez a művelethez kulcsok/frissítési engedély szükséges.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
key-name	path	True	string	A kulcs neve az adott tárolóban.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem törzse

Name	Típus	Description
attributes	KeyRotationPolicyAttributes	A kulcsrotációs szabályzat attribútumai.
lifetimeActions	LifetimeActions[]	A Key Vault által a kulcs élettartama alatt végrehajtott műveletek. Előzetes verzióban a lifetimeActions legfeljebb két elemet tartalmazhat: egyet a forgatáshoz, egyet az értesítéshez. Az értesítési idő alapértelmezés szerint 30 nappal a lejárat előtt lesz, és nem konfigurálható.

Válaszok

Name	Típus	Description
200 OK	KeyRotationPolicy	A kérés sikeres volt.
Other Status Codes	KeyVaultError	Váratlan hibaválasz.

Biztonság

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

UpdateKeyRotationPolicy

Mintakérelem

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

Mintaválasz

Állapotkó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
  }
}

Definíciók

Name	Description
Error
KeyRotationPolicy	Kulcs kezelési szabályzata.
KeyRotationPolicyAction	A művelet típusa. Az értéket érzéketlenül kell összehasonlítani.
KeyRotationPolicyAttributes	A kulcsrotációs szabályzat attribútumai.
KeyVaultError	A kulcstartó hibakivétele.
LifetimeActions	Művelet és annak eseményindítója, amelyet Key Vault fog végrehajtani a kulcs élettartama alatt.
LifetimeActionsTrigger	A művelet végrehajtásához teljesítendő feltétel.
LifetimeActionsType	A végrehajtandó művelet.

Error

Objektum

Name	Típus	Description
code	string	A hibakód.
innererror	Error	A kulcstartó-kiszolgáló hibája.
message	string	A hibaüzenet.

KeyRotationPolicy

Objektum

Kulcs kezelési szabályzata.

Name	Típus	Description
attributes	KeyRotationPolicyAttributes	A kulcsrotációs szabályzat attribútumai.
id	string	A fő szabályzat azonosítója.
lifetimeActions	LifetimeActions[]	A Key Vault által a kulcs élettartama alatt végrehajtott műveletek. Előzetes verzióban a lifetimeActions legfeljebb két elemet tartalmazhat: egyet a forgatáshoz, egyet az értesítéshez. Az értesítési idő alapértelmezés szerint 30 nappal a lejárat előtt lesz, és nem konfigurálható.

KeyRotationPolicyAction

Enumerálás

A művelet típusa. Az értéket érzéketlenül kell összehasonlítani.

Érték	Description
Rotate	Forgassa el a kulcsot a kulcsházirend alapján.
Notify	Eseményindító Event Grid. Alapértelmezés szerint 30 nappal a lejárat előtt. Csak Key Vault.

KeyRotationPolicyAttributes

Objektum

A kulcsrotációs szabályzat attribútumai.

Name	Típus	Description
created	integer (unixtime)	A kulcsrotációs szabályzat időt hozott létre az UTC-ben.
expiryTime	string	A lejárati idő az új kulcsverzióra lesz alkalmazva. Legalább 28 napnak kell lennie. Iso 8601 formátumban lesz. Példák: 90 nap: P90D, 3 hónap: P3M, 48 óra: PT48H, 1 év és 10 nap: P1Y10D
updated	integer (unixtime)	A kulcsrotációs szabályzat utolsó frissítési ideje UTC-ben.

KeyVaultError

Objektum

A kulcstartó hibakivétele.

Name	Típus	Description
error	Error	A kulcstartó-kiszolgáló hibája.

LifetimeActions

Objektum

Művelet és annak eseményindítója, amelyet Key Vault fog végrehajtani a kulcs élettartama alatt.

Name	Típus	Description
action	LifetimeActionsType	A végrehajtandó művelet.
trigger	LifetimeActionsTrigger	A műveletet végrehajtó feltétel.

LifetimeActionsTrigger

Objektum

A művelet végrehajtásához teljesítendő feltétel.

Name	Típus	Description
timeAfterCreate	string	A létrehozás után a forgatás megkísérlésének ideje. Csak forgatásra vonatkozik. Iso 8601-es időtartam formátumban lesz. Példa: 90 nap: "P90D"
timeBeforeExpiry	string	A lejárat előtti idő az elforgatás vagy az értesítés megkísérlésére. Iso 8601-es időtartam formátumban lesz. Példa: 90 nap: "P90D"

LifetimeActionsType

Objektum

A végrehajtandó művelet.

Name	Típus	Description
type	KeyRotationPolicyAction	A művelet típusa. Az értéket érzéketlenül kell összehasonlítani.