Správa vlastností kontejneru a metadat pomocí JavaScriptu nebo TypeScriptu

Článek
10/31/2024

Kontejnery objektů blob podporují systémové vlastnosti a uživatelsky definovaná metadata kromě dat, která obsahují. Tento článek ukazuje, jak spravovat vlastnosti systému a uživatelsky definovaná metadata pomocí klientské knihovny služby 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í pro práci s vlastnostmi kontejneru nebo metadaty. Další informace najdete v pokynech k autorizaci pro následující operace rozhraní REST API:

O vlastnostech a metadatech

Systémové vlastnosti: Systémové vlastnosti existují pro každý prostředek úložiště objektů blob. Některé z nich můžou být přečtené nebo nastavené, zatímco jiné jsou jen pro čtení. Pod popisky některé systémové vlastnosti odpovídají určitým standardním hlavičkám HTTP. Klientská knihovna Azure Storage pro JavaScript tyto vlastnosti udržuje za vás.
Uživatelsky definovaná metadata: Uživatelsky definovaná metadata se skládají z jednoho nebo více párů název-hodnota, které zadáte pro prostředek úložiště objektů blob. Metadata můžete použít k uložení dalších hodnot s prostředkem. Hodnoty metadat jsou určené jenom pro vaše vlastní účely a nemají vliv na chování prostředku.

Páry názvů a hodnot metadat jsou platné hlavičky HTTP a měly by dodržovat všechna omezení, která se řídí hlavičkami HTTP. Další informace opožadavch

Načtení vlastností kontejneru

K načtení vlastností kontejneru použijte následující metodu:

ContainerClient.getProperties

Následující příklad kódu načte vlastnosti kontejneru a zapíše některé hodnoty vlastností do okna konzoly:

JavaScript
TypeScript

async function getContainerProperties(containerClient) {
  
  try {
    const containerProperties = await containerClient.getProperties();

    console.log(`Public access type: ${containerProperties.blobPublicAccess}`);
    console.log(`Lease status: ${containerProperties.leaseStatus}`);
    console.log(`Lease state: ${containerProperties.leaseState}`);
    console.log(`Has immutability policy: ${containerProperties.hasImmutabilityPolicy}`);
  } catch (err) {
    // Handle the error
  }
}

async function getContainerProperties(
  containerClient: ContainerClient
): Promise<void> {

  try {
    const containerProperties: ContainerGetPropertiesResponse =
      await containerClient.getProperties();

      console.log(`Public access type: ${containerProperties.blobPublicAccess}`);
      console.log(`Lease status: ${containerProperties.leaseStatus}`);
      console.log(`Lease state: ${containerProperties.leaseState}`);
      console.log(`Has immutability policy: ${containerProperties.hasImmutabilityPolicy}`);
  } catch (err) {
    // Handle the error
  }
}

Nastavení a načtení metadat

Metadata můžete zadat jako jeden nebo více dvojic název-hodnota kontejneru. Pokud chcete nastavit metadata, vytvořte objekt ContainerClient a pak použijte následující metodu:

ContainerClient.setMetadata

Následující příklad kódu nastaví metadata v kontejneru:

JavaScript
TypeScript

async function setContainerMetadata(containerClient) {
  
  const metadata = {
    docType: "textDocuments",
    docCategory: "testing",
  };
  
  await containerClient.setMetadata(metadata);

}

async function setContainerMetadata(
  containerClient: ContainerClient,
) {
  
  try {
    const metadata: Metadata = {
      // values must be strings
      docType: "textDocuments",
      docCategory: "testing"
    };
    await containerClient.setMetadata(metadata);
  }
  catch (err) {
    // Handle the error
  }
}

Pokud chcete načíst metadata, získejte vlastnosti kontejneru a pak použijte vrácenou vlastnost metadat .

Zdroje informací

Další informace o nastavení a načítání vlastností kontejneru a metadat pomocí klientské knihovny služby Azure Blob Storage pro JavaScript najdete v následujících zdrojích informací.

Ukázky kódu

Zobrazení ukázek kódu JavaScriptu a TypeScriptu z tohoto článku (GitHub)

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 nastavení a načítání vlastností a metadat používají následující operace rozhraní REST API:

Získání vlastností kontejneru (REST API)
Nastavení metadat kontejneru (REST API)
Získání metadat kontejneru (REST API)

Metoda getProperties načte vlastnosti kontejneru a metadata voláním operace Get Blob Properties a Get Blob Metadata operace.

Sdílet prostřednictvím