Update Key Rotation Policy - Update Key Rotation Policy

Référence

Service:: Key Vault

API Version:: 7.4

Mises à jour la stratégie de rotation d’une clé.
Définissez les membres spécifiés dans la stratégie de clé. Laissez les autres comme non définis. Cette opération nécessite l’autorisation clés/mise à jour.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
key-name	path	True	string	Nom de la clé dans le coffre donné.
vaultBaseUrl	path	True	string	Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version	query	True	string	Version d’API client.

Corps de la demande

Nom	Type	Description
attributes	KeyRotationPolicyAttributes	Attributs de stratégie de rotation de clé.
lifetimeActions	LifetimeActions[]	Actions qui seront effectuées par Key Vault sur la durée de vie d’une clé. Pour la préversion, lifetimeActions ne peut avoir que deux éléments au maximum : un pour la rotation, un pour notification. L’heure de notification est par défaut de 30 jours avant l’expiration et elle n’est pas configurable.

Réponses

Nom	Type	Description
200 OK	KeyRotationPolicy	Stratégie de la clé.
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

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

Définitions

Nom	Description
ActionType	Type de l'action. La valeur doit être comparée sans tenir compte de la casse.
Error	Erreur du serveur du coffre de clés.
KeyRotationPolicy	Stratégie de gestion pour une clé.
KeyRotationPolicyAttributes	Attributs de stratégie de rotation de clé.
KeyVaultError	Exception d’erreur du coffre de clés.
LifetimeActions	Action et son déclencheur qui sera effectué par Key Vault sur la durée de vie d’une clé.
LifetimeActionsTrigger	Condition à satisfaire pour qu’une action soit exécutée.
LifetimeActionsType	Action qui sera exécutée.

ActionType

Type de l'action. La valeur doit être comparée sans tenir compte de la casse.

Nom	Type	Description
Notify	string	Déclencher des événements Event Grid. Par défaut, 30 jours avant l’expiration. Key Vault uniquement.
Rotate	string	Faites pivoter la clé en fonction de la stratégie de clé.

Error

Erreur du serveur du coffre de clés.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	Erreur du serveur du coffre de clés.
message	string	Message d’erreur.

KeyRotationPolicy

Stratégie de gestion pour une clé.

Nom	Type	Description
attributes	KeyRotationPolicyAttributes	Attributs de stratégie de rotation de clé.
id	string	ID de stratégie de clé.
lifetimeActions	LifetimeActions[]	Actions qui seront effectuées par Key Vault sur la durée de vie d’une clé. Pour la préversion, lifetimeActions ne peut avoir que deux éléments au maximum : un pour la rotation, un pour notification. L’heure de notification est par défaut de 30 jours avant l’expiration et elle n’est pas configurable.

KeyRotationPolicyAttributes

Attributs de stratégie de rotation de clé.

Nom	Type	Description
created	integer	La stratégie de rotation de clé a créé l’heure UTC.
expiryTime	string	ExpireyTime sera appliqué à la nouvelle version de clé. Il doit être d’au moins 28 jours. Il sera au format ISO 8601. Exemples : 90 jours : P90D, 3 mois : P3M, 48 heures : PT48H, 1 an et 10 jours : P1Y10D
updated	integer	Dernière heure de mise à jour de la stratégie de rotation des clés en UTC.

KeyVaultError

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur du serveur du coffre de clés.

LifetimeActions

Action et son déclencheur qui sera effectué par Key Vault sur la durée de vie d’une clé.

Nom	Type	Description
action	LifetimeActionsType	Action qui sera exécutée.
trigger	LifetimeActionsTrigger	Condition qui exécutera l’action.

LifetimeActionsTrigger

Condition à satisfaire pour qu’une action soit exécutée.

Nom	Type	Description
timeAfterCreate	string	Délai après la création de la tentative de rotation. Il s’applique uniquement à la rotation. Il sera au format de durée ISO 8601. Exemple : 90 jours : « P90D »
timeBeforeExpiry	string	Délai avant l’expiration de la tentative de rotation ou de notification. Il sera au format de durée ISO 8601. Exemple : 90 jours : « P90D »

LifetimeActionsType

Action qui sera exécutée.

Nom	Type	Description
type	ActionType	Type de l'action. La valeur doit être comparée sans tenir compte de la casse.

Partager via