Výpis kontejnerů objektů blob pomocí JavaScriptu nebo TypeScriptu
Když vypíšete kontejnery v účtu Azure Storage z kódu, můžete zadat několik možností pro správu způsobu vrácení výsledků ze služby Azure Storage. Tento článek ukazuje, jak vypsat kontejnery pomocí klientské knihovny Azure Storage pro JavaScript.
Požadavky
- Příklady v tomto článku předpokládají, že už máte projekt nastavený tak, aby fungoval s klientskou knihovnou Azure Blob Storage pro JavaScript. Další informace o nastavení projektu, včetně instalace balíčku, importu modulů a vytvoření autorizovaného klientského objektu pro práci s datovými prostředky, najdete v tématu Začínáme se službou Azure Blob Storage a JavaScriptem.
- Autorizační mechanismus musí mít oprávnění k výpisu kontejnerů objektů blob. Další informace najdete v pokynech k autorizaci pro následující operaci rozhraní REST API:
O možnostech výpisu kontejnerů
Při výpisu kontejnerů z kódu můžete zadat možnosti pro správu způsobu vrácení výsledků ze služby Azure Storage. Můžete zadat počet výsledků, které se mají vrátit v každé sadě výsledků, a pak načíst následující sady. Výsledky můžete také filtrovat podle předpony a vrátit metadata kontejneru s výsledky. Tyto možnosti jsou popsány v následujících částech.
Pokud chcete vypsat kontejnery v účtu úložiště, zavolejte následující metodu:
Tato metoda vrátí seznam objektů ContainerItem . Kontejnery jsou seřazené lexicicky podle názvu.
Správa počtu vrácených výsledků
Ve výchozím nastavení vrátí operace výpisu najednou až 5 000 výsledků, ale můžete zadat počet výsledků, které má každá operace výpisu vrátit. Příklady uvedené v tomto článku ukazují, jak vrátit výsledky na stránkách.
Filtrování výsledků pomocí předpony
Chcete-li filtrovat seznam kontejnerů, zadejte řetězec pro prefix parametr v ServiceListContainersOptions. Řetězec předpony může obsahovat jeden nebo více znaků. Azure Storage pak vrátí pouze kontejnery, jejichž názvy začínají danou předponou.
Zahrnout metadata kontejneru
Pokud chcete do výsledků zahrnout metadata kontejneru, nastavte parametr na true ServiceListContainersOptions.includeMetadata Azure Storage obsahuje metadata s každým vráceným kontejnerem, takže metadata kontejneru nemusíte načítat samostatně.
Zahrnutí odstraněných kontejnerů
Pokud chcete zahrnout obnovitelné odstraněné kontejnery s výsledky, nastavte includeDeleted parametr v ServiceListContainersOptions.
Příklad kódu: Výpis kontejnerů
Následující příklad asynchronně vypíše kontejnery v účtu úložiště, které začínají zadanou předponou. V příkladu jsou uvedeny kontejnery, které začínají zadanou předponou a vrátí zadaný počet výsledků na volání operace výpisu. Potom pomocí tokenu pokračování získá další segment výsledků. Příklad také vrátí metadata kontejneru s výsledky.
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}`);
}
}
}
}
Zdroje informací
Další informace o výpisu kontejnerů pomocí klientské knihovny Azure Blob Storage pro JavaScript najdete v následujících zdrojích informací.
Operace rozhraní REST API
Sada Azure SDK pro JavaScript obsahuje knihovny, které jsou postavené na rozhraní Azure REST API a umožňují interakci s operacemi rozhraní REST API prostřednictvím známých paradigmat JavaScriptu. Metody klientské knihovny pro výpis kontejnerů používají následující operaci rozhraní REST API:
- Výpis kontejnerů (REST API)
Ukázky kódu
- Zobrazení ukázek kódu JavaScriptu a TypeScriptu z tohoto článku (GitHub)