azurite

What is azurite?

Azurite is an open-source Azure Storage API compatible server (emulator). It provides a local environment for testing and development of applications that use Azure Storage services, including Blob, Queue, and Table storage.

What are azurite's main functionalities?

Blob Storage

This code snippet demonstrates how to start the Azurite Blob service on port 10000. Blob storage is used for storing large amounts of unstructured data such as text or binary data.

const azurite = require('azurite');
azurite().blob().listen(10000, () => {
  console.log('Azurite Blob service is running on port 10000');
});

Queue Storage

This code snippet demonstrates how to start the Azurite Queue service on port 10001. Queue storage is used for storing large numbers of messages that can be accessed from anywhere via authenticated calls.

const azurite = require('azurite');
azurite().queue().listen(10001, () => {
  console.log('Azurite Queue service is running on port 10001');
});

Table Storage

This code snippet demonstrates how to start the Azurite Table service on port 10002. Table storage is used for storing structured NoSQL data.

const azurite = require('azurite');
azurite().table().listen(10002, () => {
  console.log('Azurite Table service is running on port 10002');
});

Other packages similar to azurite

localstack

LocalStack is a fully functional local AWS cloud stack. It provides a local testing environment for AWS services, including S3, DynamoDB, and SQS. Unlike Azurite, which focuses on Azure Storage services, LocalStack emulates a wide range of AWS services.

minio

MinIO is a high-performance, S3-compatible object storage system. It is designed to be used for large-scale data infrastructure. While Azurite emulates Azure Blob storage, MinIO provides an alternative for S3-compatible object storage.

fake-s3

Fake S3 is a lightweight server that emulates the S3 API. It is useful for testing S3 interactions locally. Unlike Azurite, which emulates Azure Storage services, Fake S3 focuses solely on the S3 API.

README

Azurite

A lightweight server clone of Azure Blob Storage that simulates most of the commands supported by it with minimal dependencies.

Endpoints

Standard Emulator Connection String: DefaultEndpointsProtocol=http;AccountName=devstoreaccount1; AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==; BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1; TableEndpoint=http://127.0.0.1:10002/devstoreaccount1; QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;

REST APIs

https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/blob-service-rest-api

Error Codes

https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/blob-service-error-codes

API Status Implementation

List Containers [DONE]

Lists all of the containers in a storage account. Markers are not supported yet.

Set Blob Service Properties

Sets the properties of the Blob service, including logging and metrics settings, and the default service version.

Get Blob Service Properties

Gets the properties of the Blob service, including logging and metrics settings, and the default service version.

Preflight Blob Request

Queries the Cross-Origin Resource Sharing (CORS) rules for the Blob service prior to sending the actual request.

Get Blob Service Stats

Retrieves statistics related to replication for the Blob service. This operation is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.

Create Container [DONE]

Creates a new container in a storage account.

Get Container Properties

Returns all user-defined metadata and system properties of a container.

Get Container Metadata

Returns only user-defined metadata of a container.

Set Container Metadata

Sets user-defined metadata of a container.

Get Container ACL

Gets the public access policy and any stored access policies for the container.

Set Container ACL

Sets the public access policy and any stored access policies for the container.

Lease Container

Establishes and manages a lock on a container for delete operations.

Delete Container [IN-PROGRESS, blob integration is missing]

Deletes the container and any blobs that it contains.

List Blobs

Lists all of the blobs in a container.

Put Blob [DONE]

Creates a new blob or replaces an existing blob within a container.

Get Blob

Reads or downloads a blob from the Blob service, including its user-defined metadata and system properties.

Get Blob Properties

Returns all system properties and user-defined metadata on the blob.

Set Blob Properties

Sets system properties defined for an existing blob.

Get Blob Metadata

Retrieves all user-defined metadata of an existing blob or snapshot.

Set Blob Metadata

Sets user-defined metadata of an existing blob.

Delete Blob

Marks a blob for deletion.

Lease Blob

Establishes and manages a lock on write and delete operations. To delete or write to a locked blob, a client must provide the lease ID.

Snapshot Blob

Creates a read-only snapshot of a blob.

Copy Blob

Copies a source blob to a destination blob in this storage account or in another storage account.

Abort Copy Blob

Aborts a pending Copy Blob operation, and leaves a destination blob with zero length and full metadata.

Put Block

Block blobs only Creates a new block to be committed as part of a block blob.

Put Block List

Block blobs only Commits a blob by specifying the set of block IDs that comprise the block blob.

Get Block List

Block blobs only Retrieves the list of blocks that have been uploaded as part of a block blob.

Put Page

Page blobs only Writes a range of pages into a page blob.

Get Page Ranges

Page blobs only Returns a list of valid page ranges for a page blob or a snapshot of a page blob.

Append Block

Append blobs only