Update Key Rotation Policy - Update Key Rotation Policy
Atualizações a política de rotação para uma chave.
Defina os membros especificados na política de chave. Deixe os outros como indefinidos. Essa operação requer a permissão de atualização/chaves.
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. |
vault
|
path | True |
string |
O nome do cofre, por exemplo https://myvault.vault.azure.net, . |
api-version
|
query | True |
string |
Versão de API do cliente. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
attributes |
Os atributos da política de rotação de chaves. |
|
lifetimeActions |
Ações que serão executadas por Key Vault ao longo do tempo de vida de uma chave. Para versão prévia, lifetimeActions só pode ter dois itens no máximo: um para girar, um para notificação. O tempo de notificação seria o padrão de 30 dias antes da expiração e não é configurável. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A política para a chave. |
|
Other Status Codes |
Key Vault resposta de erro que descreve por que a operação falhou. |
Exemplos
UpdateKeyRotationPolicy
Solicitação de exemplo
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
{
"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 |
---|---|
Action |
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. |
Key |
Política de gerenciamento para uma chave. |
Key |
Os atributos da política de rotação de chaves. |
Key |
A exceção de erro do cofre de chaves. |
Lifetime |
A ação e seu gatilho que serão executados por Key Vault ao longo do tempo de vida de uma chave. |
Lifetime |
Uma condição a ser atendida para que uma ação seja executada. |
Lifetime |
A ação que será executada. |
ActionType
O tipo da ação. O valor deve ser comparado sem diferenciar maiúsculas de minúsculas.
Nome | Tipo | Description |
---|---|---|
Notify |
string |
Disparar eventos da Grade de Eventos. O padrão é 30 dias antes da expiração. Key Vault apenas. |
Rotate |
string |
Gire a chave com base na política de chave. |
Error
O erro do servidor do cofre de chaves.
Nome | Tipo | Description |
---|---|---|
code |
string |
O código de erro. |
innererror |
O erro do servidor do cofre de chaves. |
|
message |
string |
A mensagem de erro. |
KeyRotationPolicy
Política de gerenciamento para uma chave.
Nome | Tipo | Description |
---|---|---|
attributes |
Os atributos da política de rotação de chaves. |
|
id |
string |
A ID da política de chave. |
lifetimeActions |
Ações que serão executadas por Key Vault ao longo do tempo de vida de uma chave. Para versão prévia, lifetimeActions só pode ter dois itens no máximo: um para girar, um para notificação. O tempo de notificação seria o padrão de 30 dias antes da expiração e não é configurável. |
KeyRotationPolicyAttributes
Os atributos da política de rotação de chaves.
Nome | 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 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 |
A última hora atualizada da política de rotação de chaves em UTC. |
KeyVaultError
A exceção de erro do cofre de chaves.
Nome | Tipo | Description |
---|---|---|
error |
O erro do servidor do cofre de chaves. |
LifetimeActions
A ação e seu gatilho que serão executados por Key Vault ao longo do tempo de vida de uma chave.
Nome | Tipo | Description |
---|---|---|
action |
A ação que será executada. |
|
trigger |
A condição que executará a ação. |
LifetimeActionsTrigger
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. Aplica-se apenas à 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
A ação que será executada.
Nome | Tipo | Description |
---|---|---|
type |
O tipo da ação. O valor deve ser comparado sem diferenciar maiúsculas de minúsculas. |