Répertorier les conteneurs d’objets blob avec JavaScript ou TypeScript

Quand vous listez des conteneurs dans un compte de stockage Azure à partir de votre code, vous pouvez spécifier plusieurs options pour gérer la façon dont les résultats sont retournés à partir du stockage Azure. Cet article explique comment répertorier les conteneurs à l’aide de la bibliothèque de client de 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 disposer des autorisations nécessaires pour répertorier les conteneurs d’objets blob. Pour en savoir plus, consultez les conseils d’autorisation pour l’opération d’API REST suivante :
  • Lister des conteneurs

À propos des options de la liste de conteneurs

Quand vous listez les conteneurs dans votre code, vous pouvez spécifier des options pour gérer la façon dont les résultats sont retournés par le Stockage Azure. Vous pouvez spécifier le nombre de résultats à retourner dans chaque ensemble de résultats, puis récupérer les ensembles suivants. Vous pouvez également filtrer les résultats par un préfixe et retourner des métadonnées de conteneur avec les résultats. Les étapes de cette procédure sont décrites dans les sections suivantes.

Pour répertorier les conteneurs dans votre compte de stockage, appelez la méthode suivante :

• BlobServiceClient.listContainers

Cette méthode retourne une liste d’objets ContainerItem. Les conteneurs sont classés lexicographiquement par nom.

Gérez le nombre de résultats retournés

Par défaut, une opération de liste renvoie jusqu’à 5 000 résultats à la fois, mais vous pouvez spécifier le nombre de résultats que chaque opération de liste doit renvoyer. Les exemples présentés dans cet article vous montrent comment restituer les résultats en pages.

Filtrez les résultats avec un préfixe

Pour filtrer la liste des conteneurs, spécifiez une chaîne pour le paramètre prefix dans ServiceListContainersOptions. La chaîne de préfixe peut inclure un ou plusieurs caractères. Le stockage Azure retourne alors uniquement les conteneurs dont les noms commencent par ce préfixe.

Inclure des métadonnées de conteneur

Pour inclure les métadonnées de conteneurs dans les résultats, définissez le paramètre includeMetadata sur true dans ServiceListContainersOptions. Le Stockage Azure comprend des métadonnées avec chaque conteneur retourné. Vous n’avez donc pas besoin de récupérer les métadonnées de conteneur séparément.

Inclure des conteneurs supprimés

Pour inclure des conteneurs supprimés de manière réversible avec les résultats, définissez le paramètre includeDeleted dans ServiceListContainersOptions.

Exemple de code : Répertorier les conteneurs

L’exemple suivant répertorie de manière asynchrone les conteneurs dans un compte de stockage qui commencent par un préfixe spécifié. L’exemple répertorie les conteneurs qui commencent par le préfixe spécifié et retourne le nombre de résultats spécifié par appel de l’opération de création liste. Il utilise ensuite le jeton de continuation pour obtenir le segment suivant des résultats. L’exemple retourne également les métadonnées de conteneur avec les résultats.

async function listContainers(blobServiceClient, containerNamePrefix) {

  const options = {
    includeDeleted: false,
    includeMetadata: true,
    includeSystem: true,
    prefix: containerNamePrefix
  }

  console.log("Containers (by page):");
  for await (const response of blobServiceClient.listContainers(options).byPage({
    maxPageSize: 20,
  })) {
    console.log("- Page:");
    if (response.containerItems) {
      for (const container of response.containerItems) {
        console.log(`  - ${container.name}`);
      }
    }
  }
}

// return up to 5000 containers
async function listContainers(
  blobServiceClient: BlobServiceClient,
  containerNamePrefix: string
): Promise<void> {
  
  const options: ServiceListContainersOptions = {
    includeDeleted: false,
    includeMetadata: true,
    includeSystem: true,
    prefix: containerNamePrefix
  };

  console.log("Containers (by page):");
  for await (const response of blobServiceClient.listContainers().byPage({
    maxPageSize: 20,
  })) {
    console.log("- Page:");
    if (response.containerItems) {
      for (const container of response.containerItems) {
        console.log(`  - ${container.name}`);
      }
    }
  }
}

Ressources

Pour en savoir plus sur la création de listes de conteneurs à l’aide de la bibliothèque de client Stockage Blob Azure pour JavaScript, consultez les ressources suivantes.

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 bibliothèque de client pour le listing de conteneurs utilisent l’opération d’API REST suivante :

• List Containers (API REST)

Exemples de code

• Consultez des exemples de code JavaScript et TypeScript de cet article (GitHub)

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

• Énumération des ressources d’objets blob

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)