Lista blobcontainrar med JavaScript eller TypeScript

När du listar containrarna i ett Azure Storage-konto från koden kan du ange flera alternativ för att hantera hur resultatet returneras från Azure Storage. Den här artikeln visar hur du listar containrar med hjälp av Azure Storage-klientbiblioteket för JavaScript.

Förutsättningar

• Exemplen i den här artikeln förutsätter att du redan har ett projekt konfigurerat för att fungera med Azure Blob Storage-klientbiblioteket för JavaScript. Mer information om hur du konfigurerar projektet, inklusive paketinstallation, import av moduler och skapande av ett auktoriserat klientobjekt för att arbeta med dataresurser finns i Kom igång med Azure Blob Storage och JavaScript.
• Auktoriseringsmekanismen måste ha behörighet att lista blobcontainrar. Mer information finns i auktoriseringsvägledningen för följande REST API-åtgärd:
  • Listcontainrar

Om alternativ för containerlistning

När du listar containrar från koden kan du ange alternativ för att hantera hur resultatet returneras från Azure Storage. Du kan ange hur många resultat som ska returneras i varje resultatuppsättning och sedan hämta efterföljande uppsättningar. Du kan också filtrera resultatet efter ett prefix och returnera containermetadata med resultatet. De här alternativen beskrivs i följande avsnitt.

Om du vill visa containrar i ditt lagringskonto anropar du följande metod:

• BlobServiceClient.listContainers

Den här metoden returnerar en lista över ContainerItem-objekt . Containrar beställs lexicographically efter namn.

Hantera hur många resultat som returneras

Som standard returnerar en liståtgärd upp till 5 000 resultat åt gången, men du kan ange antalet resultat som du vill att varje listningsåtgärd ska returnera. Exemplen som presenteras i den här artikeln visar hur du returnerar resultat på sidor.

Filtrera resultat med ett prefix

Om du vill filtrera listan över containrar anger du en sträng för parametern prefix i ServiceListContainersOptions. Prefixsträngen kan innehålla ett eller flera tecken. Azure Storage returnerar sedan endast de containrar vars namn börjar med prefixet.

Inkludera containermetadata

Om du vill inkludera containermetadata med resultatet anger du parametern includeMetadata till true i ServiceListContainersOptions. Azure Storage innehåller metadata för varje container som returneras, så du behöver inte hämta containermetadata separat.

Inkludera borttagna containrar

Om du vill inkludera mjukt borttagna containrar med resultatet anger du parametern includeDeleted i ServiceListContainersOptions.

Kodexempel: Lista containrar

I följande exempel visas asynkront containrarna i ett lagringskonto som börjar med ett angivet prefix. I exemplet visas containrar som börjar med det angivna prefixet och returnerar det angivna antalet resultat per anrop till liståtgärden. Den använder sedan fortsättningstoken för att hämta nästa resultatsegment. Exemplet returnerar även containermetadata med resultatet.

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

Resurser

Mer information om hur du listar containrar med hjälp av Azure Blob Storage-klientbiblioteket för JavaScript finns i följande resurser.

REST API-åtgärder

Azure SDK för JavaScript innehåller bibliotek som bygger på Azure REST API, så att du kan interagera med REST API-åtgärder via välbekanta JavaScript-paradigm. Klientbiblioteksmetoderna för att visa containrar använder följande REST API-åtgärd:

• Listcontainrar (REST API)

Kodexempel

• Visa JavaScript - och TypeScript-kodexempel från den här artikeln (GitHub)

Klientbiblioteksresurser

• Referensdokumentation för klientbibliotek
• Källkod för klientbibliotek
• Paket (npm)

Se även

• Räkna upp blobresurser

Klientbiblioteksresurser

• Referensdokumentation för klientbibliotek
• Källkod för klientbibliotek
• Paket (npm)