Listar contêineres de blob com JavaScript ou TypeScript
Ao listar os contêineres em uma conta de Armazenamento do Azure a partir do seu código, você pode especificar várias opções para gerenciar como os resultados são retornados do Armazenamento do Azure. Este artigo mostra como listar contêineres usando a biblioteca de cliente do Armazenamento do Azure para JavaScript.
Pré-requisitos
- Os exemplos neste artigo pressupõem que você já tenha um projeto configurado para trabalhar com a biblioteca de cliente do Armazenamento de Blobs do Azure para JavaScript. Para saber mais sobre como configurar seu projeto, incluindo instalação de pacotes, importação de módulos e criação de um objeto de cliente autorizado para trabalhar com recursos de dados, consulte Introdução ao Armazenamento de Blobs do Azure e 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 a seguinte operação da API REST:
Sobre as opções de listagem de contêineres
Ao listar contêineres do seu 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 contêineres em sua conta de armazenamento, chame o seguinte método:
Esse método retorna uma lista de objetos ContainerItem . Os contentores são ordenados lexicograficamente pelo nome.
Gerenciar quantos resultados são retornados
Por padrão, uma operação de listagem retorna até 5000 resultados de cada 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. Em seguida, o Armazenamento do Azure retorna apenas 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 includeMetadata parâmetro como true 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 excluídos suavemente com os resultados, defina o includeDeleted parâmetro em ServiceListContainersOptions.
Exemplo de código: 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 contêineres que começam com o prefixo especificado e retorna o número especificado de resultados por chamada 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.
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}`);
}
}
}
}
Recursos
Para saber mais sobre como listar contêineres usando a biblioteca de cliente 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 que você interaja com operações da API REST por meio de paradigmas JavaScript familiares. Os métodos de biblioteca de cliente para listar contêineres usam a seguinte operação de API REST:
- Listar contêineres (API REST)
Amostras de código
- Veja exemplos de código JavaScript e TypeScript deste artigo (GitHub)