Elencare i contenitori BLOB con JavaScript o TypeScript

Quando si elencano i contenitori BLOB in un account di Archiviazione di Azure tramite il codice, è possibile specificare diverse opzioni per gestire il modo in cui i risultati vengono restituiti da Archiviazione di Azure. Questo articolo illustra come elencare i contenitori usando la libreria client di Archiviazione di Azure per JavaScript.

Prerequisiti

• Gli esempi in questo articolo presuppongono che sia già stato configurato un progetto per l'uso con la libreria client di Archiviazione BLOB di Azure per JavaScript. Per informazioni sulla configurazione del progetto, incluse l'installazione del pacchetto, l'importazione di moduli e la creazione di un oggetto client autorizzato per l'uso con le risorse dati, consultare Introduzione ad Archiviazione BLOB di Azure e JavaScript.
• Il meccanismo di autorizzazione deve disporre delle autorizzazioni per elencare i contenitori BLOB. Per altre informazioni, vedere le linee guida per l'autorizzazione per l'operazione API REST seguente:
  • List Containers

Informazioni sulle opzioni di elenco dei contenitori

Quando si elencano i contenitori tramite il codice, è possibile specificare diverse opzioni per gestire il modo in cui i risultati vengono restituiti da Archiviazione di Azure. È possibile specificare il numero di risultati da restituire in ogni set di risultati e quindi recuperare i set successivi. È anche possibile filtrare i risultati in base a un prefisso e restituire i metadati del contenitore insieme ai risultati. Le opzioni disponibili sono descritte nelle sezioni seguenti.

Per elencare i contenitori nell'account di archiviazione, chiamare il metodo seguente:

• BlobServiceClient.listContainers

Questo metodo restituisce un elenco di oggetti ContainerItem . I contenitori vengono elencati in ordine lessicografico in base al nome.

Gestire il numero di risultati restituiti

Per impostazione predefinita, un'operazione di elenco restituisce fino a 5000 risultati alla volta, ma è possibile specificare il numero di risultati che ogni operazione deve restituire. Gli esempi presentati in questo articolo illustrano come restituire i risultati nelle pagine.

Filtrare i risultati con un prefisso

Per filtrare l'elenco dei contenitori, specificare una stringa per il prefix parametro in ServiceListContainersOptions. La stringa di prefisso può includere uno o più caratteri. Archiviazione di Azure restituisce solo i contenitori i cui nomi iniziano con tale prefisso.

Includere i metadati del contenitore

Per includere i metadati del contenitore con i risultati, impostare il includeMetadata parametro su true in ServiceListContainersOptions. Archiviazione di Azure include i metadati con ogni contenitore restituito, dunque non è necessario recuperare i metadati del contenitore separatamente.

Includere i contenitori eliminati

Per includere i contenitori eliminati soft-delete con i risultati, impostare il includeDeleted parametro in ServiceListContainersOptions.

Esempio di codice: elencare i contenitori

L'esempio seguente elenca in modo asincrono i contenitori in un account di archiviazione che iniziano con un prefisso specificato. L'esempio elenca i contenitori che iniziano con il prefisso specificato e restituisce il numero specificato di risultati per ogni chiamata all'operazione di elenco. Usa poi il token di continuazione per recuperare il segmento successivo di risultati. L'esempio restituisce anche i metadati del contenitore con i risultati.

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

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

Risorse

Per altre informazioni su come elencare i contenitori tramite la libreria client di Archiviazione BLOB di Azure per JavaScript, vedere le risorse seguenti.

Operazioni dell'API REST

Azure SDK per JavaScript contiene librerie basate sull'API REST di Azure che consentono di interagire con le operazioni dell'API REST tramite paradigmi noti di JavaScript. I metodi della libreria client per elencare i contenitori usano l'operazione API REST seguente:

• List Containers (API REST)

Esempi di codice

• Visualizzare esempi di codice JavaScript e TypeScript di questo articolo (GitHub)

Risorse della libreria client

• Documentazione di riferimento della libreria client
• Codice sorgente della libreria client
• Pacchetto (npm)

Vedi anche

• Enumerazione di risorse Blob

Risorse della libreria client

• Documentazione di riferimento della libreria client
• Codice sorgente della libreria client
• Pacchetto (npm)