Hantera containeregenskaper och metadata med JavaScript eller TypeScript

Artikel
10/31/2024

Blobcontainrar stöder systemegenskaper och användardefinierade metadata, utöver de data som de innehåller. Den här artikeln visar hur du hanterar systemegenskaper och användardefinierade metadata med 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 arbeta med containeregenskaper eller metadata. Mer information finns i auktoriseringsvägledningen för följande REST API-åtgärder:

Om egenskaper och metadata

Systemegenskaper: Systemegenskaper finns på varje Blob Storage-resurs. Vissa av dem kan läsas eller ställas in, medan andra är skrivskyddade. Under täcket motsvarar vissa systemegenskaper vissa standard-HTTP-huvuden. Azure Storage-klientbiblioteket för JavaScript underhåller dessa egenskaper åt dig.
Användardefinierade metadata: Användardefinierade metadata består av ett eller flera namn/värde-par som du anger för en Blob Storage-resurs. Du kan använda metadata för att lagra ytterligare värden med resursen. Metadatavärden är endast för dina egna syften och påverkar inte hur resursen beter sig.

Metadatanamn/värdepar är giltiga HTTP-huvuden och bör följa alla begränsningar som styr HTTP-huvuden. Mer information om namngivningskrav för metadata finns i Metadatanamn.

Hämta containeregenskaper

Använd följande metod för att hämta containeregenskaper:

ContainerClient.getProperties

I följande kodexempel hämtas en containers egenskaper och vissa egenskapsvärden skrivs till ett konsolfönster:

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
  }
}

Ange och hämta metadata

Du kan ange metadata som en eller flera namn/värde-par containerresurs. Om du vill ange metadata skapar du ett ContainerClient-objekt och använder sedan följande metod:

ContainerClient.setMetadata

I följande kodexempel anges metadata på en container:

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
  }
}

Hämta metadata genom att hämta containeregenskaperna och sedan använda den returnerade metadataegenskapen .

Resurser

Mer information om hur du ställer in och hämtar containeregenskaper och metadata med hjälp av Azure Blob Storage-klientbiblioteket för JavaScript finns i följande resurser.

Kodexempel

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

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 ange och hämta egenskaper och metadata använder följande REST API-åtgärder:

Metoden getProperties hämtar containeregenskaper och metadata genom att anropa både åtgärden Hämta blobegenskaper och åtgärden Hämta blobmetadata .

Dela via