Azure Storage client library for JavaScript

Azure Storage is a Microsoft-managed service providing cloud storage that is highly available, secure, durable, scalable, and redundant.

This project provides client libraries in JavaScript that makes it easy to consume Microsoft Azure Storage service.

Note: Current Azure Storage client libraries are published from main branch.

Source Code - Blob
Source Code - File Data Lake
Source Code - File Share
Source Code - Queue
Product documentation
@azure/storage-blob Package (npm)
@azure/storage-file-datalake Package (npm)
@azure/storage-file-share Package (npm)
@azure/storage-queue Package (npm)
API Reference documentation
Azure Storage REST APIs

Key concepts

Features

Blob Storage
- Get/Set Blob Service Properties
- Create/List/Delete Containers
- Create/Read/List/Update/Delete Block Blobs
- Create/Read/List/Update/Delete Page Blobs
- Create/Read/List/Update/Delete Append Blobs
Data Lake Storage
- Create/List/Delete File Systems
- Create/Read/List/Update/Delete Paths, Directories and Files
File Storage
- Get/Set File Service Properties
- Create/List/Delete File Shares
- Create/List/Delete File Directories
- Create/Read/List/Update/Delete Files
Queue Storage
- Get/Set Queue Service Properties
- Create/List/Delete Queues
- Enqueue/Dequeue/Peek/Clear/Update/Delete Queue Messages
Features new
- Asynchronous I/O for all operations using the async methods
- HttpPipeline which enables a high degree of per-request configurability
- 1-to-1 correlation with the Storage REST API for clarity and simplicity

Compatibility

These libraries are compatible with Node.js and browsers, and validated against LTS Node.js versions (>=8.16.0) and latest versions of Chrome, Firefox and Edge.

Architecture

The Azure Storage client libraries for JavaScript provides low-level and high-level APIs. Take Blob client library as example:

BlobServiceClient, ContainerClient and BlobClient objects provide the low-level API functionality and map one-to-one to the Azure Storage Blob REST APIs.
The high-level APIs provide convenience abstractions such as uploading a large stream to a block blob (using multiple PutBlock requests).

Examples

Please check out examples for each libraries

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.