LinuxCommandLibrary

azurite

Simulate Azure Storage services locally

TLDR

Use an existing location as workspace path

$ azurite [[-l|--location]] [path/to/directory]
copy

Disable access log displayed in console
$ azurite [[-s|--silent]]
copy

Enable debug log by providing a file path as log destination
$ azurite [[-d|--debug]] [path/to/debug.log]
copy

Customize the listening address of Blob/Queue/Table service
$ azurite [--blobHost|--queueHost|--tableHost] [0.0.0.0]
copy

Customize the listening port of Blob/Queue/Table service
$ azurite [--blobPort|--queuePort|--tablePort] [8888]
copy

SYNOPSIS

azurite [command]

PARAMETERS

--blobHost <host>
    Specifies the host for the Blob service emulator. Default: 127.0.0.1.

--queueHost <host>
    Specifies the host for the Queue service emulator. Default: 127.0.0.1.

--tableHost <host>
    Specifies the host for the Table service emulator. Default: 127.0.0.1.

--location <path>
    Specifies the root location for persisting emulator data. Required, there is no default value.

--debug <path>
    Specifies the debug log file path. Default: stdout.

--silent
    Suppresses console output.

--oauth
    Enables OAuth authentication. Note: requires further configuration with valid credentials.

--skipApiVersionCheck
    Skips the API version check during startup.

-h, --help
    Displays help information.

--blobPort <port>
    Specifies the port for the Blob service emulator. Default: 10000.

--queuePort <port>
    Specifies the port for the Queue service emulator. Default: 10001.

--tablePort <port>
    Specifies the port for the Table service emulator. Default: 10002.

DESCRIPTION

Azurite is an open-source, cross-platform emulator that provides a local environment for developing and testing Azure Blob, Queue, and Table storage applications. It replicates the core functionality of Azure Storage services, allowing developers to work offline without requiring a connection to a live Azure subscription. Azurite simulates the Azure Storage APIs, which enables developers to write applications that seamlessly transition between local testing and deployment in the cloud.
It is a valuable tool for rapid development and debugging, minimizing network latency and costs associated with using actual cloud resources. Azurite is distributed as an npm package, making it easy to install and integrate into various development workflows. It's actively maintained by Microsoft and provides several configuration options for customization.

CAVEATS

Azurite is designed for local development and testing purposes. It does not offer the same level of scalability, performance, and data durability as the actual Azure Storage service.
It is crucial to configure Azurite to persist data to a safe location to avoid data loss when the emulator is stopped or restarted.

CONFIGURATION

Azurite can be configured through command-line parameters or using an environment variable named 'AZURITE_ACCOUNTS'. This variable allows defining storage accounts and their corresponding keys, enabling authentication in the local environment. Ensure your storage account configuration matches your application's authentication requirements.

USAGE EXAMPLES

To start Azurite with default settings:
azurite --location /path/to/data

To specify custom ports:
azurite --blobPort 11000 --queuePort 11001 --location /path/to/data

HISTORY

Azurite evolved from previous Azure Storage Emulators, primarily aiming for cross-platform compatibility and closer adherence to the Azure Storage API. Its development is driven by the need for developers to have a reliable local testing environment, independent of network connectivity and Azure subscriptions. The emulator is continuously updated to reflect changes and additions to the Azure Storage services.

SEE ALSO

docker(1)

Copied to clipboard