Update Key Rotation Policy - Update Key Rotation Policy
Novedades la directiva de rotación de una clave.
Establezca los miembros especificados en la directiva de clave. Deje a otros como indefinidos. Esta operación requiere el permiso keys/update.
PUT {vaultBaseUrl}/keys/{key-name}/rotationpolicy?api-version=7.4
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
key-name
|
path | True |
string |
Nombre de la clave en el almacén especificado. |
vault
|
path | True |
string |
El nombre del almacén, por ejemplo https://myvault.vault.azure.net, . |
api-version
|
query | True |
string |
Versión de API del cliente. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
attributes |
Atributos de directiva de rotación de claves. |
|
lifetimeActions |
Acciones que realizará Key Vault durante la vigencia de una clave. En el caso de la versión preliminar, lifetimeActions solo puede tener dos elementos como máximo: uno para rotar, otro para notificar. El tiempo de notificación sería el valor predeterminado de 30 días antes de la expiración y no es configurable. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Directiva de la clave. |
|
Other Status Codes |
Key Vault respuesta de error que describe por qué se produjo un error en la operación. |
Ejemplos
UpdateKeyRotationPolicy
Sample Request
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
{
"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
}
}
Definiciones
Nombre | Description |
---|---|
Action |
El tipo de la acción. El valor debe compararse sin distinción entre mayúsculas y minúsculas. |
Error |
Error del servidor del almacén de claves. |
Key |
Directiva de administración para una clave. |
Key |
Atributos de directiva de rotación de claves. |
Key |
Excepción de error del almacén de claves. |
Lifetime |
Acción y su desencadenador que realizará Key Vault durante la vigencia de una clave. |
Lifetime |
Condición que se va a cumplir para que se ejecute una acción. |
Lifetime |
Acción que se ejecutará. |
ActionType
El tipo de la acción. El valor debe compararse sin distinción entre mayúsculas y minúsculas.
Nombre | Tipo | Description |
---|---|---|
Notify |
string |
Desencadene eventos de Event Grid. El valor predeterminado es 30 días antes de la expiración. solo Key Vault. |
Rotate |
string |
Girar la clave en función de la directiva de claves. |
Error
Error del servidor del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
innererror |
Error del servidor del almacén de claves. |
|
message |
string |
El mensaje de error. |
KeyRotationPolicy
Directiva de administración para una clave.
Nombre | Tipo | Description |
---|---|---|
attributes |
Atributos de directiva de rotación de claves. |
|
id |
string |
Identificador de la directiva de clave. |
lifetimeActions |
Acciones que realizará Key Vault durante la vigencia de una clave. En el caso de la versión preliminar, lifetimeActions solo puede tener dos elementos como máximo: uno para rotar, otro para notificar. El tiempo de notificación sería el valor predeterminado de 30 días antes de la expiración y no es configurable. |
KeyRotationPolicyAttributes
Atributos de directiva de rotación de claves.
Nombre | Tipo | Description |
---|---|---|
created |
integer |
La directiva de rotación de claves ha creado la hora en UTC. |
expiryTime |
string |
ExpiryTime se aplicará en la nueva versión de clave. Debe ser de al menos 28 días. Estará en formato ISO 8601. Ejemplos: 90 días: P90D, 3 meses: P3M, 48 horas: PT48H, 1 año y 10 días: P1Y10D |
updated |
integer |
Hora de la última actualización de la directiva de rotación de claves en UTC. |
KeyVaultError
Excepción de error del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
error |
Error del servidor del almacén de claves. |
LifetimeActions
Acción y su desencadenador que realizará Key Vault durante la vigencia de una clave.
Nombre | Tipo | Description |
---|---|---|
action |
Acción que se ejecutará. |
|
trigger |
Condición que ejecutará la acción. |
LifetimeActionsTrigger
Condición que se va a cumplir para que se ejecute una acción.
Nombre | Tipo | Description |
---|---|---|
timeAfterCreate |
string |
Tiempo después de la creación para intentar girar. Solo se aplica a la rotación. Estará en formato de duración ISO 8601. Ejemplo: 90 días: "P90D" |
timeBeforeExpiry |
string |
Tiempo antes de la expiración para intentar rotar o notificar. Estará en formato de duración ISO 8601. Ejemplo: 90 días: "P90D" |
LifetimeActionsType
Acción que se ejecutará.
Nombre | Tipo | Description |
---|---|---|
type |
El tipo de la acción. El valor debe compararse sin distinción entre mayúsculas y minúsculas. |