Azure

Azure App Configuration

Store data in the key-value store of Azure App Configuration.

Usage

Driver name: azure-app-configuration

This driver uses the configuration store as a key-value store. It uses the key as the name and the value as content. You can also use labels to differentiate between different environments (dev, prod, etc.) and use prefixes to differentiate between different applications (app01, app02, etc.).

To use it, you will need to install @azure/app-configuration and @azure/identity in your project:

npm i @azure/app-configuration @azure/identity

Usage:

import { createStorage } from "unstorage";
import azureAppConfiguration from "unstorage/drivers/azure-app-configuration";

const storage = createStorage({
  driver: azureAppConfiguration({
    appConfigName: "unstoragetest",
    label: "dev",
    prefix: "app01",
  }),
});

Authentication:

The driver supports the following authentication methods:

• DefaultAzureCredential: This is the recommended way to authenticate. It will use managed identity or environment variables to authenticate the request. It will also work in a local environment by trying to use Azure CLI or Azure PowerShell to authenticate.
  ⚠️ Make sure that your Managed Identity or personal account has the App Configuration Data Owner role assigned to it, even if you already are the Contributor or Owner on the app configuration resource.
• connectionString: The app configuration connection string. Not recommended for use in production.

Options:

• appConfigName: The name of the app configuration resource.
• endpoint: The endpoint of the app configuration resource.
• connectionString: The connection string of the app configuration resource.
• prefix: Optional prefix for keys. This can be used to isolate keys from different applications in the same Azure App Configuration instance. E.g. "app01" results in keys like "app01:foo" and "app01:bar".
• label: Optional label for keys. If not provided, all keys will be created and listed without labels. This can be used to isolate keys from different environments in the same Azure App Configuration instance. E.g. "dev" results in keys like "foo" and "bar" with the label "dev".

Azure Cosmos DB

Store data in Azure Cosmos DB NoSQL API documents.

Usage

Driver name: azure-cosmos

This driver stores KV information in a NoSQL API Cosmos DB collection as documents. It uses the id field as the key and adds value and modified fields to the document.

To use it, you will need to install @azure/cosmos and @azure/identity in your project:

npm i @azure/cosmos @azure/identity

Usage:

import { createStorage } from "unstorage";
import azureCosmos from "unstorage/drivers/azure-cosmos";

const storage = createStorage({
  driver: azureCosmos({
    endpoint: "ENDPOINT",
    accountKey: "ACCOUNT_KEY",
  }),
});

Authentication:

• DefaultAzureCredential: This is the recommended way to authenticate. It will use managed identity or environment variables to authenticate the request. It will also work in a local environment by trying to use Azure CLI or Azure PowerShell to authenticate.
  ⚠️ Make sure that your Managed Identity or personal account has at least Cosmos DB Built-in Data Contributor role assigned to it. If you already are the Contributor or Owner on the resource it should also be enough, but that does not accomplish a model of least privilege.
• accountKey: CosmosDB account key. If not provided, the driver will use the DefaultAzureCredential (recommended).

Options:

• endpoint (required): CosmosDB endpoint in the format of https://<account>.documents.azure.com:443/.
• accountKey: CosmosDB account key. If not provided, the driver will use the DefaultAzureCredential (recommended).
• databaseName: The name of the database to use. Defaults to unstorage.
• containerName: The name of the container to use. Defaults to unstorage.

Azure Key Vault

Store data in a Azure Key Vault secrets.

Usage

Driver name: azure-key-vault

This driver stores KV information in Azure Key Vault secrets by using the key as secret id and the value as secret content. Please be aware that key vault secrets don't have the fastest access time and are not designed for high throughput. You also have to disable purge protection for your key vault to be able to delete secrets. This implementation deletes and purges a secret when it is deleted to avoid conflicts with soft delete.

⚠️ Be aware that this driver stores the keys of your key:value pairs in an encoded way in Key Vault to avoid conflicts with naming requirements for secrets. This means that you will not be able to access manually (outside of unstorage) created secrets inside your Key Vault, as long as they are not encoded in the same way.

To use it, you will need to install @azure/keyvault-secrets and @azure/identity in your project:

npm i @azure/keyvault-secrets @azure/identity

Usage:

import { createStorage } from "unstorage";
import azureKeyVault from "unstorage/drivers/azure-key-vault";

const storage = createStorage({
  driver: azureKeyVault({
    vaultName: "testunstoragevault",
  }),
});

Authentication:

The driver supports the following authentication methods:

• DefaultAzureCredential: This is the recommended way to authenticate. It will use managed identity or environment variables to authenticate the request. It will also work in a local environment by trying to use Azure CLI or Azure PowerShell to authenticate.

⚠️ Make sure that your Managed Identity or personal account has either the Key Vault Secrets Officer (or Key Vault Secrets User for read-only) RBAC role assigned or is a member of an access policy that grants Get, List, Set, Delete and Purge secret permissions.

Options:

• vaultName (required): The name of the key vault to use.
• serviceVersion: Version of the Azure Key Vault service to use. Defaults to 7.3.
• pageSize: The number of entries to retrieve per request. Impacts getKeys() and clear() performance. Maximum value is 25.

Azure Blob Storage

Store data in a Azure blob storage.

Usage

Driver name: azure-storage-blob

This driver stores KV information in a Azure blob storage blob. The same container is used for all entries. Each entry is stored in a separate blob with the key as the blob name and the value as the blob content.

To use it, you will need to install @azure/storage-blob and @azure/identity in your project:

npm i @azure/storage-blob @azure/identity

Please make sure that the container you want to use exists in your storage account.

import { createStorage } from "unstorage";
import azureStorageBlobDriver from "unstorage/drivers/azure-storage-blob";

const storage = createStorage({
  driver: azureStorageBlobDriver({
    accountName: "myazurestorageaccount",
  }),
});

Authentication:

The driver supports the following authentication methods:

• DefaultAzureCredential: This is the recommended way to authenticate. It will use managed identity or environment variables to authenticate the request. It will also work in a local environment by trying to use Azure CLI or Azure PowerShell to authenticate.
  ⚠️ Make sure that your Managed Identity or personal account has the Storage Blob Data Contributor role assigned to it, even if you already are Contributor or Owner on the storage account.
• AzureNamedKeyCredential (only available in Node.js runtime): This will use the accountName and accountKey to authenticate the request.
• AzureSASCredential: This will use the accountName and sasToken to authenticate the request.
• connection string (only available in Node.js runtime): This will use the connectionString to authenticate the request. This is not recommended as it will expose your account key in plain text.

Options:

• accountName (required): The name of your storage account.
• containerName: The name of the blob container to use. Defaults to unstorage.
• accountKey: The account key to use for authentication. This is only required if you are using AzureNamedKeyCredential.
• sasKey: The SAS token to use for authentication. This is only required if you are using AzureSASCredential.
• connectionString: The storage accounts' connection string. accountKey and sasKey take precedence.

Azure Table Storage

Store data in a Azure table storage.

Usage

Driver name: azure-storage-table

Store data in a data-tables.

This driver stores KV information in a Azure table storage. The same partition key is used for all keys and the field unstorageValue is used to store the value.

To use it, you will need to install @azure/data-table and @azure/identity in your project:

npm i @azure/data-table @azure/identity

Please make sure that the table you want to use exists in your storage account.

import { createStorage } from "unstorage";
import azureStorageTableDriver from "unstorage/drivers/azure-storage-table";

const storage = createStorage({
  driver: azureStorageTableDriver({
    accountName: "myazurestorageaccount",
  }),
});

Authentication:

The driver supports the following authentication methods:

• DefaultAzureCredential: This is the recommended way to authenticate. It will use managed identity or environment variables to authenticate the request. It will also work in a local environment by trying to use Azure CLI or Azure PowerShell to authenticate.
  ⚠️ Make sure that your Managed Identity or personal account has the Storage Table Data Contributor role assigned to it, even if you already are Contributor or Owner on the storage account.
• AzureNamedKeyCredential (only available in Node.js runtime): This will use the accountName and accountKey to authenticate the request.
• AzureSASCredential: This will use the accountName and sasToken to authenticate the request.
• connection string (only available in Node.js runtime): This will use the connectionString to authenticate the request. This is not recommended as it will expose your account key in plain text.

Options:

• accountName (required): The name of your storage account.
• tableName: The name of the table to use. Defaults to unstorage.
• partitionKey: The partition key to use. Defaults to unstorage.
• accountKey: The account key to use for authentication. This is only required if you are using AzureNamedKeyCredential.