Créer et gérer des baux de conteneur avec JavaScript ou TypeScript
Cet article explique comment créer et gérer des baux de conteneur à l’aide de la bibliothèque de client du Stockage Azure pour JavaScript. Vous pouvez utiliser la bibliothèque de client pour acquérir, renouveler, libérer et arrêter des baux de conteneur.
Prérequis
- Les exemples de cet article supposent que vous disposez déjà d'un projet configuré pour fonctionner avec la bibliothèque client Azure Blob Storage pour JavaScript. Pour en savoir plus sur la configuration de votre projet, y compris l’installation du package, l’importation de modules et la création d’un objet client autorisé à utiliser les ressources de données, consultez Prise en main de Stockage Blob Azure et JavaScript.
- Le mécanisme d’autorisation doit disposer des autorisations nécessaires pour utiliser un bail de conteneur. Pour en savoir plus, consultez les conseils d’autorisation pour l’opération d’API REST suivante :
À propos des baux de conteneur
Un bail établit et gère un verrou sur un conteneur pour les opérations de suppression. La durée du verrou peut être de 15 à 60 secondes, ou peut être infinie. Un bail sur un conteneur fournit un accès exclusif en suppression au conteneur. Un bail de conteneur contrôle uniquement la suppression du conteneur à l’aide de l’opération d’API REST Delete Container. Pour supprimer un conteneur avec un bail actif, le client doit inclure l'identificateur du bail actif dans la demande de suppression. Toutes les autres opérations de conteneur réussissent sur un conteneur loué sans ID de bail. Si vous avez activé la suppression réversible de conteneur, vous pouvez restaurer les conteneurs supprimés.
Pour en savoir plus sur les états de bail et sur le moment où vous pouvez effectuer une action donnée sur un bail, consultez États et actions de bail.
Les opérations de bail sont gérées par la classe BlobLeaseClient qui fournit un client contenant toutes les opérations de bail pour des objets blob et des conteneurs. Pour en savoir plus sur les baux de blob utilisant la bibliothèque de client, consultez Créer et gérer des baux de blob avec JavaScript.
Acquérir un bail
Quand vous obtenez un bail de conteneur, vous obtenez un ID de bail que votre code peut utiliser pour agir sur le conteneur. Si le conteneur a déjà un bail actif, vous pouvez uniquement demander un nouveau bail à l’aide de l’ID de bail actif. Toutefois, vous pouvez spécifier une nouvelle durée de bail.
Pour acquérir un bail, créez une instance de la classe BlobLeaseClient, puis utilisez l’une des méthodes suivantes :
L’exemple suivant acquiert un bail de 30 secondes pour un conteneur :
async function acquireContainerLeaseAsync(blobContainerClient) {
const leaseClient = blobContainerClient.getBlobLeaseClient();
await leaseClient.acquireLease(30);
return leaseClient;
}
Renouveler un bail
Vous pouvez renouveler un bail de conteneur si l’ID de bail spécifié dans la requête correspond à l’ID de bail associé au conteneur. Le bail peut être renouvelé même s’il a expiré, dès lors que le conteneur n’a pas été reloué depuis l’expiration de ce bail. Lorsque vous renouvelez un bail, la durée de bail se réinitialise.
Pour renouveler un bail, utilisez l’une des méthodes suivantes sur une instance BlobLeaseClient :
L’exemple suivant renouvelle un bail de conteneur :
async function renewContainerLeaseAsync(blobContainerClient, leaseID) {
const leaseClient = blobContainerClient.getBlobLeaseClient(leaseID);
await leaseClient.renewLease();
}
Libérer un bail
Vous pouvez libérer un bail de conteneur si l’ID de bail spécifié dans la requête correspond à l’ID de bail associé au conteneur. La libération du bail permet à un autre client d’acquérir un bail pour le conteneur immédiatement après la libération.
Vous pouvez libérer un bail avec l’une des méthodes suivantes sur une instance BlobLeaseClient :
L’exemple suivant libère un bail d’un conteneur :
async function releaseContainerLeaseAsync(blobContainerClient, leaseID) {
const leaseClient = blobContainerClient.getBlobLeaseClient(leaseID);
await leaseClient.releaseLease();
}
Arrêter un bail
Vous pouvez résilier un bail de conteneur si le conteneur a un bail actif. Toute requête autorisée peut arrêter le bail ; la demande ne spécifie pas obligatoirement un ID de bail correspondant. Un bail ne peut pas être renouvelé après son arrêt et la rupture d’un bail empêche l’acquisition d’un nouveau bail jusqu’à l’expiration ou la libération du bail d’origine.
Vous pouvez résilier un bail avec l’une des méthodes suivantes sur une instance BlobLeaseClient :
L’exemple suivant résilie un bail d’un conteneur :
async function breakContainerLeaseAsync(blobContainerClient) {
const leaseClient = blobContainerClient.getBlobLeaseClient();
await leaseClient.breakLease();
}
États et actions de bail
Le diagramme suivant montre les cinq états d'un bail, et les commandes ou les événements qui peuvent entraîner des modifications d'état du bail.
Le tableau suivant liste les cinq états de bail, en fournit une brève description et liste les actions de bail autorisées dans un état donné. Ces actions de bail entraînent des transitions d’état, comme illustré dans le diagramme.
| État du bail | Description | Actions de bail autorisées |
|---|---|---|
| Disponible | Le bail est déverrouillé et peut être acquis. | acquire |
| Loué | Le bail est verrouillé. | acquire (ID de bail identique uniquement), renew, change, release et break |
| Expired | La durée du bail a expiré. | acquire, renew, release et break |
| Rupture | Le bail a été résilié, mais continue d’être verrouillé jusqu’à l’expiration de la période de résiliation. | release et break |
| Rompu | Le bail a été résilié et la période de résiliation a expiré. | acquire, release et break |
Une fois un bail expiré, l’ID de bail est conservé par le service BLOB jusqu’à ce que le conteneur soit modifié ou loué de nouveau. Un client peut tenter de renouveler ou de libérer le bail en utilisant l’ID de bail expiré. Si la demande échoue, le client sait que le conteneur a été reloué ou qu’il a été supprimé depuis la dernière fois que le bail était actif.
Si un bail expire au lieu d'être explicitement libéré, un client doit attendre jusqu'à une minute avant qu'un nouveau bail puisse être acquis pour le conteneur. Toutefois, le client peut renouveler le bail avec l'ID de bail expiré immédiatement.
Ressources
Pour en savoir plus sur la gestion des baux de conteneur à l’aide de la bibliothèque de client Stockage Blob Azure pour JavaScript, consultez les ressources suivantes.
Exemples de code
- Voir les exemples de code JavaScript et TypeScript de cet article (GitHub)
Opérations de l'API REST
Le Kit de développement logiciel (SDK) Azure pour JavaScript contient des bibliothèques qui s’appuient sur l’API REST Azure, vous permettant d’interagir avec des opérations de l’API REST par le biais de paradigmes JavaScript familiers. Les méthodes de bibliothèque de client pour la gestion des baux de conteneur utilisent l’opération d’API REST suivante :
Ressources de bibliothèque cliente
- Documentation de référence sur la bibliothèque cliente
- Code source de la bibliothèque de client
- Package (npm)
Voir aussi
Contenu connexe
- Cet article fait partie du guide du développeur Stockage Blob pour JavaScript/TypeScript. Pour plus d’informations, consultez la liste complète des articles du guide du développeur dans Générer votre application JavaScript/TypeScript.