Partager via

Lister les conteneurs de blobs avec Java

  • Article

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 lister des conteneurs avec la bibliothèque de client du Stockage Azure pour Java.

Prérequis

  • Cet article suppose que vous disposez déjà d'un projet configuré pour fonctionner avec la bibliothèque client Stockage Blob Azure pour Java. Pour en savoir plus sur la configuration de votre projet, notamment l’installation de package, l’ajout de directives import et l’autorisation d’un objet client, consultez Prise en main du Stockage Azure et Java.
  • 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 :

À 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 un compte de stockage, appelez la méthode suivante :

Cette méthode retourne une itérable de type BlobContainerItem. Les conteneurs sont classés lexicographiquement par nom.

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

Par défaut, une opération de dressage de liste renvoie jusqu’à 5 000 résultats à la fois. Pour retourner un ensemble de résultats plus petit, fournissez une valeur différente de zéro pour la taille de la page de résultats à retourner. Vous pouvez définir cette valeur à l’aide de la méthode suivante :

Les exemples présentés dans cet article vous montrent comment restituer les résultats en pages. Pour en savoir plus sur les concepts de pagination, consultez Pagination avec le kit de développement logiciel (SDK) Azure pour Java.

Filtrez les résultats avec un préfixe

Pour filtrer la liste des conteneurs, spécifiez une chaîne pour le paramètre prefix. 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. Vous pouvez définir cette valeur à l’aide de la méthode suivante :

Inclure des métadonnées de conteneur

Pour inclure des métadonnées de conteneur avec les résultats, créez une instance BlobContainerListDetails et passez true à la méthode suivante :

Passez ensuite l’objet BlobContainerListDetails à la méthode suivante :

Inclure des conteneurs supprimés

Pour inclure des conteneurs supprimés de manière réversible aux résultats, créez une instance BlobContainerListDetails et passez true à la méthode suivante :

Passez ensuite l’objet BlobContainerListDetails à la méthode suivante :

Exemples de code

L’exemple suivant liste les conteneurs et filtre les résultats selon un préfixe spécifié :

public void listContainers(BlobServiceClient blobServiceClient) {
    // Set a prefix to filter results based on a specified character or string
    ListBlobContainersOptions options = new ListBlobContainersOptions()
            .setPrefix("container-");

    System.out.println("List containers:");
    for (BlobContainerItem blobContainerItem : blobServiceClient.listBlobContainers(options, null)) {
        System.out.printf("Container name: %s%n", blobContainerItem.getName());
    }
}

Vous pouvez également retourner un ensemble plus petit de résultats, en spécifiant la taille de la page de résultats à retourner :

public void listContainersWithPaging(BlobServiceClient blobServiceClient) {
    // Set a prefix to filter results and specify a page limit
    ListBlobContainersOptions options = new ListBlobContainersOptions()
            .setMaxResultsPerPage(2)  // Low number for demonstration purposes
            .setPrefix("container-");

    int i = 0;
    Iterable<PagedResponse<BlobContainerItem>> blobContainerPages = blobServiceClient
            .listBlobContainers(options, null).iterableByPage();
    for (PagedResponse<BlobContainerItem> page : blobContainerPages) {
        System.out.printf("Page %d%n", ++i);
        page.getElements().forEach(container -> {
            System.out.printf("Name: %s%n", container.getName());
        });
    }
}

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 Java, consultez les ressources suivantes.

Opérations de l'API REST

Le Kit de développement logiciel (SDK) Azure pour Java 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 Java familiers. Les méthodes de bibliothèque de client pour le listing de conteneurs utilisent l’opération d’API REST suivante :

Exemples de code

Ressources de bibliothèque cliente

Voir aussi