Gérer les propriétés et les métadonnées d’un conteneur avec JavaScript ou TypeScript

Article
11/04/2024

Les conteneurs d’objets blob prennent en charge des propriétés système et des métadonnées définies par l’utilisateur, en plus des données qu’ils contiennent. Cet article présente la gestion des propriétés système et des métadonnées définies par l’utilisateur avec la bibliothèque cliente Stockage Azure pour JavaScript.

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 avoir des autorisations pour fonctionner avec des propriétés de conteneur ou des métadonnées. Pour plus d’informations, consultez les conseils d’autorisation pour les opérations d’API REST suivantes :

À propos des propriétés et des métadonnées

Propriétés système : Propriétés système existant sur chaque ressource de stockage blob. Certaines d'entre elles peuvent être lues ou configurées, alors que d'autres sont en lecture seule. En arrière-plan, certaines propriétés système correspondent à certains en-têtes HTTP standard. La bibliothèque cliente de Stockage Azure pour JavaScript gère ces propriétés pour vous.
Métadonnées définies par l’utilisateur : ces métadonnées se composent d’une ou plusieurs paires nom/valeur, que vous spécifiez pour une ressource de stockage d’objets blob. Vous pouvez les utiliser pour stocker des valeurs supplémentaires avec la ressource. Les valeurs de métadonnées sont destinées à votre usage personnel et n’affectent pas le comportement de la ressource.

Les paires nom/valeur de métadonnées sont des en-têtes HTTP valides ; elles doivent donc respecter toutes les restrictions régissant les en-têtes HTTP. Pour plus d’informations sur les exigences de nommage des métadonnées, consultez Noms des métadonnées.

Récupérer les propriétés de conteneur

Pour récupérer les propriétés d’un conteneur, utilisez la méthode suivante :

ContainerClient.getProperties

L’exemple de code suivant récupère les propriétés d’un conteneur et écrit quelques valeurs des propriétés dans une fenêtre de console :

JavaScript
TypeScript

async function getContainerProperties(containerClient) {
  
  try {
    const containerProperties = await containerClient.getProperties();

    console.log(`Public access type: ${containerProperties.blobPublicAccess}`);
    console.log(`Lease status: ${containerProperties.leaseStatus}`);
    console.log(`Lease state: ${containerProperties.leaseState}`);
    console.log(`Has immutability policy: ${containerProperties.hasImmutabilityPolicy}`);
  } catch (err) {
    // Handle the error
  }
}

async function getContainerProperties(
  containerClient: ContainerClient
): Promise<void> {

  try {
    const containerProperties: ContainerGetPropertiesResponse =
      await containerClient.getProperties();

      console.log(`Public access type: ${containerProperties.blobPublicAccess}`);
      console.log(`Lease status: ${containerProperties.leaseStatus}`);
      console.log(`Lease state: ${containerProperties.leaseState}`);
      console.log(`Has immutability policy: ${containerProperties.hasImmutabilityPolicy}`);
  } catch (err) {
    // Handle the error
  }
}

Définir et récupérer des métadonnées

Vous pouvez indiquer des métadonnées sous la forme de paires nom-valeur sur une ressource de conteneur. Pour définir des métadonnées, créez un objet ContainerClient, puis utilisez la méthode suivante :

ContainerClient.setMetadata

L’exemple de code suivant définit les métadonnées d’un conteneur :

JavaScript
TypeScript

async function setContainerMetadata(containerClient) {
  
  const metadata = {
    docType: "textDocuments",
    docCategory: "testing",
  };
  
  await containerClient.setMetadata(metadata);

}

async function setContainerMetadata(
  containerClient: ContainerClient,
) {
  
  try {
    const metadata: Metadata = {
      // values must be strings
      docType: "textDocuments",
      docCategory: "testing"
    };
    await containerClient.setMetadata(metadata);
  }
  catch (err) {
    // Handle the error
  }
}

Pour récupérer des métadonnées, obtenez les propriétés du conteneur , puis utilisez la propriété retournée des métadonnées.

Ressources

Pour en savoir plus sur la définition et la récupération des propriétés de conteneur et des métadonnées à 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 les opérations de l’API REST par le biais de paradigmes JavaScript familiers. Les méthodes de la bibliothèque de client pour définir et récupérer des propriétés et des métadonnées utilisent les opérations d’API REST suivantes :

La méthode getProperties récupère les propriétés et les métadonnées de conteneur en appelant à la fois l’opération Obtenir les propriétés d’un objet blob et l’opération Obtenir les métadonnées d’un objet blob.

Partager via