Enumeración de contenedores de blobs con JavaScript o TypeScript

• .NET
• Java
• JavaScript
• Python
• Go

Al enumerar los contenedores de una cuenta de Azure Storage desde el código, puede especificar varias opciones para administrar cómo se devuelven los resultados de Azure Storage. En este artículo se muestra cómo enumerar contenedores con la biblioteca cliente de Azure Storage para JavaScript.

Requisitos previos

• Los ejemplos de este artículo asumen que ya tiene un proyecto configurado para trabajar con la librería cliente Azure Blob Storage para JavaScript. Para obtener más información sobre la configuración del proyecto, incluida la instalación de paquetes, la importación de módulos y la creación de un objeto cliente autorizado para trabajar con recursos de datos, consulte Introducción a Azure Blob Storage y JavaScript.
• El mecanismo de autorización debe tener permisos para enumerar contenedores de blobs. Para obtener más información, consulte la guía de autorización para la siguiente operación de la API de REST:
  • Enumerador de contenedores

Acerca de las opciones de listado de contenedores

Al enumerar blobs desde el código, puede especificar opciones para administrar cómo se devuelven los resultados de Azure Storage. Puede especificar el número de resultados que se van a devolver en cada conjunto de resultados y luego recuperar los conjuntos subsiguientes. También puede filtrar los resultados por un prefijo y devolver metadatos de contenedor con los resultados. Estas opciones se describen en las secciones siguientes.

Para enumerar los contenedores de la cuenta de almacenamiento, llame al método siguiente:

• BlobServiceClient.listContainers

Este método devuelve una lista de objetos ContainerItem. Los contenedores se ordenan lexicográficamente por nombre.

Administración del número de resultados que se devuelven

De forma predeterminada, una operación de enumeración devuelve hasta 5000 resultados a la vez, pero puede especificar el número de resultados que quiere que devuelva. En los ejemplos que se presentan en este artículo muestran cómo devolver resultados por páginas.

Filtrado de los resultados con un prefijo

Para filtrar la lista de contenedores, especifique una cadena para el parámetro prefix en ServiceListContainersOptions. La cadena de prefijo puede incluir uno o varios caracteres. Después, Azure Storage solo devuelve los contenedores cuyos nombres empiecen por ese prefijo.

Incluir metadatos de contenedor

Para incluir metadatos de contenedor con los resultados, establezca el parámetro en includeMetadata para true en ServiceListContainersOptions. Azure Storage incluye metadatos con cada contenedor devuelto, por lo que no es necesario capturar también los metadatos del contenedor.

Incluir contenedores eliminados

Para incluir contenedores eliminados temporalmente con los resultados, establezca el parámetro includeDeleted en ServiceListContainersOptions.

Ejemplo de código: Enumerar contenedores

En el ejemplo siguiente se enumeran de forma asincrónica los contenedores de una cuenta de almacenamiento que comienzan con un prefijo especificado. En el ejemplo se muestran los contenedores que comienzan con el prefijo especificado y se devuelve el número especificado de resultados por llamada a la operación de enumeración. A continuación, usa el token de continuación para obtener el segmento de resultados siguiente. En el ejemplo también se devuelven metadatos de contenedor con los 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 más información sobre cómo crear listas de contenedores con la biblioteca cliente de Azure Blob Storage para JavaScript, consulte los recursos siguientes.

Operaciones de API REST

El SDK de Azure para JavaScript contiene bibliotecas que se crean a partir de la API REST de Azure, lo que le permite interactuar con las operaciones de API REST a través de paradigmas conocidos de JavaScript. Los métodos de la biblioteca cliente para crear listas de contenedores usan esta operación de API de REST:

• List Containers (API REST)

Ejemplos de código

• Ver JavaScript y ejemplos de código de TypeScript de este artículo (GitHub)

Recursos de la biblioteca cliente

• Documentación de referencia de la biblioteca cliente
• Código fuente de la biblioteca del cliente
• Paquete (npm)

Consulte también

• Enumeración de recursos de blob

Recursos de la biblioteca cliente

• Documentación de referencia de la biblioteca cliente
• Código fuente de la biblioteca del cliente
• Paquete (npm)