使用 JavaScript 或 TypeScript 管理容器屬性和元數據

發行項
10/31/2024

除了包含的資料之外，Blob 容器還支援系統屬性和使用者定義的中繼資料。此文章說明如何使用適用於 JavaScript 的 Azure 儲存體用戶端程式庫，來管理系統屬性和使用者定義的中繼資料。

必要條件

本文中的範例假設您已設定專案，以搭配使用適用於 JavaScript 的 Azure Blob 儲存體用戶端程式庫。若要了解設定專案，包括套件安裝、匯入模組，以及建立授權的用戶端物件來處理資料資源，請參閱開始使用 Azure Blob 儲存體和 JavaScript。
授權機制必須含有處理容器屬性或中繼資料的權限。若要深入了解，請參閱下列 REST API 作業的授權指引：

關於屬性和中繼資料

系統屬性：系統屬性存在於每個 Blob 儲存體資源上。其中一些可以讀取或設定，另一些則是唯讀的。實際上，某些系統屬性會對應至特定標準 HTTP 標頭。適用於 JavaScript 的 Azure 儲存體用戶端程式庫會為您維護這些屬性。
使用者定義的中繼資料：使用者定義的中繼資料是由您為 Blob 儲存體資源所指定一或多個成對的名稱和數值所組成。您可以使用中繼資料來儲存資源的額外值。中繼資料值僅供您自己使用，並不會影響資源的運作方式。

中繼資料名稱/值組是有效的 HTTP 標頭，所以應該遵守控管 HTTP 標頭的所有限制。如需中繼資料命名需求的詳細資訊，請參閱中繼資料名稱。

擷取容器屬性

若要擷取容器屬性，請使用下列其中一種方法：

ContainerClient.getProperties

下列程式代碼範例會擷取容器的屬性，並將某些屬性值寫入主控台視窗：

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

設定及擷取中繼資料

您可以針對容器資源，將中繼資料指定為一個或多個名稱/值組。若要設定中繼資料，請建立 ContainerClient 物件，然後使用下列方法：

ContainerClient.setMetadata

下列程式碼範例會在容器上設定中繼資料：

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

若要擷取中繼資料，請取得容器屬性，然後使用傳回的中繼資料屬性。

資源

若要深入了解如何使用適用於 JavaScript 的 Azure Blob 儲存體用戶端程式庫來設定和擷取容器屬性和中繼資料，請參閱下列資源。

程式碼範例

檢視本文中的 JavaScript 和 TypeScript 程式代碼範例（GitHub）

REST API 操作

適用於 JavaScript 的 Azure SDK 包含建置在 Azure REST API 之上的程式庫，可讓您透過熟悉的 JavaScript 範例與 REST API 作業進行互動。用來設定與擷取屬性和中繼資料的用戶端程式庫方法會使用下列 REST API 作業：

getProperties 方法會藉由呼叫取得 Blob 屬性作業和取得 Blob 中繼資料作業來擷取 Blob 容器和中繼資料。

共用方式為