Manage blob properties and metadata with JavaScript

In addition to the data they contain, blobs support system properties and user-defined metadata. This article shows how to manage system properties and user-defined metadata with the Azure Storage client library for JavaScript.

Prerequisites

• The examples in this article assume you already have a project set up to work with the Azure Blob Storage client library for JavaScript. To learn about setting up your project, including package installation, importing modules, and creating an authorized client object to work with data resources, see Get started with Azure Blob Storage and JavaScript.
• The authorization mechanism must have permissions to work with blob properties or metadata. To learn more, see the authorization guidance for the following REST API operations:
  • Set Blob Properties
  • Get Blob Properties
  • Set Blob Metadata
  • Get Blob Metadata

About properties and metadata

• System properties: System properties exist on each Blob storage resource. Some of them can be read or set, while others are read-only. Under the covers, some system properties correspond to certain standard HTTP headers. The Azure Storage client library for JavaScript maintains these properties for you.

• User-defined metadata: User-defined metadata consists of one or more name-value pairs that you specify for a Blob storage resource. You can use metadata to store additional values with the resource. Metadata values are for your own purposes only, and don't affect how the resource behaves.

  Metadata name/value pairs are valid HTTP headers and should adhere to all restrictions governing HTTP headers. For more information about metadata naming requirements, see Metadata names.

Set and retrieve properties

To set properties on a blob, use the following method:

• BlobClient.setHTTPHeaders

The following code example sets the blobContentType and blobContentLanguage system properties on a blob.

Any properties not explicitly set are cleared. The following code example first gets the existing properties on the blob, then uses them to populate the headers that aren't being updated.

async function setHTTPHeaders(blobClient, headers) {
  
  // Get existing properties
  const properties = await blobClient.getProperties();

  // Set the blobContentType and blobContentLanguage headers
  // Populate the remaining headers from the existing properties
  blobHeaders = {
    blobContentType: 'text/plain',
    blobContentLanguage: 'en-us',
    blobContentEncoding: properties.contentEncoding,
    blobCacheControl: properties.cacheControl,
    blobContentDisposition: properties.contentDisposition,
    blobContentMD5: properties.contentMD5
  },

  await blobClient.setHTTPHeaders(blobHeaders);
}

async function setHTTPHeaders(
  blobClient: BlobClient
): Promise<void> {

  // Get existing properties
  const properties = await blobClient.getProperties();

  // Set the blobContentType and blobContentLanguage headers
  // Populate the remaining headers from the existing properties
  const blobHeaders: BlobHTTPHeaders = {
    blobContentType: 'text/plain',
    blobContentLanguage: 'en-us',
    blobContentEncoding: properties.contentEncoding,
    blobCacheControl: properties.cacheControl,
    blobContentDisposition: properties.contentDisposition,
    blobContentMD5: properties.contentMD5
  };

  await blobClient.setHTTPHeaders(blobHeaders);
}

To retrieve properties on a blob, use the following method:

• getProperties

The following code example gets a blob's system properties and displays some of the values:

async function getProperties(blobClient) {

  const properties = await blobClient.getProperties();
  
  console.log(`blobType: ${properties.blobType}`);
  console.log(`contentType: ${properties.contentType}`);
  console.log(`contentLength: ${properties.contentLength}`);
  console.log(`lastModified: ${properties.lastModified}`);
}

async function getProperties(
  blobClient: BlobClient
): Promise<void> {
  
  const propertiesResponse: BlobGetPropertiesResponse =
    await blobClient.getProperties();

  console.log(`blobType: ${propertiesResponse.blobType}`);
  console.log(`contentType: ${propertiesResponse.contentType}`);
  console.log(`contentLength: ${propertiesResponse.contentLength}`);
  console.log(`lastModified: ${propertiesResponse.lastModified}`);
}

Set and retrieve metadata

You can specify metadata as one or more name-value pairs on a blob or container resource. To set metadata, send a Metadata object containing name-value pairs using the following method:

• BlobClient.setMetadata

The following code example sets metadata on a blob:

async function setBlobMetadata(blobClient, metadata) {
  
  metadata = {
    docType: 'text',
    category: 'reference'
  };

  await blobClient.setMetadata(metadata);
}

async function setBlobMetadata(
  blobClient: BlobClient
): Promise<void> {

  const metadata: Metadata = {
    docType: 'text',
    category: 'reference'
  };

  await blobClient.setMetadata(metadata);
}

To retrieve metadata, call the getProperties method on your blob to populate the metadata collection, then read the values from the metadata property. The getProperties method retrieves blob properties and metadata by calling both the Get Blob Properties operation and the Get Blob Metadata operation.

Resources

To learn more about how to manage system properties and user-defined metadata using the Azure Blob Storage client library for JavaScript, see the following resources.

Code samples

• View JavaScript and TypeScript code samples from this article (GitHub)

REST API operations

The Azure SDK for JavaScript contains libraries that build on top of the Azure REST API, allowing you to interact with REST API operations through familiar JavaScript paradigms. The client library methods for managing system properties and user-defined metadata use the following REST API operations:

• Set Blob Properties (REST API)
• Get Blob Properties (REST API)
• Set Blob Metadata (REST API)
• Get Blob Metadata (REST API)

Client library resources

• Client library reference documentation
• Client library source code
• Package (npm)

Related content

• This article is part of the Blob Storage developer guide for JavaScript/TypeScript. To learn more, see the full list of developer guide articles at Build your JavaScript/TypeScript app.