Update Key - Update Key

  • Referencia
Service:
Key Vault
API Version:
7.4

La operación de actualización de clave cambia los atributos especificados de una clave almacenada y se puede aplicar a cualquier tipo de clave y versión de clave almacenada en Azure Key Vault.
Para realizar esta operación, la clave debe existir en el Almacén de claves. Nota: No se puede cambiar el material criptográfico de una clave propiamente dicha. Esta operación requiere el permiso de claves y actualización.

PATCH {vaultBaseUrl}/keys/{key-name}/{key-version}?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 actualizar.
key-version
 path True

string

Versión de la clave que se va a actualizar.
vaultBaseUrl
 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

KeyAttributes

Atributos de una clave administrada por el servicio key vault.
key_ops

JsonWebKeyOperation[]

Operaciones de clave web JSON. Para obtener más información sobre las posibles operaciones de clave, consulte JsonWebKeyOperation.
release_policy

KeyReleasePolicy

Reglas de directiva con las que se puede exportar la clave.
tags

object

Metadatos específicos de la aplicación en forma de pares clave-valor.

Respuestas

Nombre Tipo Description
200 OK

KeyBundle

Clave actualizada.
Other Status Codes

KeyVaultError

Key Vault respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

Update key

Sample Request

PATCH https://myvault.vault.azure.net//keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088?api-version=7.4

{
  "key_ops": [
    "decrypt",
    "encrypt"
  ],
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800
  }
}

Sample Response

Status code:
200 
{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088",
    "kty": "RSA",
    "key_ops": [
      "decrypt",
      "encrypt"
    ],
    "n": "tHCSyq1FqGHXIFHs1m4riKYgPFNSTlJGPzxwfUyZJUxxZsFWMxmZRzbM3kcXC5N40AJfeqDOMs0gY0LZEfhw8kJHBf2GEH2Sz923E4OQjLk_ECdAiKPW_8t22cqD_pGIuB7uibjLZgFFRv7oe0t8cTXKn7IwAH5gQBLs8NNV7hx1Ozy82ekCgOovFldmD3c3P1oZQ_v_-jOP6O202aEfDcZut42J6zI8eYwvGiDKmo2fCPPeth1LYBOeUMnrEZGT_f_w3yAgqvuSkHCL0x4MjZzc2EoNI_3ooAHZohDaPHLRfz8neDPADZzbHA6SDn3GgvC1K_Je5GBmqjTH3aIMlw",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800,
    "created": 1493860275,
    "updated": 1493860277,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definiciones

Nombre Description
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.
Error

Error del servidor del almacén de claves.
JsonWebKey

A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName

Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
JsonWebKeyOperation
JsonWebKeyType

Tipo de clave JsonWebKey (kty), tal como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes

Atributos de una clave administrada por el servicio key vault.
KeyBundle

KeyBundle que consta de un elemento WebKey más sus atributos.
KeyReleasePolicy

Reglas de directiva con las que se puede exportar la clave.
KeyUpdateParameters

Parámetros de actualización de claves.
KeyVaultError

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

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). 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, purgar). 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

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

JsonWebKeyCurveName

Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
d

string

Exponente privado RSA o componente D de una clave privada de 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, usada con "Bring Your Own Key".
key_ops

string[]

Operaciones de clave admitidas.
kid

string

Identificador de clave.
kty

JsonWebKeyType

Tipo de clave JsonWebKey (kty), tal como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n

string

Módulo RSA.
p

string

Valor primo del secreto RSA.
q

string

Primo secreto RSA, con p < q.
qi

string

Parámetro de clave privada RSA.
x

string

Componente X de una clave pública de EC.
y

string

Componente Y de una clave pública de CE.

JsonWebKeyCurveName

Nombre de la 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

Secg SECP256K1 curva elíptica.
P-384

string

La curva elíptica NIST P-384, curva AKA SECG SECP384R1.
P-521

string

Curva elíptica NIST P-521, curva AKA SECG SECP521R1.

JsonWebKeyOperation

Nombre Tipo Description
decrypt

string

encrypt

string

export

string

import

string

sign

string

unwrapKey

string

verify

string

wrapKey

string

JsonWebKeyType

Tipo de clave JsonWebKey (kty), tal 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 (https://tools.ietf.org/html/rfc3447)
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 de octetos (usada para representar claves simétricas) que se almacena el HSM.

KeyAttributes

Atributos de una clave administrada por el servicio key vault.

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, es 0.
recoveryLevel

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

KeyAttributes

Atributos de administración de claves.
key

JsonWebKey

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, se administrará como true.
release_policy

KeyReleasePolicy

Reglas de directiva con 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 con 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 con 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.

KeyUpdateParameters

Parámetros de actualización de claves.

Nombre Tipo Description
attributes

KeyAttributes

Atributos de una clave administrada por el servicio key vault.
key_ops

JsonWebKeyOperation[]

Operaciones de clave web JSON. Para obtener más información sobre las posibles operaciones de clave, consulte JsonWebKeyOperation.
release_policy

KeyReleasePolicy

Reglas de directiva con las que se puede exportar la clave.
tags

object

Metadatos específicos de la aplicación en forma de pares clave-valor.

KeyVaultError

Excepción de error del almacén de claves.

Nombre Tipo Description
error

Error

Error del servidor del almacén de claves.