Use Azurite emulator for local Azure Storage development (2024)

Article
09/19/2022
17 minutes to read

The Azurite open-source emulator provides a free local environment for testing your Azure Blob, Queue Storage, and Table Storage applications. When you're satisfied with how your application is working locally, switch to using an Azure Storage account in the cloud. The emulator provides cross-platform support on Windows, Linux, and macOS.

Azurite is the future storage emulator platform. Azurite supersedes the Azure Storage Emulator. Azurite will continue to be updated to support the latest versions of Azure Storage APIs.

There are several different ways to install and run Azurite on your local system. Select any of these tabs.

Install Azurite

Visual Studio
Visual Studio Code
npm
Docker Hub
GitHub

Azurite is automatically available with Visual Studio 2022. If you are running an earlier version of Visual Studio, you'll need to install Azurite by using either Node Package Manager, DockerHub, or by cloning the Azurite GitHub repository.

Run Azurite

Visual Studio
Visual Studio Code
npm
Docker Hub
GitHub

With a few configurations, Azure Functions or ASP.NET projects start Azurite automatically. For all other project types, you'll have to start Azurite from the command line.

Running Azurite from the command line

You can find the Azurite executable file in the extensions folder of your Visual Studio installation. The specific location can vary based on which version of Visual Studio you have installed. For example, if you've installed Visual Studio 2022 professional edition on a Windows computer or Virtual Machine (VM), you would find the Azurite executable file at this location: C:\Program Files\Microsoft Visual Studio\2022\Professional\Common7\IDE\Extensions\Microsoft\Azure Storage Emulator.

After you run the executable file, Azurite listens for connections.

Running Azurite from an Azure Functions project

In Visual Studio 2022, create an Azure Functions project. As you create the project, choose the Storage Emulator.

After you create the project, Azurite starts automatically.

Running Azurite from an ASP.NET project

In Visual Studio 2022, create an ASP.NET Core Web App project. Then, open the Connected Services dialog box, select Add a service dependency, and then select Storage Azurite emulator.

In the Configure Storage Azurite emulator dialog box, set the Connection string name field to StorageConnectionString, and then select Finish.

When the configuration completes, select Close. The Azurite emulator starts automatically.

Command-line options

This section details the command line switches available when launching Azurite.

Help

Optional - Get command-line help by using the -h or --help switch.

azurite -hazurite --help

Blob listening host

Optional - By default, Azurite will listen to 127.0.0.1 as the local server. Use the --blobHost switch to set the address to your requirements.

Accept requests on the local machine only:

azurite --blobHost 127.0.0.1

Allow remote requests:

azurite --blobHost 0.0.0.0

Caution

Allowing remote requests may make your system vulnerable to external attacks.

Blob listening port configuration

Optional - By default, Azurite will listen for the Blob service on port 10000. Use the --blobPort switch to specify the listening port that you require.

Note

After using a customized port, you need to update the connection string or corresponding configuration in your Azure Storage tools or SDKs.

Customize the Blob service listening port:

azurite --blobPort 8888

Let the system auto select an available port:

azurite --blobPort 0

The port in use is displayed during Azurite startup.

Queue listening host

Optional - By default, Azurite will listen to 127.0.0.1 as the local server. Use the --queueHost switch to set the address to your requirements.

Accept requests on the local machine only:

Queue listening port configuration

Optional - By default, Azurite will listen for the Queue service on port 10001. Use the --queuePort switch to specify the listening port that you require.

Note

After using a customized port, you need to update the connection string or corresponding configuration in your Azure Storage tools or SDKs.

Customize the Queue service listening port:

azurite --queuePort 8888

Let the system auto select an available port:

azurite --queuePort 0

The port in use is displayed during Azurite startup.

Table listening host

Optional - By default, Azurite will listen to 127.0.0.1 as the local server. Use the --tableHost switch to set the address to your requirements.

Accept requests on the local machine only:

azurite --tableHost 127.0.0.1

Allow remote requests:

azurite --tableHost 0.0.0.0

Caution

Allowing remote requests may make your system vulnerable to external attacks.

Table listening port configuration

Optional - By default, Azurite will listen for the Table service on port 10002. Use the --tablePort switch to specify the listening port that you require.

Note

After using a customized port, you need to update the connection string or corresponding configuration in your Azure Storage tools or SDKs.

Customize the Table service listening port:

azurite --tablePort 11111

Let the system auto select an available port:

azurite --tablePort 0

The port in use is displayed during Azurite startup.

Workspace path

Optional - Azurite stores data to the local disk during execution. Use the -l or --location switch to specify a path as the workspace location. By default, the current process working directory will be used. Note the lowercase 'l'.

azurite -l c:\azuriteazurite --location c:\azurite

Access log

Optional - By default, the access log is displayed in the console window. Disable the display of the access log by using the -s or --silent switch.

azurite -sazurite --silent

Debug log

Optional - The debug log includes detailed information on every request and exception stack trace. Enable the debug log by providing a valid local file path to the -d or --debug switch.

azurite -d path/debug.logazurite --debug path/debug.log

Loose mode

Optional - By default, Azurite applies strict mode to block unsupported request headers and parameters. Disable strict mode by using the -L or --loose switch. Note the capital 'L'.

azurite -Lazurite --loose

Version

Optional - Display the installed Azurite version number by using the -v or --version switch.

azurite -vazurite --version

Certificate configuration (HTTPS)

Optional - By default, Azurite uses the HTTP protocol. Enable HTTPS mode by providing a path to a Privacy Enhanced Mail (.pem) or Personal Information Exchange (.pfx) certificate file to the --cert switch.

When --cert is provided for a PEM file, you must provide a corresponding --key switch.

azurite --cert path/server.pem --key path/key.pem

When --cert is provided for a PFX file, you must provide a corresponding --pwd switch.

azurite --cert path/server.pfx --pwd pfxpassword

For detailed information on creating PEM and PFX files, see HTTPS Setup.

OAuth configuration

Optional - Enable OAuth authentication for Azurite by using the --oauth switch.

azurite --oauth basic --cert path/server.pem --key path/key.pem

Note

OAuth requires an HTTPS endpoint. Make sure HTTPS is enabled by providing --cert switch along with the --oauth switch.

Azurite supports basic authentication by specifying the basic parameter to the --oauth switch. Azurite will do basic authentication, like validating the incoming bearer token, checking the issuer, audience, and expiry. Azurite won't check the token signature or permissions.

Skip API Version Check

Optional - When starting up, Azurite checks that the requested API version is valid. The following command skips the API version check:

azurite --skipApiVersionCheck

Disable Production Style Url

Optional. When using the fully-qualified domain name instead of the IP in request Uri host, by default Azurite will parse the storage account name from request Uri host. You can force the parsing of the storage account name from request Uri path by using --disableProductStyleUrl:

azurite --disableProductStyleUrl

Connect to Azurite from Azure Storage SDKs or tools, like Azure Storage Explorer, by using any authentication strategy. Authentication is required. Azurite supports authorization with OAuth, Shared Key, and shared access signatures (SAS). Azurite also supports anonymous access to public containers.

If you're using the Azure SDKs, start Azurite with the --oauth basic and --cert --key/--pwd options.

Well-known storage account and key

Azurite accepts the same well-known account and key used by the legacy Azure Storage Emulator.

Account name: devstoreaccount1
Account key: Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==

Custom storage accounts and keys

Azurite supports custom storage account names and keys by setting the AZURITE_ACCOUNTS environment variable in the following format: account1:key1[:key2];account2:key1[:key2];....

For example, use a custom storage account that has one key:

set AZURITE_ACCOUNTS="account1:key1"

export AZURITE_ACCOUNTS="account1:key1"

Note

The account keys must be a base64 encoded string.

Or use multiple storage accounts with two keys each:

set AZURITE_ACCOUNTS="account1:key1:key2;account2:key1:key2"

export AZURITE_ACCOUNTS="account1:key1:key2;account2:key1:key2"

Azurite refreshes custom account names and keys from the environment variable every minute by default. With this feature, you can dynamically rotate the account key, or add new storage accounts without restarting Azurite.

Note

The default devstoreaccount1 storage account is disabled when you set custom storage accounts.

The account keys must be a base64 encoded string.

Connection strings

The easiest way to connect to Azurite from your application is to configure a connection string in your application's configuration file that references the shortcut UseDevelopmentStorage=true. Here's an example of a connection string in an app.config file:

<appSettings> <add key="StorageConnectionString" value="UseDevelopmentStorage=true" /></appSettings>

HTTP connection strings

You can pass the following connection strings to the Azure SDKs or tools, like Azure CLI 2.0 or Storage Explorer.

The full connection string is:

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

To connect to the blob service only, the connection string is:

To connect to the queue service only, the connection string is:

To connect to the table service only, the connection string is:

HTTPS connection strings

The full HTTPS connection string is:

DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=https://127.0.0.1:10000/devstoreaccount1;QueueEndpoint=https://127.0.0.1:10001/devstoreaccount1;TableEndpoint=https://127.0.0.1:10002/devstoreaccount1;

To use the blob service only, the HTTPS connection string is:

To use the queue service only, the HTTPS connection string is:

To use the table service only, the HTTPS connection string is:

If you used dotnet dev-certs to generate your self-signed certificate, use the following connection string.

DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=https://localhost:10000/devstoreaccount1;QueueEndpoint=https://localhost:10001/devstoreaccount1;TableEndpoint=https://localhost:10002/devstoreaccount1;

Update the connection string when using custom storage accounts and keys.

For more information, see Configure Azure Storage connection strings.

Azure SDKs

To use Azurite with the Azure SDKs, use OAuth and HTTPS options:

azurite --oauth basic --cert certname.pem --key certname-key.pem

Azure Blob Storage

You can then instantiate a BlobContainerClient, BlobServiceClient, or BlobClient.

// With container URL and DefaultAzureCredentialvar client = new BlobContainerClient( new Uri("https://127.0.0.1:10000/devstoreaccount1/container-name"), new DefaultAzureCredential() );// With connection stringvar client = new BlobContainerClient( "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=https://127.0.0.1:10000/devstoreaccount1;", "container-name" );// With account name and keyvar client = new BlobContainerClient( new Uri("https://127.0.0.1:10000/devstoreaccount1/container-name"), new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==") );

Azure Queue Storage

You can also instantiate a QueueClient or QueueServiceClient.

// With queue URL and DefaultAzureCredentialvar client = new QueueClient( new Uri("https://127.0.0.1:10001/devstoreaccount1/queue-name"), new DefaultAzureCredential() );// With connection stringvar client = new QueueClient( "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=https://127.0.0.1:10001/devstoreaccount1;", "queue-name" );// With account name and keyvar client = new QueueClient( new Uri("https://127.0.0.1:10001/devstoreaccount1/queue-name"), new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==") );

Azure Table Storage

You can also instantiate a TableClient or TableServiceClient.

// With table URL and DefaultAzureCredentialvar client = new Client( new Uri("https://127.0.0.1:10002/devstoreaccount1/table-name"), new DefaultAzureCredential() );// With connection stringvar client = new TableClient( "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;TableEndpoint=https://127.0.0.1:10002/devstoreaccount1;", "table-name" );// With account name and keyvar client = new TableClient( new Uri("https://127.0.0.1:10002/devstoreaccount1/table-name"), new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==") );

Microsoft Azure Storage Explorer

You can use Storage Explorer to view the data stored in Azurite.

Connect to Azurite using HTTP

In Storage Explorer, connect to Azurite by following these steps:

Select the Manage Accounts icon
Select Add an account
Select Attach to a local emulator
Select Next
Edit the Display name field to a name of your choice
Select Next again
Select Connect

Connect to Azurite using HTTPS

By default Storage Explorer won't open an HTTPS endpoint that uses a self-signed certificate. If you're running Azurite with HTTPS, you're likely using a self-signed certificate. In Storage Explorer, import SSL certificates via the Edit -> SSL Certificates -> Import Certificates dialog.

Import Certificate to Storage Explorer

Find the certificate on your local machine.
In Storage Explorer, go to Edit -> SSL Certificates -> Import Certificates and import your certificate.

If you don't import a certificate, you'll get an error:

unable to verify the first certificate or self signed certificate in chain

Add Azurite via HTTPS connection string

Follow these steps to add Azurite HTTPS to Storage Explorer:

Select Toggle Explorer
Select Local & Attached
Right-click on Storage Accounts and select Connect to Azure Storage.
Select Use a connection string
Select Next.
Enter a value in the Display name field.
Enter the HTTPS connection string from the previous section of this document
Select Next
Select Connect

Workspace structure

The following files and folders may be created in the workspace location when initializing Azurite.

__blobstorage__ - Directory containing Azurite blob service persisted binary data
__queuestorage__ - Directory containing Azurite queue service persisted binary data
__tablestorage__ - Directory containing Azurite table service persisted binary data
__azurite_db_blob__.json - Azurite blob service metadata file
__azurite_db_blob_extent__.json - Azurite blob service extent metadata file
__azurite_db_queue__.json - Azurite queue service metadata file
__azurite_db_queue_extent__.json - Azurite queue service extent metadata file
__azurite_db_table__.json - Azurite table service metadata file
__azurite_db_table_extent__.json - Azurite table service extent metadata file

To clean up Azurite, delete above files and folders and restart the emulator.

Differences between Azurite and Azure Storage

There are functional differences between a local instance of Azurite and an Azure Storage account in the cloud.

Endpoint and connection URL

The service endpoints for Azurite are different from the endpoints of an Azure Storage account. The local computer doesn't do domain name resolution, requiring Azurite endpoints to be local addresses.

When you address a resource in an Azure Storage account, the account name is part of the URI host name. The resource being addressed is part of the URI path:

<http|https>://<account-name>.<service-name>.core.windows.net/<resource-path>

The following URI is a valid address for a blob in an Azure Storage account:

https://myaccount.blob.core.windows.net/mycontainer/myblob.txt

IP-style URL

Since the local computer doesn't resolve domain names, the account name is part of the URI path instead of the host name. Use the following URI format for a resource in Azurite:

http://<local-machine-address>:<port>/<account-name>/<resource-path>

The following address might be used for accessing a blob in Azurite:

http://127.0.0.1:10000/myaccount/mycontainer/myblob.txt

Production-style URL

Optionally, you could modify your hosts file to access an account with production-style URL.

First, add one or more lines to your hosts file. For example:

127.0.0.1 account1.blob.localhost127.0.0.1 account1.queue.localhost127.0.0.1 account1.table.localhost

Next, set environment variables to enable customized storage accounts and keys:

set AZURITE_ACCOUNTS="account1:key1:key2"

You could add more accounts. See the Custom storage accounts and keys section of this article.

Start Azurite and use a customized connection string to access your account. The example connection string below assumes that the default ports are used.

DefaultEndpointsProtocol=http;AccountName=account1;AccountKey=key1;BlobEndpoint=http://account1.blob.localhost:10000;QueueEndpoint=http://account1.queue.localhost:10001;TableEndpoint=http://account1.table.localhost:10002;

Do not access default account in this way with Azure Storage Explorer. There is a bug that Storage Explorer is always adding account name in URL path, causing failures.

By default, when using Azurite with a production-style URL, the account name should be the host name in fully-qualified domain name such as "http://devstoreaccount1.blob.localhost:10000/container". To use production-style URL with account name in the URL path such as "http://foo.bar.com:10000/devstoreaccount1/container", make sure to use the --disableProductStyleUrl parameter when you start Azurite.

If use host.docker.internal as request Uri host (For example: http://host.docker.internal:10000/devstoreaccount1/container), Azurite will always get the account name from the request Uri path. This is true regardless of whether you use the --disableProductStyleUrl parameter when you start Azurite.

Scaling and performance

Azurite doesn't support large numbers of connected clients. There's no performance guarantee. Azurite is intended for development and testing purposes.

Error handling

Azurite is aligned with Azure Storage error handling logic, but there are differences. For example, error messages may be different, while error status codes align.

RA-GRS

Azurite supports read-access geo-redundant replication (RA-GRS). For storage resources, access the secondary location by appending -secondary to the account name. For example, the following address might be used for accessing a blob using the read-only secondary in Azurite:

http://127.0.0.1:10000/devstoreaccount1-secondary/mycontainer/myblob.txt

Table support

Support for tables in Azurite is currently in preview. For more information, see the Azurite V3 Table project.

Support for durable functions requires tables.

Important

Azurite support for Table Storage is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

Azurite is open-source

Contributions and suggestions for Azurite are welcome. Go to the Azurite GitHub project page or GitHub issues for milestones and work items we're tracking for upcoming features and bug fixes. Detailed work items are also tracked in GitHub.

Next steps

Use the Azure Storage Emulator for development and testing documents the legacy Azure Storage Emulator, which is being superseded by Azurite.
Configure Azure Storage connection strings explains how to assemble a valid Azure Storage connection string.

Use Azurite emulator for local Azure Storage development (2024)

FAQs

What is azurite storage? ›

Azurite is an open source Azure Storage API compatible server (emulator). Based on Node. js, Azurite provides cross platform experiences for customers wanting to try Azure Storage easily in a local environment. Azurite simulates most of the commands supported by Azure Storage with minimal dependencies.

View Details ›

What is Windows Azure storage emulator? ›

Microsoft Azure Storage Emulator is a tool that emulates Azure Blob, Queue, and Table services for local development purposes. You can test your application against the storage services locally without creating an Azure subscription or incurring any costs.

See Details ›

Which emulators are installed with the Azure SDK? ›

Azure SDK has two emulators namely Compute Emulator and Storage Emulator. These emulators are used by developers to operate the cloud applications on the local machine. Compute Emulator reproduces the computing environment.

Discover More Details ›

Can I run Azure function locally? ›

Azure Functions Core Tools includes a version of the same runtime that powers Azure Functions runtime that you can run on your local development computer. It also provides commands to create functions, connect to Azure, and deploy function projects.

Find Out More ›

Why is azurite so rare? ›

Since azurites have such low hardness (3.5-4) and great sensitivity to heat, faceting them is also very challenging. This combination of factors makes faceted azurites very rare.

Discover More Details ›

What can be extracted from azurite? ›

For the extraction of azure blue, azurite is ground to a fine powder and then boiled in aqua razili or in a hot concentrated solution of sodium hydroxide (NaOH); thus a precipitate is obtained, which is filtered and discarded.

Find Out More ›

How does azurite work? ›

Metaphysical Properties

An aura cleanser and a chakra healer – Azurite works to remove blockages from endless energy points, keeping those sweet vibrations flowing. Azurite is connected to the third eye chakra – the place of our deep intuition and inner guidance.

Find Out More ›

What are the 3 tiers for Azure storage? ›

Hot, cool, and archive access tiers for blob data

Article.
09/29/2022.
13 minutes to read.
5 contributors.

29 Sept 2022

Get More Info ›

What is Azure Localstorage? ›

The Azure Storage platform includes the following data services: Azure Blobs: A massively scalable object store for text and binary data. Also includes support for big data analytics through Data Lake Storage Gen2. Azure Files: Managed file shares for cloud or on-premises deployments.

Find Out More ›

What is difference between Windows Azure Platform and Windows Azure? ›

Technically Windows Azure Platform and Windows Azure are different. Windows Azure Platform is a platform offering services such as Windows Azure, SQL Azure, and AppFabric. Windows Azure is the Microsoft's cloud OS and is a part of the Azure platform.

Tell Me More ›

Does Microsoft allow emulators? ›

Microsoft® Emulator allows you to emulate devices that differ from your local desktop by using virtual machines and guest operating system images. This application doesn't come with any guest images. You will need to install one or more additional packages in order to emulate other devices.

Which emulators are installed with the major SDK? ›

The supported emulators are Genymotion and Android SDK.

Learn More ›

What is SDK emulator? ›

In Android Emulator the virtual android device is shown on our system on which we run the Android application that we code. Thus, it simply means that without needing any physical device Android SDK component “Android Emulator” provides a virtual device on the System where we run our Application.

How do I run AzCopy? ›

Run AzCopy

That way you can type azcopy from any directory on your system. If you choose not to add the AzCopy directory to your path, you'll have to change directories to the location of your AzCopy executable and type azcopy or . \azcopy in Windows PowerShell command prompts.

How do I run Azure function locally in Java? ›

Run functions locally in the IDE

Azure Functions Core Tools, version 2 must be installed to run and debug functions locally. Right-click on the generated project, then choose Run As and Maven build. In the Edit Configuration dialog, Enter package in the Goals, then select Run.

Keep Reading ›

How do I run an azure executable? ›

Go to ProjectA, Right Click, then Go to Properties, then in the Application Panel, Select Output type as Console Application. This is a MUST ! Then Build. You can Copy the bin Folder, where the Application's exe is, and paste to a folder inside the Azure Function App.

Read On ›

How do I run Microsoft emulator? ›

Getting started with Microsoft Emulator and Windows 10X - YouTube

Get More Info Here ›