Gestire proprietà e metadati del contenitore con JavaScript o TypeScript

Articolo
10/31/2024

Oltre ai dati che contengono, i contenitori BLOB supportano le proprietà di sistema e i metadati definiti dall'utente. Questo articolo illustra come gestire le proprietà di sistema e i metadati definiti dall'utente con la libreria client di Archiviazione di Azure per JavaScript.

Prerequisiti

Gli esempi in questo articolo presuppongono che sia già stato configurato un progetto per l'uso con la libreria client di Archiviazione BLOB di Azure per JavaScript. Per informazioni sulla configurazione del progetto, incluse l'installazione del pacchetto, l'importazione di moduli e la creazione di un oggetto client autorizzato per l'uso con le risorse dati, consultare Introduzione ad Archivio BLOB di Azure e JavaScript.
Il meccanismo di autorizzazione deve disporre delle autorizzazioni per utilizzare proprietà o metadati dei contenitori. Per ulteriori informazioni, consultare le linee guida per l'autorizzazione delle le seguenti operazioni API REST:

Informazioni su proprietà e metadati

Proprietà di sistema: le proprietà di sistema esistono in ogni risorsa di archiviazione BLOB. Alcune di esse possono essere lette o impostate, mentre altre sono di sola lettura. Anche se in modo non esplicito, alcune proprietà di sistema corrispondono a specifiche intestazioni HTTP standard. La libreria client di Archiviazione di Azure per JavaScript gestisce automaticamente queste proprietà.
Metadati definiti dall'utente: i metadati definiti dall'utente sono costituiti da una o più coppie nome-valore specificate per una risorsa di archiviazione BLOB. È possibile usare i metadati per archiviare valori aggiuntivi con la risorsa. I valori di metadati sono solo per le proprie esigenze e non influiscono sul comportamento della risorsa.

Le coppie nome/valore di metadati sono intestazioni HTTP valide e devono essere conformi alle restrizioni imposte sulle intestazioni HTTP. Per ulteriori informazioni sui requisiti di denominazione dei metadati, consultare Nomi dei metadati.

Recuperare le proprietà del contenitore

Per recuperare le proprietà del contenitore, usare il metodo seguente:

ContainerClient.getProperties

Nell'esempio di codice seguente vengono recuperate le proprietà di un contenitore e vengono scritti alcuni valori delle proprietà in una finestra della console:

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

Impostare e recuperare i metadati

È possibile specificare i metadati come una o più coppie nome-valore risorsa contenitore. Per impostare i metadati, creare un oggetto ContainerClient, quindi usare il metodo seguente:

ContainerClient.setMetadata

L'esempio di codice seguente di esempio imposta i metadati in un contenitore:

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

Per recuperare i metadati, ottenere le proprietà del contenitore e quindi usare la proprietà metadati restituita.

Risorse

Per ulteriori informazioni sull'impostazione e il recupero di proprietà e metadati del contenitore tramite la libreria client di Archivio BLOB di Azure per JavaScript, consultare le seguenti risorse.

Esempi di codice

Visualizzare esempi di codice JavaScript e TypeScript di questo articolo (GitHub)

Operazioni dell'API REST

Azure SDK per JavaScript contiene librerie basate sull'API REST di Azure che consentono di interagire con le operazioni dell'API REST tramite paradigmi noti di JavaScript. I metodi per impostare e recuperare proprietà di metadati tramite la libreria client usano le seguenti operazioni API REST:

Ottenere proprietà dei contenitori (API REST)
Impostare metadati dei contenitori (API REST)
Ottenere metadati dei contenitori (API REST)

Il metodo getProperties recupera le proprietà e i metadati del contenitore chiamando sia l'operazione Get Blob Properties che l'operazione Get Blob Metadata.

Condividi tramite