Creación y administración de concesiones de contenedores con JavaScript o TypeScript
En este artículo se muestra cómo crear y administrar concesiones de contenedores mediante la biblioteca cliente para JavaScript en Azure Storage. Puede usar la biblioteca cliente para adquirir, renovar, liberar e interrumpir concesiones de contenedor.
Requisitos previos
- Los ejemplos de este artículo asumen que ya tiene un proyecto configurado para trabajar con la librería cliente Azure Blob Storage para JavaScript. Para obtener más información sobre la configuración del proyecto, incluida la instalación de paquetes, la importación de módulos y la creación de un objeto cliente autorizado para trabajar con recursos de datos, consulte Introducción a Azure Blob Storage y JavaScript.
- El mecanismo de autorización debe tener permisos para trabajar con un arrendamiento de contenedor. Para obtener más información, consulte la guía de autorización para la siguiente operación de la API de REST:
Acerca de las concesiones de contenedor
Una concesión establece y administra un bloqueo en un contenedor para las operaciones de eliminación. La duración del bloqueo puede ser de 15 a 60 segundos, o puede ser infinita. Una concesión sobre un contenedor proporciona acceso exclusivo de eliminación sobre el contenedor. Una concesión de contenedor solo controla la capacidad de eliminar el contenedor mediante la operación Eliminar contenedor de la API de REST. Para eliminar un contenedor con una concesión activa, un cliente debe incluir el identificador de concesión activo con la solicitud de eliminación. Todas las demás operaciones de contenedor se realizarán correctamente en un contenedor sujeto a una concesión sin necesidad de incluir el identificador de concesión. Si ha habilitado la eliminación temporal de contenedores, puede restaurar los contenedores eliminados.
Para obtener más información sobre los estados de concesión y cuándo puedes realizar una acción determinada en una concesión, consulta Estados y acciones de concesión.
Las operaciones de concesión se controlan mediante la clase BlobLeaseClient, que proporciona un cliente que contiene todas las operaciones de concesión para blobs y contenedores. Para más información sobre las concesiones de blob mediante la biblioteca cliente, consulte Creación y administración de concesiones de blob con JavaScript.
Adquisición de una concesión
Al adquirir una concesión de contenedor, obtienes un identificador de concesión que el código puede usar para operar en el contenedor. Si el contenedor ya tiene una concesión activa, solo puedes solicitar una nueva concesión mediante el id. de concesión activo. No obstante, puede especificar una nueva duración de concesión.
Para adquirir una concesión, cree una instancia de la clase BlobLeaseClient y luego use uno de los siguientes métodos:
En el ejemplo siguiente, se adquiere una concesión de 30 segundos para un contenedor:
async function acquireContainerLeaseAsync(blobContainerClient) {
const leaseClient = blobContainerClient.getBlobLeaseClient();
await leaseClient.acquireLease(30);
return leaseClient;
}
Renovación de una concesión
Puedes renovar una concesión de contenedor si el id. de concesión especificado en la solicitud coincide con el id. de concesión asociado al contenedor. La concesión se puede renovar incluso si expira, siempre que el contenedor no se haya concedido de nuevo desde la caducidad de la concesión. Cuando se renueva una concesión, se restablece su duración.
Para renovar una concesión, use uno de estos métodos en una instancia de BlobLeaseClient:
En el ejemplo siguiente, se renueva una concesión de contenedor:
async function renewContainerLeaseAsync(blobContainerClient, leaseID) {
const leaseClient = blobContainerClient.getBlobLeaseClient(leaseID);
await leaseClient.renewLease();
}
Liberación de una concesión
Puedes liberar una concesión de contenedor si el id. de concesión especificado en la solicitud coincide con el id. de concesión asociado al contenedor. Liberar la concesión permite a otro cliente adquirir la concesión sobre el contenedor inmediatamente después de que finalice la operación de liberación.
Puede liberar una concesión mediante uno de los métodos siguientes en una instancia de BlobLeaseClient:
En el ejemplo siguiente, se libera una concesión en un contenedor:
async function releaseContainerLeaseAsync(blobContainerClient, leaseID) {
const leaseClient = blobContainerClient.getBlobLeaseClient(leaseID);
await leaseClient.releaseLease();
}
Interrupción de una concesión
Puedes interrumpir una concesión de contenedor si el contenedor tiene una concesión activa. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Una concesión no se puede renovar después de que se interrumpa, e interrumpir una concesión impedirá que se adquiera una nueva concesión hasta que expire o se libere la concesión original.
Puede interrumpir una concesión mediante uno de los métodos siguientes en una instancia de BlobLeaseClient:
En el ejemplo siguiente, se interrumpe una concesión de un contenedor:
async function breakContainerLeaseAsync(blobContainerClient) {
const leaseClient = blobContainerClient.getBlobLeaseClient();
await leaseClient.breakLease();
}
Estados y acciones de concesión
En el diagrama siguiente se muestran los cinco estados de una concesión y los comandos o los eventos que provocan cambios en el estado de la misma.
En la tabla siguiente se enumeran los cinco estados de concesión, se proporciona una breve descripción de cada uno y se enumeran las acciones de concesión permitidas en un estado determinado. Estas acciones de concesión provocan transiciones de estado, como se muestra en el diagrama.
| Estado de concesión | Descripción | Acciones de concesión permitidas |
|---|---|---|
| Disponible | La concesión está desbloqueada y se puede adquirir. | acquire |
| Leased | La concesión está bloqueada. | acquire (solo con el mismo identificador de concesión), renew, change, release y break. |
| Expired | La duración de la concesión ha expirado. | acquire, renew, release y break. |
| Problemático | La concesión se ha interrumpido, pero seguirá bloqueada hasta que haya expirado el período de interrupción. | release y break |
| Interrumpido | La concesión se ha interrumpido y el período de interrupción ha expirado. | acquire, release y break |
Cuando expira una concesión, Blob service mantiene el identificador de concesión hasta que el contenedor se modifica o se concede de nuevo. Un cliente puede intentar renovar o liberar la concesión mediante el identificador de concesión expirado. Si se produce un error en la solicitud, el cliente sabe que el contenedor se ha concedido de nuevo, o que se ha eliminado desde que la concesión estuvo activa por última vez.
Si una concesión expira en lugar de liberarse explícitamente, es posible que el cliente tenga que esperar hasta un minuto para poder adquirir una nueva concesión sobre el contenedor. Sin embargo, el cliente puede renovar inmediatamente la concesión con el identificador de concesión expirada.
Recursos
Para obtener más información sobre cómo administrar concesiones de contenedor con la biblioteca cliente para JavaScript en Azure Blob Storage para JavaScript, consulte los recursos siguientes.
Ejemplos de código
- Ver ejemplos de código de JavaScript y TypeScript de este artículo (GitHub)
Operaciones de API REST
El SDK de Azure para JavaScript contiene bibliotecas que se crean a partir de la API REST de Azure, lo que le permite interactuar con las operaciones de API REST a través de paradigmas conocidos de JavaScript. Los métodos de la biblioteca cliente para administrar concesiones de contenedor usan esta operación de API de REST:
Recursos de la biblioteca cliente
- Documentación de referencia de la biblioteca cliente
- Código fuente de la biblioteca del cliente
- Paquete (npm)
Consulte también
Contenido relacionado
- Este artículo forma parte de la guía para desarrolladores de Blob Storage para JavaScript/Typescript. Para obtener más información, consulte la lista completa de artículos de la guía para desarrolladores en Compilación de la aplicación JavaScript/Typescript.