Update Key Rotation Policy - Update Key Rotation Policy

Riferimento

Service:: Key Vault

API Version:: 7.4

Aggiornamenti i criteri di rotazione per una chiave.
Impostare i membri specificati nei criteri chiave. Lasciare gli altri come non definiti. Questa operazione richiede l'autorizzazione chiavi/aggiornamento.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
key-name	path	True	string	Nome della chiave nell'insieme di credenziali specificato.
vaultBaseUrl	path	True	string	Nome dell'insieme di credenziali, ad esempio https://myvault.vault.azure.net.
api-version	query	True	string	Versione API client.

Corpo della richiesta

Nome	Tipo	Descrizione
attributes	KeyRotationPolicyAttributes	Attributi dei criteri di rotazione delle chiavi.
lifetimeActions	LifetimeActions[]	Azioni che verranno eseguite da Key Vault durante la durata di una chiave. Per l'anteprima, la durataActions può avere solo due elementi al massimo: uno per ruotare, uno per la notifica. Il tempo di notifica è predefinito per 30 giorni prima della scadenza e non è configurabile.

Risposte

Nome	Tipo	Descrizione
200 OK	KeyRotationPolicy	Criterio per la chiave.
Other Status Codes	KeyVaultError	Key Vault risposta di errore che descrive perché l'operazione non è riuscita.

Esempio

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

Definizioni

Nome	Descrizione
ActionType	Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole.
Error	Errore del server dell'insieme di credenziali delle chiavi.
KeyRotationPolicy	Criteri di gestione per una chiave.
KeyRotationPolicyAttributes	Attributi dei criteri di rotazione delle chiavi.
KeyVaultError	Eccezione di errore dell'insieme di credenziali delle chiavi.
LifetimeActions	Azione e trigger che verranno eseguiti da Key Vault durante la durata di una chiave.
LifetimeActionsTrigger	Condizione da soddisfare per l'esecuzione di un'azione.
LifetimeActionsType	Azione che verrà eseguita.

ActionType

Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole.

Nome	Tipo	Descrizione
Notify	string	Attiva eventi griglia di eventi. Il valore predefinito è 30 giorni prima della scadenza. Key Vault solo.
Rotate	string	Ruotare la chiave in base ai criteri chiave.

Error

Errore del server dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	Error	Errore del server dell'insieme di credenziali delle chiavi.
message	string	Messaggio di errore.

KeyRotationPolicy

Criteri di gestione per una chiave.

Nome	Tipo	Descrizione
attributes	KeyRotationPolicyAttributes	Attributi dei criteri di rotazione delle chiavi.
id	string	ID criterio chiave.
lifetimeActions	LifetimeActions[]	Azioni che verranno eseguite da Key Vault durante la durata di una chiave. Per l'anteprima, la durataActions può avere solo due elementi al massimo: uno per ruotare, uno per la notifica. Il tempo di notifica è predefinito per 30 giorni prima della scadenza e non è configurabile.

KeyRotationPolicyAttributes

Attributi dei criteri di rotazione delle chiavi.

Nome	Tipo	Descrizione
created	integer	I criteri di rotazione delle chiavi creati in formato UTC.
expiryTime	string	La scadenzatime verrà applicata alla nuova versione della chiave. Dovrebbe essere almeno 28 giorni. Sarà in formato ISO 8601. Esempi: 90 giorni: P90D, 3 mesi: P3M, 48 ore: PT48H, 1 anno e 10 giorni: P1Y10D
updated	integer	L'ultima ora aggiornata del criterio di rotazione delle chiavi in UTC.

KeyVaultError

Eccezione di errore dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
error	Error	Errore del server dell'insieme di credenziali delle chiavi.

LifetimeActions

Azione e trigger che verranno eseguiti da Key Vault durante la durata di una chiave.

Nome	Tipo	Descrizione
action	LifetimeActionsType	Azione che verrà eseguita.
trigger	LifetimeActionsTrigger	Condizione che eseguirà l'azione.

LifetimeActionsTrigger

Condizione da soddisfare per l'esecuzione di un'azione.

Nome	Tipo	Descrizione
timeAfterCreate	string	Tempo dopo la creazione per tentare di ruotare. Si applica solo alla rotazione. Sarà in formato di durata ISO 8601. Esempio: 90 giorni : "P90D"
timeBeforeExpiry	string	Tempo prima della scadenza per tentare di ruotare o notificare. Sarà in formato di durata ISO 8601. Esempio: 90 giorni : "P90D"

LifetimeActionsType

Azione che verrà eseguita.

Nome	Tipo	Descrizione
type	ActionType	Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole.