Update Key Rotation Policy - Update Key Rotation Policy

Serviço:

Key Vault

Versão da API:

7.4

Atualiza a política de rotação de uma chave.
Defina os membros especificados na política de chave. Deixe os outros como indefinidos. Essa operação requer a permissão de chaves/atualização.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
key-name	path	True	string	O nome da chave no cofre fornecido.
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo, https://myvault.vault.azure.net.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
attributes	KeyRotationPolicyAttributes	Os atributos de política de rotação de chave.
lifetimeActions	LifetimeActions[]	Ações que serão executadas pelo Key Vault ao longo do tempo de vida de uma chave. Para visualização, lifetimeActions só pode ter dois itens no máximo: um para girar, um para notificação. O tempo de notificação seria padrão para 30 dias antes da expiração e não é configurável.

Respostas

Nome	Tipo	Description
200 OK	KeyRotationPolicy	A política da chave.
Other Status Codes	KeyVaultError	Resposta de erro do Key Vault descrevendo por que a operação falhou.

Exemplos

UpdateKeyRotationPolicy

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
ActionType	O tipo da ação. O valor deve ser comparado sem diferenciar maiúsculas de minúsculas.
Error	O erro do servidor do cofre de chaves.
KeyRotationPolicy	Política de gerenciamento para uma chave.
KeyRotationPolicyAttributes	Os atributos de política de rotação de chave.
KeyVaultError	A exceção de erro do cofre de chaves.
LifetimeActions	Ação e seu gatilho que serão executados pelo Key Vault ao longo do tempo de vida de uma chave.
LifetimeActionsTrigger	Uma condição a ser atendida para que uma ação seja executada.
LifetimeActionsType	A ação que será executada.

ActionType

Enumeração

O tipo da ação. O valor deve ser comparado sem diferenciar maiúsculas de minúsculas.

Valor	Description
Notify	Disparar eventos da Grade de Eventos. O padrão é 30 dias antes da expiração. Somente o Key Vault.
Rotate	Gire a chave com base na política de chave.

Error

Objeto

O erro do servidor do cofre de chaves.

Nome	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro do servidor do cofre de chaves.
message	string	A mensagem de erro.

KeyRotationPolicy

Objeto

Política de gerenciamento para uma chave.

Nome	Tipo	Description
attributes	KeyRotationPolicyAttributes	Os atributos de política de rotação de chave.
id	string	A ID da política de chave.
lifetimeActions	LifetimeActions[]	Ações que serão executadas pelo Key Vault ao longo do tempo de vida de uma chave. Para visualização, lifetimeActions só pode ter dois itens no máximo: um para girar, um para notificação. O tempo de notificação seria padrão para 30 dias antes da expiração e não é configurável.

KeyRotationPolicyAttributes

Objeto

Os atributos de política de rotação de chave.

Nome	Tipo	Description
created	integer (unixtime)	A política de rotação de chave criou o tempo em UTC.
expiryTime	string	O expiryTime será aplicado na nova versão da chave. Deve ser pelo menos 28 dias. Ele estará no formato ISO 8601. Exemplos: 90 dias: P90D, 3 meses: P3M, 48 horas: PT48H, 1 ano e 10 dias: P1Y10D
updated	integer (unixtime)	A última hora atualizada da política de rotação de chave em UTC.

KeyVaultError

Objeto

A exceção de erro do cofre de chaves.

Nome	Tipo	Description
error	Error	O erro do servidor do cofre de chaves.

LifetimeActions

Objeto

Ação e seu gatilho que serão executados pelo Key Vault ao longo do tempo de vida de uma chave.

Nome	Tipo	Description
action	LifetimeActionsType	A ação que será executada.
trigger	LifetimeActionsTrigger	A condição que executará a ação.

LifetimeActionsTrigger

Objeto

Uma condição a ser atendida para que uma ação seja executada.

Nome	Tipo	Description
timeAfterCreate	string	Tempo após a criação para tentar girar. Ele só se aplica à rotação. Ele estará no formato de duração ISO 8601. Exemplo: 90 dias: "P90D"
timeBeforeExpiry	string	Tempo antes da expiração para tentar girar ou notificar. Ele estará no formato de duração ISO 8601. Exemplo: 90 dias: "P90D"

LifetimeActionsType

Objeto

A ação que será executada.

Nome	Tipo	Description
type	ActionType	O tipo da ação. O valor deve ser comparado sem diferenciar maiúsculas de minúsculas.