Update Key Rotation Policy - Update Key Rotation Policy

Referência

Serviço:: Key Vault

Versão da API:: 7.4

Atualizações a política de rotação de uma chave.
Defina membros especificados na política de chave. Deixe as outras pessoas como indefinidas. Esta operação requer as chaves/permissão de atualização.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
key-name	path	True	string	O nome da chave no cofre especificado.
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

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

Respostas

Name	Tipo	Description
200 OK	KeyRotationPolicy	A política da chave.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

UpdateKeyRotationPolicy

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
ActionType	O tipo de ação. O valor deve ser comparado de forma não sensível a maiúsculas e minúsculas.
Error	O erro do servidor do cofre de chaves.
KeyRotationPolicy	Política de gestão para uma chave.
KeyRotationPolicyAttributes	Os atributos da política de rotação de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.
LifetimeActions	Ação e o respetivo acionador que serão executados por Key Vault ao longo da duração de uma chave.
LifetimeActionsTrigger	Uma condição a satisfazer para que uma ação seja executada.
LifetimeActionsType	A ação que será executada.

ActionType

O tipo de ação. O valor deve ser comparado de forma não sensível a maiúsculas e minúsculas.

Name	Tipo	Description
Notify	string	Acionar eventos do Event Grid. A predefinição é 30 dias antes de expirar. só Key Vault.
Rotate	string	Rode a chave com base na política de chave.

Error

O erro do servidor do cofre de chaves.

Name	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

Política de gestão para uma chave.

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

KeyRotationPolicyAttributes

Os atributos da política de rotação de chaves.

Name	Tipo	Description
created	integer	A política de rotação de chaves criou a hora em UTC.
expiryTime	string	O expiryTime será aplicado na nova versão da chave. Deve demorar pelo menos 28 dias. Estará no Formato ISO 8601. Exemplos: 90 dias: P90D, 3 meses: P3M, 48 horas: PT48H, 1 ano e 10 dias: P1Y10D
updated	integer	A hora da última atualização da política de rotação de chaves em UTC.

KeyVaultError

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

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

LifetimeActions

Ação e o respetivo acionador que serão executados por Key Vault ao longo da duração de uma chave.

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

LifetimeActionsTrigger

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

Name	Tipo	Description
timeAfterCreate	string	Tempo após a criação para tentar rodar. Aplica-se apenas à rotação. Estará no formato de duração ISO 8601. Exemplo: 90 dias: "P90D"
timeBeforeExpiry	string	Tempo antes da expiração para tentar rodar ou notificar. Estará no formato de duração ISO 8601. Exemplo: 90 dias: "P90D"

LifetimeActionsType

A ação que será executada.

Name	Tipo	Description
type	ActionType	O tipo de ação. O valor deve ser comparado de forma não sensível a maiúsculas e minúsculas.

Partilhar via