Wyświetlanie listy kontenerów obiektów blob za pomocą języka JavaScript lub TypeScript
Po wyświetleniu listy kontenerów na koncie usługi Azure Storage z poziomu kodu można określić kilka opcji zarządzania sposobem zwracania wyników z usługi Azure Storage. W tym artykule przedstawiono sposób wyświetlania listy kontenerów przy użyciu biblioteki klienta usługi Azure Storage dla języka JavaScript.
Wymagania wstępne
- W przykładach w tym artykule założono, że masz już skonfigurowany projekt do pracy z biblioteką klienta usługi Azure Blob Storage dla języka JavaScript. Aby dowiedzieć się więcej o konfigurowaniu projektu, w tym instalacji pakietu, importowaniu modułów i tworzeniu autoryzowanego obiektu klienta do pracy z zasobami danych, zobacz Rozpoczynanie pracy z usługami Azure Blob Storage i JavaScript.
- Mechanizm autoryzacji musi mieć uprawnienia do wyświetlania listy kontenerów obiektów blob. Aby dowiedzieć się więcej, zobacz wskazówki dotyczące autoryzacji dla następującej operacji interfejsu API REST:
Informacje o opcjach listy kontenerów
Podczas wyświetlania listy kontenerów z kodu można określić opcje zarządzania sposobem zwracania wyników z usługi Azure Storage. Możesz określić liczbę wyników, które mają być zwracane w każdym zestawie wyników, a następnie pobrać kolejne zestawy. Wyniki można również filtrować według prefiksu i zwracać metadane kontenera za pomocą wyników. Te opcje opisano w poniższych sekcjach.
Aby wyświetlić listę kontenerów na koncie magazynu, wywołaj następującą metodę:
Ta metoda zwraca listę obiektów ContainerItem . Kontenery są uporządkowane leksykograficznie według nazwy.
Zarządzanie liczbą zwracanych wyników
Domyślnie operacja wyświetlania listy zwraca maksymalnie 5000 wyników jednocześnie, ale można określić liczbę wyników, które mają zostać zwrócone przez każdą operację listy. W przykładach przedstawionych w tym artykule pokazano, jak zwracać wyniki na stronach.
Filtrowanie wyników za pomocą prefiksu
Aby filtrować listę kontenerów, określ ciąg parametru prefix w polach ServiceListContainersOptions. Ciąg prefiksu może zawierać co najmniej jeden znak. Usługa Azure Storage zwraca następnie tylko kontenery, których nazwy zaczynają się od tego prefiksu.
Dołączanie metadanych kontenera
Aby uwzględnić metadane kontenera z wynikami, ustaw includeMetadata parametr na wartość w poleceniu true ServiceListContainersOptions. Usługa Azure Storage zawiera metadane z każdym zwróconym kontenerem, więc nie trzeba pobierać metadanych kontenera oddzielnie.
Dołączanie usuniętych kontenerów
Aby uwzględnić kontenery usunięte nietrwale z wynikami, ustaw parametr w poleceniu includeDeleted ServiceListContainersOptions.
Przykład kodu: Wyświetlanie listy kontenerów
W poniższym przykładzie asynchronicznie wymieniono kontenery na koncie magazynu, które zaczynają się od określonego prefiksu. W przykładzie wymieniono kontenery rozpoczynające się od określonego prefiksu i zwraca określoną liczbę wyników na wywołanie operacji wyświetlania listy. Następnie używa tokenu kontynuacji, aby uzyskać następny segment wyników. Przykład zwraca również metadane kontenera z wynikami.
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}`);
}
}
}
}
Zasoby
Aby dowiedzieć się więcej na temat wyświetlania listy kontenerów przy użyciu biblioteki klienta usługi Azure Blob Storage dla języka JavaScript, zobacz następujące zasoby.
Operacje interfejsu API REST
Zestaw Azure SDK dla języka JavaScript zawiera biblioteki, które bazują na interfejsie API REST platformy Azure, co umożliwia interakcję z operacjami interfejsu API REST za pomocą znanych paradygmatów języka JavaScript. Metody biblioteki klienta do wyświetlania listy kontenerów używają następującej operacji interfejsu API REST:
- Wyświetlanie listy kontenerów (interfejs API REST)
Przykłady kodu
- Wyświetl przykłady kodu JavaScript i TypeScript z tego artykułu (GitHub)