Referencia de la API REST de Azure Key Vault

  • Artículo

Use Key Vault para proteger y administrar claves criptográficas, certificados y secretos usados por servicios y aplicaciones en la nube.

Operaciones de Key Vault

Operación Descripción
Comprueba la disponibilidad del nombre Comprueba que el nombre del almacén es válido y que aún no está en uso.
Crear o actualizar Cree o actualice un almacén de claves en la suscripción especificada.
Actualizar directiva de acceso Actualice las directivas de acceso en un almacén de claves de la suscripción especificada.
Get Obtiene el almacén de claves de Azure especificado.
Lista La operación List obtiene información sobre los almacenes asociados a la suscripción.
Enumerar por grupo de recursos La operación List obtiene información sobre los almacenes asociados a la suscripción y dentro del grupo de recursos especificado.
List By Subscription (Enumerar por suscripción) La operación List obtiene información sobre los almacenes asociados a la suscripción.
Actualizar Actualice un almacén de claves en la suscripción especificada.
Eliminar Elimina el almacén de claves de Azure especificado.
Obtener eliminado Obtiene el almacén de claves de Azure eliminado.
Enumerar eliminado Obtiene información sobre los almacenes eliminados de una suscripción.
Purgar Elimina permanentemente el almacén especificado.
Operación Descripción
Enumerar por almacén Obtiene los recursos de vínculo privado admitidos para el almacén de claves.

Operaciones de conexiones de punto de conexión privado

Operación Descripción
Get Obtiene la conexión de punto de conexión privado especificada asociada al almacén de claves.
Enumerar por recurso La operación List obtiene información sobre las conexiones de punto de conexión privado asociadas al almacén.
Poner Novedades la conexión de punto de conexión privado especificada asociada al almacén de claves.
Eliminar Elimina la conexión de punto de conexión privado especificada asociada al almacén de claves.

Operaciones de HSM administradas

Operación Descripción
Crear o actualizar Cree o actualice un grupo de HSM administrado en la suscripción especificada.
Get Obtiene el grupo de HSM administrado especificado.
Enumerar por grupo de recursos La operación List obtiene información sobre los grupos de HSM administrados asociados a la suscripción y dentro del grupo de recursos especificado.
List By Subscription (Enumerar por suscripción) La operación List obtiene información sobre los grupos de HSM administrados asociados a la suscripción.
Actualizar Actualice un grupo de HSM administrado en la suscripción especificada.
Obtener eliminado Obtiene el HSM administrado eliminado especificado.
Enumerar eliminado La operación List obtiene información sobre los HSM administrados eliminados asociados a la suscripción.
Eliminar Elimina el grupo de HSM administrado especificado.
Purgar eliminada Elimina permanentemente el HSM administrado especificado.
Operación Descripción
Enumerar por recurso MHSM Obtiene los recursos de private link admitidos para el grupo de HSM administrado.

Operaciones de conexiones de punto de conexión privado

Operación Descripción
Get Obtiene la conexión de punto de conexión privado especificada asociada al grupo de HSM administrado.
Enumerar por recurso La operación List obtiene información sobre las conexiones de punto de conexión privado asociadas al grupo de HSM administrado.
Poner Novedades la conexión de punto de conexión privado especificada asociada al grupo de HSM administrado.
Eliminar Elimina la conexión de punto de conexión privado especificada asociada al grupo de HSM administrado.

Operaciones de dominio de seguridad de HSM

Operación Descripción
Descargar Recupera el dominio de seguridad del HSM administrado. Se puede usar una llamada a este punto de conexión para activar un recurso HSM administrado aprovisionado.
Descargar pendiente Recupera el estado de la operación de descarga del dominio de seguridad.
Cargar Restaure el dominio de seguridad proporcionado.
Cargar pendiente Obtiene el estado de la operación de carga del dominio de seguridad.

Operaciones de configuración de HSM administradas

Operación Descripción
Obtener configuración Obtiene el objeto de configuración de cuenta especificado. Recupera el objeto de configuración de un nombre de configuración especificado.
Obtener configuración Enumerar la configuración de la cuenta. Recupera una lista de todas las opciones de la cuenta disponibles que se pueden configurar.
Actualizar configuración Novedades configuración de la cuenta del almacén de claves, la almacena y, a continuación, devuelve el nombre y el valor de configuración al cliente. Descripción de la configuración del grupo que se va a actualizar

Operaciones de control de acceso basado en rol

Operaciones de asignación de roles

Operación Descripción
Get Obtiene la asignación de roles especificada.
Lista Obtiene las asignaciones de roles de un ámbito.
Creación Crea una asignación de roles.
Eliminar Elimina una asignación de roles.

Operaciones de definición de roles

Operación Descripción
Get Obtiene la definición de rol especificada.
Lista Obtenga todas las definiciones de roles aplicables en el ámbito y versiones posteriores.
Crear o actualizar Crea o actualiza una definición de rol personalizada.
Eliminar Elimina una definición de rol personalizada.

Operaciones de copia de seguridad y restauración

Operación Descripción
Copia de seguridad completa Crea una copia de seguridad completa mediante un token de SAS proporcionado por el usuario en un contenedor de Azure Blob Storage. Esta operación solo es compatible con el servicio HSM administrado.
Estado de copia de seguridad Devuelve el estado de la operación de copia de seguridad completa.
Restauración completa Restaura todos los materiales clave mediante el token de SAS que apunta a una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente.
Restauración selectiva Restaura todas las versiones clave de una clave determinada mediante el token de SAS proporcionado por el usuario que apunta a una carpeta de copia de seguridad de Azure Blob Storage almacenada anteriormente.
Estado de restauración Devuelve el estado de la operación de restauración.

Operaciones de clave (Key Vault/HSM administrado)

Operación Descripción
Obtener clave Obtiene la parte pública de una clave almacenada.
Obtención de claves Enumera las claves del almacén especificado.
Obtención de versiones clave Recupera una lista de versiones de clave individuales con el mismo nombre de clave.
Crear clave Crea una nueva clave, la almacena y luego devuelve parámetros y atributos clave al cliente.
Importar clave Importa una clave creada externamente, la almacena y devuelve parámetros y atributos de clave al cliente.
Actualizar clave 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.
Eliminar clave Elimina una clave de cualquier tipo del almacenamiento en Azure Key Vault.
Obtención de la clave eliminada Obtiene la parte pública de una clave eliminada.
Obtención de claves eliminadas Enumera las claves eliminadas en el almacén especificado.
Purgar clave eliminada Elimina permanentemente la clave especificada.
Recuperar clave eliminada Recupera la clave eliminada en su versión más reciente.
Copia de seguridad de clave Solicita que se descargue una copia de seguridad de la clave especificada en el cliente.
Restauración de clave Restaura una clave de copia de seguridad en un almacén.
Clave de versión Libera una clave. La operación de clave de versión es aplicable a todos los tipos de clave. La clave de destino debe marcarse como exportable. Esta operación requiere el permiso keys/release.
Girar clave 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.
Obtención de la directiva de rotación de claves Enumera la directiva de una clave. La operación GetKeyRotationPolicy devuelve los recursos de directiva de clave especificados en el almacén de claves especificado. Esta operación requiere el permiso keys/get.
Actualización de la directiva de rotación de claves 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 de claves y actualización.

Operaciones de clave (solo HSM administrado)

Operación Descripción
Obtener bytes aleatorios Obtenga el número solicitado de bytes que contienen valores aleatorios de un HSM administrado.

Operaciones criptográficas (Key Vault/HSM administrado)

Operación Descripción
Descifrado Descifra un único bloque de datos cifrados.
Encrypt Cifra una secuencia arbitraria de bytes mediante una clave de cifrado almacenada en un almacén de claves.
Ajustar clave Ajusta una clave simétrica mediante una clave especificada.
Desencapsular clave Desencapsula una clave simétrica mediante la clave especificada que se usó inicialmente para encapsular esa clave.
Firmar Crea una firma a partir de un resumen mediante la clave especificada.
Verify Comprueba una firma mediante una clave especificada.

Operaciones secretas (solo Key Vault)

Operación Descripción
Obtener secreto Obtenga un secreto especificado de un almacén de claves determinado.
Obtener secretos Enumeración de secretos en un almacén de claves especificado.
Obtener versiones secretas Enumera todas las versiones del secreto especificado.
Establecer secreto Establece un secreto en un almacén de claves especificado.
Actualizar secreto Novedades los atributos asociados a un secreto especificado en un almacén de claves determinado.
Eliminar secreto Elimina un secreto de un almacén de claves especificado.
Obtener secreto eliminado Obtiene el secreto eliminado especificado.
Obtención de secretos eliminados Enumera los secretos eliminados del almacén especificado.
Purgar secreto eliminado Elimina permanentemente el secreto especificado.
Recuperar secreto eliminado Recupera el secreto eliminado en la versión más reciente.
Copia de seguridad de secreto Realiza una copia de seguridad del secreto especificado.
Restaurar secreto Restaura un secreto de copia de seguridad en un almacén.

Operaciones de administración de claves de cuenta de almacenamiento (solo Key Vault)

Operaciones de configuración de la cuenta de almacenamiento

Operación Descripción
Obtención de la cuenta de almacenamiento Obtiene información sobre una cuenta de almacenamiento especificada. Esta operación requiere el permiso storage/get.
Obtención de cuentas de almacenamiento Enumere las cuentas de almacenamiento administradas por el almacén de claves especificado. Esta operación requiere el permiso storage/list.
Actualizar cuenta de almacenamiento Novedades los atributos especificados asociados a la cuenta de almacenamiento especificada. Esta operación requiere el permiso storage/set/update.
Establecimiento de la cuenta de almacenamiento Crea o actualiza una nueva cuenta de almacenamiento. Esta operación requiere el permiso storage/set.
Eliminación de la cuenta de almacenamiento Elimina una cuenta de almacenamiento. Esta operación requiere el permiso de almacenamiento o eliminación.
Obtención de la cuenta de almacenamiento eliminada Obtiene la cuenta de almacenamiento eliminada especificada.
Obtención de cuentas de almacenamiento eliminadas Enumera las cuentas de almacenamiento eliminadas del almacén especificado.
Purga de la cuenta de almacenamiento eliminada Elimina permanentemente la cuenta de almacenamiento especificada.
Recuperación de cuentas de almacenamiento eliminadas Recupera la cuenta de almacenamiento eliminada.
Cuenta de almacenamiento de copia de seguridad Realiza una copia de seguridad de la cuenta de almacenamiento especificada.
Restauración de cuentas de almacenamiento Restaura una cuenta de almacenamiento de copia de seguridad en un almacén.

Operaciones de clave de cuenta de almacenamiento

Operación Descripción
Volver a generar clave de cuenta de almacenamiento Vuelve a generar el valor de clave especificado para la cuenta de almacenamiento especificada. Esta operación requiere el permiso storage/regeneratekey.

Operaciones de SAS de la cuenta de almacenamiento

Operación Descripción
Obtención de la definición de Sas Obtiene información sobre una definición de SAS para la cuenta de almacenamiento especificada. Esta operación requiere el permiso storage/getsas.
Obtención de definiciones de Sas Enumera las definiciones de SAS de almacenamiento de la cuenta de almacenamiento especificada. Esta operación requiere el permiso storage/listsas.
Establecer definición de Sas Crea o actualiza una nueva definición de SAS para la cuenta de almacenamiento especificada. Esta operación requiere el permiso storage/setsas.
Actualización de la definición de Sas Novedades los atributos especificados asociados a la definición de SAS especificada. Esta operación requiere el permiso storage/setsas.
Eliminar definición de Sas Elimina una definición de SAS de una cuenta de almacenamiento especificada. Esta operación requiere el permiso storage/deletesas.
Obtención de la definición de Sas eliminada Obtiene la definición sas eliminada especificada.
Obtención de definiciones de Sas eliminadas Enumera las definiciones de SAS eliminadas del almacén y la cuenta de almacenamiento especificadas.
Recuperación de la definición de Sas eliminada Recupera la definición de SAS eliminada.

Operaciones de certificado (solo Key Vault)

Operación Descripción
Obtener certificado Obtiene información sobre un certificado.
Obtención de certificados Enumeración de certificados en un almacén de claves especificado
Obtener versiones de certificado Enumera las versiones de un certificado.
Crear certificado Crea un nuevo certificado.
Importar certificado Importa un certificado en un almacén de claves especificado.
Certificado de combinación Combina un certificado o una cadena de certificados con un par de claves existente en el servidor.
Obtención de la operación de certificado Obtiene la operación de creación de un certificado.
Actualizar operación de certificado Novedades una operación de certificado.
Eliminar operación de certificado Elimina la operación de creación de un certificado específico.
Actualizar certificado Actualiza los atributos especificados asociados con el certificado dado.
Eliminar certificado Elimina un certificado de un almacén de claves especificado.
Obtener certificado eliminado Recupera información sobre el certificado eliminado especificado.
Obtención de certificados eliminados Enumera los certificados eliminados en el almacén especificado actualmente disponible para la recuperación.
Purga del certificado eliminado Elimina permanentemente el certificado eliminado especificado.
Recuperar certificado eliminado Recupera el certificado eliminado a su versión actual en /certificates.
Copia de seguridad de certificado Realiza una copia de seguridad del certificado especificado.
Restaurar certificado Restaura un certificado de copia de seguridad en un almacén.

Operaciones de directiva de certificado

Operación Descripción
Obtener directiva de certificado Enumera la directiva de un certificado.
Actualizar directiva de certificado Novedades la directiva de un certificado.

Operaciones de contactos de certificado

Operación Descripción
Obtener contactos de certificado Enumera los contactos de certificado de un almacén de claves especificado.
Establecer contactos de certificado Establece los contactos de certificado para el almacén de claves especificado.
Eliminar contactos de certificado Elimina los contactos de certificado de un almacén de claves especificado.

Operaciones del emisor de certificados

Operación Descripción
Obtención del emisor de certificados Enumera el emisor de certificado especificado.
Obtención de emisores de certificados Enumerar emisores de certificados para un almacén de claves especificado.
Establecimiento del emisor de certificados Establece el emisor de certificado especificado.
Actualizar emisor de certificados Novedades el emisor de certificados especificado.
Elimina el emisor de certificado. Elimina el emisor de certificado especificado.

Consulte también