Update Key Rotation Policy - Update Key Rotation Policy

Service:

Key Vault

API-versie:

7.4

Hiermee werkt u het rotatiebeleid voor een sleutel bij.
Stel opgegeven leden in het sleutelbeleid in. Laat anderen ongewijzigd. Voor deze bewerking zijn de sleutels/updatemachtigingen vereist.

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

URI-parameters

Name	In	Vereist	Type	Description
key-name	path	True	string	De naam van de sleutel in de opgegeven kluis.
vaultBaseUrl	path	True	string	De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
attributes	KeyRotationPolicyAttributes	De kenmerken van het sleutelrotatiebeleid.
lifetimeActions	LifetimeActions[]	Acties die worden uitgevoerd door Key Vault gedurende de levensduur van een sleutel. Voor preview kunnen lifetimeActions maximaal twee items hebben: één voor draaien, één voor een melding. De meldingstijd is standaard ingesteld op 30 dagen voordat deze verloopt en kan niet worden geconfigureerd.

Antwoorden

Name	Type	Description
200 OK	KeyRotationPolicy	Het beleid voor de sleutel.
Other Status Codes	KeyVaultError	Key Vault-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

UpdateKeyRotationPolicy

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
ActionType	Het type actie. De waarde moet hoofdlettergevoelig worden vergeleken.
Error	De sleutelkluisserverfout.
KeyRotationPolicy	Beheerbeleid voor een sleutel.
KeyRotationPolicyAttributes	De kenmerken van het sleutelrotatiebeleid.
KeyVaultError	De fout-uitzondering voor de sleutelkluis.
LifetimeActions	Actie en de trigger die door Key Vault worden uitgevoerd gedurende de levensduur van een sleutel.
LifetimeActionsTrigger	Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.
LifetimeActionsType	De actie die wordt uitgevoerd.

ActionType

Inventarisatie

Het type actie. De waarde moet hoofdlettergevoelig worden vergeleken.

Waarde	Description
Notify	Event Grid-gebeurtenissen activeren. De standaardwaarde is 30 dagen voordat de vervaldatum is verstreken. Alleen Key Vault.
Rotate	Draai de sleutel op basis van het sleutelbeleid.

Error

Object

De sleutelkluisserverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De sleutelkluisserverfout.
message	string	Het foutbericht.

KeyRotationPolicy

Object

Beheerbeleid voor een sleutel.

Name	Type	Description
attributes	KeyRotationPolicyAttributes	De kenmerken van het sleutelrotatiebeleid.
id	string	De sleutelbeleids-id.
lifetimeActions	LifetimeActions[]	Acties die worden uitgevoerd door Key Vault gedurende de levensduur van een sleutel. Voor preview kunnen lifetimeActions maximaal twee items hebben: één voor draaien, één voor een melding. De meldingstijd is standaard ingesteld op 30 dagen voordat deze verloopt en kan niet worden geconfigureerd.

KeyRotationPolicyAttributes

Object

De kenmerken van het sleutelrotatiebeleid.

Name	Type	Description
created	integer (unixtime)	Het sleutelrotatiebeleid heeft tijd gemaakt in UTC.
expiryTime	string	De vervaldatum wordt toegepast op de nieuwe sleutelversie. Het moet ten minste 28 dagen zijn. Het heeft een ISO 8601-indeling. Voorbeelden: 90 dagen: P90D, 3 maanden: P3M, 48 uur: PT48H, 1 jaar en 10 dagen: P1Y10D
updated	integer (unixtime)	De laatst bijgewerkte tijd van het sleutelrotatiebeleid in UTC.

KeyVaultError

Object

De fout-uitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

LifetimeActions

Object

Actie en de trigger die door Key Vault worden uitgevoerd gedurende de levensduur van een sleutel.

Name	Type	Description
action	LifetimeActionsType	De actie die wordt uitgevoerd.
trigger	LifetimeActionsTrigger	De voorwaarde waarmee de actie wordt uitgevoerd.

LifetimeActionsTrigger

Object

Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.

Name	Type	Description
timeAfterCreate	string	Tijd na het maken om te proberen te draaien. Het is alleen van toepassing op draaien. Deze heeft een ISO 8601-duurnotatie. Voorbeeld: 90 dagen: "P90D"
timeBeforeExpiry	string	Tijd vóór de vervaldatum om te proberen te draaien of op de hoogte te stellen. Deze heeft een ISO 8601-duurnotatie. Voorbeeld: 90 dagen: "P90D"

LifetimeActionsType

Object

De actie die wordt uitgevoerd.

Name	Type	Description
type	ActionType	Het type actie. De waarde moet hoofdlettergevoelig worden vergeleken.