Listar contêineres de blob com JavaScript ou TypeScript

• .NET
• Java
• JavaScript
• Python
• Go

Ao listar contêineres em uma conta de Armazenamento do Microsoft Azure do seu código, você pode especificar várias opções para gerenciar o modo como os resultados são retornados do Armazenamento do Microsoft Azure. Esse artigo mostra como listar contêineres usando a biblioteca de clientes do Armazenamento do Microsoft Azure para JavaScript.

Pré-requisitos

• Os exemplos neste artigo pressupõem que você já tenha um projeto configurado para trabalhar com a biblioteca de clientes do Armazenamento de Blobs do Azure para JavaScript. Para saber mais sobre a configuração do seu projeto, incluindo a instalação de pacotes, a importação de módulos e a criação de um objeto cliente autorizado para trabalhar com recursos de dados, confira Introdução ao Armazenamento de Blobs do Azure e o JavaScript.
• O mecanismo de autorização deve ter permissões para listar contêineres de blob. Para saber mais, consulte as diretrizes de autorização para as seguintes operações de API REST:
  • Listar contêineres

Sobre as opções de listagem de contêineres

Ao listar contêineres do código, você pode especificar opções para gerenciar como os resultados são retornados do Armazenamento do Azure. Você pode especificar o número de resultados a serem retornados em cada conjunto de resultados e, em seguida, recuperar os conjuntos subsequentes. Você também pode filtrar os resultados por um prefixo e retornar metadados de contêiner com os resultados. Essas opções são descritas nas seções a seguir.

Para listar os contêineres em sua conta de armazenamento, use o seguinte método:

• BlobServiceClient.listContainers

Esse método retorna uma lista de objetos ContainerItem. Os contêineres são ordenados lexicograficamente pelo nome.

Gerenciar quantos resultados são retornados

Por padrão, uma operação de listagem retorna até 5.000 resultados por vez, mas você pode especificar o número de resultados que deseja que cada operação de listagem retorne. Os exemplos apresentados neste artigo mostram como retornar resultados em páginas.

Filtrar resultados com um prefixo

Para filtrar a lista de contêineres, especifique uma cadeia de caracteres para o prefix parâmetro em ServiceListContainersOptions. A cadeia de caracteres de prefixo pode incluir um ou mais caracteres. O Armazenamento do Azure então retorna somente os contêineres cujos nomes começam com esse prefixo.

Incluir metadados de contêiner

Para incluir metadados de contêiner com os resultados, defina o parâmetro includeMetadata como true em ServiceListContainersOptions. O armazenamento do Azure inclui metadados com cada contêiner retornado, portanto, você não precisa buscar os metadados do contêiner separadamente.

Incluir contêineres excluídos

Para incluir contêineres com exclusão reversível com os resultados, defina o parâmetro includeDeleted em ServiceListContainersOptions.

Exemplo: listar contêineres

O exemplo a seguir lista de forma assíncrona os contêineres em uma conta de armazenamento que começam com um prefixo especificado. O exemplo lista os contêineres que começam com o prefixo especificado e retorna o número especificado de resultados por uso para a operação de listagem. Em seguida, ele usa o token de continuação para obter o próximo segmento de resultados. O exemplo também retorna metadados de contêiner com os resultados.

JavaScript

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}`);
      }
    }
  }
}

TypeScript

// 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}`);
      }
    }
  }
}

Recursos

Para saber mais sobre como listar contêineres usando a biblioteca de clientes do Armazenamento de Blobs do Azure para JavaScript, consulte os recursos a seguir.

Operações da API REST

O SDK do Azure para JavaScript contém bibliotecas que se baseiam na API REST do Azure, permitindo a interação com as operações de API REST por meio de paradigmas conhecidos do JavaScript. Os métodos da biblioteca de clientes para listar contêineres usam a seguinte operação de API REST:

• Listar contêineres (API REST)

Exemplos de código

• Veja os códigos de exemplo JavaScript e TypeScript desse artigo (GitHub)

Recursos da biblioteca de clientes

• Documentação de referência da biblioteca de clientes
• Código-fonte da biblioteca de clientes
• Pacote (npm)

Confira também

• Enumerar recursos de blob

Recursos da biblioteca de clientes

• Documentação de referência da biblioteca de clientes
• Código-fonte da biblioteca de clientes
• Pacote (npm)