Delete and restore a blob with JavaScript or TypeScript

• .NET
• Java
• JavaScript
• Python
• Go

This article shows how to delete blobs with the Azure Storage client library for JavaScript, and how to restore soft-deleted blobs during the retention period.

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 delete a blob, or to restore a soft-deleted blob. To learn more, see the authorization guidance for the following REST API operations:
  • Delete Blob
  • Undelete Blob

Delete a blob

Note

When blob soft delete is enabled for a storage account, you can't perform a permanent deletion using client library methods. Using the methods in this article, a soft-deleted blob, blob version, or snapshot remains available until the retention period expires, at which time it's permanently deleted. To learn more about the underlying REST API operation, see Delete Blob (REST API).

To delete a blob, call one of the following methods:

• BlobClient.delete
• BlobClient.deleteIfExists

If the blob has any associated snapshots, you must delete all of its snapshots to delete the blob. The following code example shows how to delete a blob and its snapshots:

JavaScript

async function deleteBlob(containerClient, blobName){

  // include: Delete the base blob and all of its snapshots
  // only: Delete only the blob's snapshots and not the blob itself
  const options = {
    deleteSnapshots: 'include'
  }

  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  await blockBlobClient.delete(options);
}

TypeScript

async function deleteBlob(
  containerClient: ContainerClient,
  blobName
): Promise<void> {

  // Create blob client from container client
  const blockBlobClient: BlockBlobClient = containerClient.getBlockBlobClient(blobName);

  // include: Delete the base blob and all of its snapshots
  // only: Delete only the blob's snapshots and not the blob itself
  const options: BlobDeleteOptions = {
    deleteSnapshots: 'include'
  };
  const blobDeleteResponse: BlobDeleteResponse = 
    await blockBlobClient.delete(options);
}

Restore a deleted blob

Blob soft delete protects an individual blob and its versions, snapshots, and metadata from accidental deletes or overwrites by maintaining the deleted data in the system for a specified period of time. During the retention period, you can restore the blob to its state at deletion. After the retention period expires, the blob is permanently deleted. For more information about blob soft delete, see Soft delete for blobs.

You can use the Azure Storage client libraries to restore a soft-deleted blob or snapshot.

Restore soft-deleted objects when versioning is disabled

To restore soft-deleted blobs, call the following method:

• BlobClient.undelete

This method restores soft-deleted blobs and any deleted snapshots associated with it. Calling this method for a blob that hasn't been deleted has no effect.

JavaScript

async function undeleteBlob(containerClient, blobName){

  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  await blockBlobClient.undelete();
}

TypeScript

async function undeleteBlob(
  containerClient: ContainerClient,
  blobName
): Promise<void> {

  // Create blob client from container client
  const blockBlobClient: BlockBlobClient = containerClient.getBlockBlobClient(blobName);

  const options: BlobUndeleteOptions = {};
  const blobUndeleteResponse: BlobUndeleteResponse =
    await blockBlobClient.undelete(options);
}

Resources

To learn more about how to delete blobs and restore deleted blobs 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 deleting blobs and restoring deleted blobs use the following REST API operations:

• Delete Blob (REST API)
• Undelete Blob (REST API)

Client library resources

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

See also

• Soft delete for blobs
• Blob versioning

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.