Rotate Key - Rotate Key
Crea una nueva versión de clave, la almacena y, a continuación, devuelve los parámetros clave, los atributos y la directiva al cliente.
La operación rotará la clave en función de la directiva de claves. Requiere el permiso keys/rotate.
POST {vaultBaseUrl}/keys/{key-name}/rotate?api-version=7.4
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
key-name
|
path | True |
string |
Nombre de la clave que se va a girar. El sistema generará una nueva versión en la clave especificada. Regex pattern: |
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. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Agrupación de claves que contiene el resultado de la solicitud de rotación de claves. |
|
Other Status Codes |
Key Vault respuesta de error que describe por qué se produjo un error en la operación. |
Ejemplos
Rotate key
Sample Request
POST https://myvault.vault.azure.net//keys/Key01/rotate?api-version=7.4
Sample Response
{
"key": {
"kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
"kty": "RSA",
"key_ops": [
"encrypt",
"decrypt",
"sign",
"verify",
"wrapKey",
"unwrapKey"
],
"n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
"e": "AQAB"
},
"attributes": {
"enabled": true,
"created": 1493942451,
"updated": 1493942451,
"recoveryLevel": "Recoverable+Purgeable"
},
"tags": {
"purpose": "unit test",
"test name ": "CreateGetDeleteKeyTest"
}
}
Definiciones
Nombre | Description |
---|---|
Deletion |
Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención. |
Error |
Error del servidor del almacén de claves. |
Json |
A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
Json |
Nombre de curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName. |
Json |
Tipo de clave JsonWebKey (kty), tal y como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
Key |
Atributos de una clave administrada por el servicio del almacén de claves. |
Key |
KeyBundle que consta de un elemento WebKey más sus atributos. |
Key |
Reglas de directiva en las que se puede exportar la clave. |
Key |
Excepción de error del almacén de claves. |
DeletionRecoveryLevel
Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención.
Nombre | Tipo | Description |
---|---|---|
CustomizedRecoverable |
string |
Indica un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y mientras la suscripción sigue estando disponible. |
CustomizedRecoverable+ProtectedSubscription |
string |
Indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, la purga) no está permitida y en la que la propia suscripción no se puede cancelar permanentemente cuando 7<= SoftDeleteRetentionInDays < 90. Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y también refleja el hecho de que no se puede cancelar la propia suscripción. |
CustomizedRecoverable+Purgeable |
string |
Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención, a menos que se solicite una operación de purga o se cancele la suscripción. |
Purgeable |
string |
Indica un estado de almacén en el que la eliminación es una operación irreversible, sin la posibilidad de recuperación. Este nivel no corresponde a ninguna protección disponible en una operación de eliminación; los datos se pierden irrecuperablemente al aceptar una operación de eliminación en el nivel de entidad o superior (almacén, grupo de recursos, suscripción, etc.). |
Recoverable |
string |
Denota un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días) y mientras la suscripción sigue estando disponible. El sistema lo eliminará permanentemente después de 90 días, si no se recupera |
Recoverable+ProtectedSubscription |
string |
Indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar dentro del intervalo de retención (90 días), no se permite la eliminación inmediata y permanente (es decir, purga) y en la que la propia suscripción no se puede cancelar permanentemente. El sistema lo eliminará permanentemente después de 90 días, si no se recupera |
Recoverable+Purgeable |
string |
Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días), a menos que se solicite una operación de purga o se cancele la suscripción. El sistema lo eliminará permanentemente después de 90 días, si no se recupera |
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. |
JsonWebKey
A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
Nombre | Tipo | Description |
---|---|---|
crv |
Nombre de curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName. |
|
d |
string |
Exponente privado RSA o el componente D de una clave privada EC. |
dp |
string |
Parámetro de clave privada RSA. |
dq |
string |
Parámetro de clave privada RSA. |
e |
string |
Exponente público RSA. |
k |
string |
Clave simétrica. |
key_hsm |
string |
Clave protegida, que se usa con "Bring Your Own Key". |
key_ops |
string[] |
Operaciones de clave admitidas. |
kid |
string |
Identificador de clave. |
kty |
Tipo de clave JsonWebKey (kty), tal y como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
|
n |
string |
Módulo RSA. |
p |
string |
Primo de secreto RSA. |
q |
string |
Primo de secreto RSA, con p < q. |
qi |
string |
Parámetro de clave privada RSA. |
x |
string |
Componente X de una clave pública ec. |
y |
string |
Componente Y de una clave pública ec. |
JsonWebKeyCurveName
Nombre de curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
Nombre | Tipo | Description |
---|---|---|
P-256 |
string |
Curva elíptica NIST P-256, curva AKA SECG SECP256R1. |
P-256K |
string |
El SECG SECP256K1 curva elíptica. |
P-384 |
string |
Curva elíptica NIST P-384, curva AKA SECG SECP384R1. |
P-521 |
string |
Curva elíptica NIST P-521, curva AKA SECG SECP521R1. |
JsonWebKeyType
Tipo de clave JsonWebKey (kty), tal y como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
Nombre | Tipo | Description |
---|---|---|
EC |
string |
Curva elíptica. |
EC-HSM |
string |
Curva elíptica con una clave privada que se almacena en el HSM. |
RSA |
string |
|
RSA-HSM |
string |
RSA con una clave privada que se almacena en el HSM. |
oct |
string |
Secuencia de octetos (usada para representar claves simétricas) |
oct-HSM |
string |
Secuencia octeto (usada para representar claves simétricas) que se almacena el HSM. |
KeyAttributes
Atributos de una clave administrada por el servicio del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
created |
integer |
Hora de creación en UTC. |
enabled |
boolean |
Determina si el objeto está habilitado. |
exp |
integer |
Fecha de expiración en UTC. |
exportable |
boolean |
Indica si se puede exportar la clave privada. Se debe proporcionar la directiva de versión al crear la primera versión de una clave exportable. |
nbf |
integer |
No antes de la fecha en UTC. |
recoverableDays |
integer |
días de retención de datos softDelete. El valor debe ser >=7 y <=90 cuando softDelete está habilitado; en caso contrario, 0. |
recoveryLevel |
Refleja el nivel de recuperación de eliminación actualmente en vigor para las claves del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente la clave; de lo contrario, solo el sistema puede purgar la clave, al final del intervalo de retención. |
|
updated |
integer |
Hora de la última actualización en UTC. |
KeyBundle
KeyBundle que consta de un elemento WebKey más sus atributos.
Nombre | Tipo | Description |
---|---|---|
attributes |
Atributos de administración de claves. |
|
key |
Clave web Json. |
|
managed |
boolean |
True si el almacén de claves administra la duración de la clave. Si se trata de una clave que respalda un certificado, la administración será true. |
release_policy |
Reglas de directiva en las que se puede exportar la clave. |
|
tags |
object |
Metadatos específicos de la aplicación en forma de pares clave-valor. |
KeyReleasePolicy
Reglas de directiva en las que se puede exportar la clave.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
contentType |
string |
application/json; charset=utf-8 |
Tipo de contenido y versión de la directiva de versión de clave |
data |
string |
Codificación de blobs en las reglas de directiva en las que se puede liberar la clave. El blob debe estar codificado en la dirección URL base64. |
|
immutable |
boolean |
Define el estado de mutabilidad de la directiva. Una vez marcado como inmutable, esta marca no se puede restablecer y la directiva no se puede cambiar en ninguna circunstancia. |
KeyVaultError
Excepción de error del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
error |
Error del servidor del almacén de claves. |