Listar blobs com .NET

  • Artigo

Este artigo mostra como listar blobs com a biblioteca de cliente do Armazenamento do Microsoft Azure para .NET.

Pré-requisitos

  • Este artigo pressupõe que já tem um projeto configurado para funcionar com a biblioteca de cliente Armazenamento de Blobs do Azure para .NET. Para saber mais sobre como configurar o projeto, incluindo a instalação de pacotes, a adição using de diretivas e a criação de um objeto de cliente autorizado, veja Introdução ao Armazenamento de Blobs do Azure e .NET.
  • O mecanismo de autorização tem de ter permissões para listar blobs. Para saber mais, veja a documentação de orientação de autorização para a seguinte operação da API REST:

Acerca das opções de listagem de blobs

Quando lista blobs do seu código, pode especificar várias opções para gerir a forma como os resultados são devolvidos do Armazenamento do Azure. Pode especificar o número de resultados a devolver em cada conjunto de resultados e, em seguida, obter os conjuntos subsequentes. Pode especificar um prefixo para devolver blobs cujos nomes começam com esse caráter ou cadeia. E pode listar blobs numa estrutura de listagem simples ou hierárquica. Uma listagem hierárquica devolve blobs como se estivessem organizados em pastas.

Para listar os blobs numa conta de armazenamento, chame um destes métodos:

Gerir quantos resultados são devolvidos

Por predefinição, uma operação de listagem devolve até 5000 resultados de cada vez, mas pode especificar o número de resultados que pretende que cada operação de listagem devolva. Os exemplos apresentados neste artigo mostram-lhe como devolver resultados em páginas. Para saber mais sobre os conceitos de paginação, veja Pagination with the Azure SDK for .NET (Paginação com o SDK do Azure para .NET).

Filtrar resultados com um prefixo

Para filtrar a lista de blobs, especifique uma cadeia para o prefix parâmetro . A cadeia de prefixo pode incluir um ou mais carateres. Em seguida, o Armazenamento do Azure devolve apenas os blobs cujos nomes começam com esse prefixo.

Devolver metadados

Pode devolver metadados de blobs com os resultados ao especificar o valor metadados para a enumeração BlobTraits .

Listagem simples versus listagem hierárquica

Os blobs no Armazenamento do Azure estão organizados num paradigma simples, em vez de num paradigma hierárquico (como um sistema de ficheiros clássico). No entanto, pode organizar blobs em diretórios virtuais para imitar uma estrutura de pastas. Um diretório virtual faz parte do nome do blob e é indicado pelo caráter delimitador.

Para organizar blobs em diretórios virtuais, utilize um caráter delimitador no nome do blob. O caráter delimitador predefinido é uma barra (/), mas pode especificar qualquer caráter como delimitador.

Se atribuir um nome aos blobs através de um delimitador, pode optar por listar os blobs hierárquicos. Para uma operação de listagem hierárquica, o Armazenamento do Azure devolve todos os diretórios virtuais e blobs abaixo do objeto principal. Pode chamar a operação de listagem de forma recursiva para percorrer a hierarquia, de forma semelhante à forma como percorreria um sistema de ficheiros clássico através de programação.

Utilizar uma listagem simples

Por predefinição, uma operação de listagem devolve blobs numa listagem simples. Numa listagem simples, os blobs não são organizados por diretório virtual.

O exemplo seguinte lista os blobs no contentor especificado através de uma listagem simples, com um tamanho de segmento opcional especificado e escreve o nome do blob numa janela da consola.

private static async Task ListBlobsFlatListing(BlobContainerClient blobContainerClient, 
                                               int? segmentSize)
{
    try
    {
        // Call the listing operation and return pages of the specified size.
        var resultSegment = blobContainerClient.GetBlobsAsync()
            .AsPages(default, segmentSize);

        // Enumerate the blobs returned for each page.
        await foreach (Page<BlobItem> blobPage in resultSegment)
        {
            foreach (BlobItem blobItem in blobPage.Values)
            {
                Console.WriteLine("Blob name: {0}", blobItem.Name);
            }

            Console.WriteLine();
        }
    }
    catch (RequestFailedException e)
    {
        Console.WriteLine(e.Message);
        Console.ReadLine();
        throw;
    }
}

O resultado do exemplo é semelhante a:

Blob name: FolderA/blob1.txt
Blob name: FolderA/blob2.txt
Blob name: FolderA/blob3.txt
Blob name: FolderA/FolderB/blob1.txt
Blob name: FolderA/FolderB/blob2.txt
Blob name: FolderA/FolderB/blob3.txt
Blob name: FolderA/FolderB/FolderC/blob1.txt
Blob name: FolderA/FolderB/FolderC/blob2.txt
Blob name: FolderA/FolderB/FolderC/blob3.txt

Nota

O resultado de exemplo mostrado pressupõe que tem uma conta de armazenamento com um espaço de nomes simples. Se tiver ativado a funcionalidade de espaço de nomes hierárquico para a sua conta de armazenamento, os diretórios não são virtuais. Em vez disso, são objetos concretos e independentes. Como resultado, os diretórios aparecem na lista como blobs de comprimento zero.

Para obter uma opção de listagem alternativa ao trabalhar com um espaço de nomes hierárquico, consulte Listar conteúdos de diretórios (Azure Data Lake Storage Gen2).

Utilizar uma listagem hierárquica

Quando chama uma operação de listagem hierárquica, o Armazenamento do Azure devolve os diretórios virtuais e os blobs no primeiro nível da hierarquia.

Para listar blobs hierárquica, chame o método BlobContainerClient.GetBlobsByHierarchy ou BlobContainerClient.GetBlobsByHierarchyAsync .

O exemplo seguinte lista os blobs no contentor especificado através de uma listagem hierárquica, com um tamanho de segmento opcional especificado e escreve o nome do blob na janela da consola.

private static async Task ListBlobsHierarchicalListing(BlobContainerClient container, 
                                                       string prefix, 
                                                       int? segmentSize)
{
    try
    {
        // Call the listing operation and return pages of the specified size.
        var resultSegment = container.GetBlobsByHierarchyAsync(prefix:prefix, delimiter:"/")
            .AsPages(default, segmentSize);

        // Enumerate the blobs returned for each page.
        await foreach (Page<BlobHierarchyItem> blobPage in resultSegment)
        {
            // A hierarchical listing may return both virtual directories and blobs.
            foreach (BlobHierarchyItem blobhierarchyItem in blobPage.Values)
            {
                if (blobhierarchyItem.IsPrefix)
                {
                    // Write out the prefix of the virtual directory.
                    Console.WriteLine("Virtual directory prefix: {0}", blobhierarchyItem.Prefix);

                    // Call recursively with the prefix to traverse the virtual directory.
                    await ListBlobsHierarchicalListing(container, blobhierarchyItem.Prefix, null);
                }
                else
                {
                    // Write out the name of the blob.
                    Console.WriteLine("Blob name: {0}", blobhierarchyItem.Blob.Name);
                }
            }

            Console.WriteLine();
        }
    }
    catch (RequestFailedException e)
    {
        Console.WriteLine(e.Message);
        Console.ReadLine();
        throw;
    }
}

O resultado do exemplo é semelhante a:

Virtual directory prefix: FolderA/
Blob name: FolderA/blob1.txt
Blob name: FolderA/blob2.txt
Blob name: FolderA/blob3.txt

Virtual directory prefix: FolderA/FolderB/
Blob name: FolderA/FolderB/blob1.txt
Blob name: FolderA/FolderB/blob2.txt
Blob name: FolderA/FolderB/blob3.txt

Virtual directory prefix: FolderA/FolderB/FolderC/
Blob name: FolderA/FolderB/FolderC/blob1.txt
Blob name: FolderA/FolderB/FolderC/blob2.txt
Blob name: FolderA/FolderB/FolderC/blob3.txt

Nota

Não é possível listar instantâneos de blobs numa operação de listagem hierárquica.

Listar versões ou instantâneos de blobs

Para listar versões ou instantâneos de blobs, especifique o parâmetro BlobStates com o campo Versão ou Instantâneo . As versões e os instantâneos são listados do mais antigo para o mais recente.

O seguinte exemplo de código mostra como listar versões de blobs.

private static void ListBlobVersions(BlobContainerClient blobContainerClient, 
                                           string blobName)
{
    try
    {
        // Call the listing operation, specifying that blob versions are returned.
        // Use the blob name as the prefix. 
        var blobVersions = blobContainerClient.GetBlobs
            (BlobTraits.None, BlobStates.Version, prefix: blobName)
            .OrderByDescending(version => version.VersionId).Where(blob => blob.Name == blobName);

        // Construct the URI for each blob version.
        foreach (var version in blobVersions)
        {
            BlobUriBuilder blobUriBuilder = new BlobUriBuilder(blobContainerClient.Uri)
            {
                BlobName = version.Name,
                VersionId = version.VersionId
            };

            if ((bool)version.IsLatestVersion.GetValueOrDefault())
            {
                Console.WriteLine("Current version: {0}", blobUriBuilder);
            }
            else
            {
                Console.WriteLine("Previous version: {0}", blobUriBuilder);
            }
        }
    }
    catch (RequestFailedException e)
    {
        Console.WriteLine(e.Message);
        Console.ReadLine();
        throw;
    }
}

Recursos

Para saber mais sobre como listar blobs com a biblioteca de cliente Armazenamento de Blobs do Azure para .NET, veja os seguintes recursos.

Operações da API REST

O SDK do Azure para .NET contém bibliotecas que se baseiam na API REST do Azure, o que lhe permite interagir com operações da API REST através de paradigmas de .NET familiares. Os métodos da biblioteca de cliente para listar blobs utilizam a seguinte operação da API REST:

Recursos da biblioteca de cliente

Ver também