The documentation you are viewing is for Dapr v1.8 which is an older version of Dapr. For up-to-date documentation, see the latest version.
Azure Table Storage
Component format
To setup Azure Tablestorage state store create a component of type state.azure.tablestorage
. See this guide on how to create and apply a state store configuration.
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
spec:
type: state.azure.tablestorage
version: v1
metadata:
- name: accountName
value: <REPLACE-WITH-ACCOUNT-NAME>
- name: accountKey
value: <REPLACE-WITH-ACCOUNT-KEY>
- name: tableName
value: <REPLACE-WITH-TABLE-NAME>
- name: cosmosDbMode
value: false
Warning
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.Spec metadata fields
Field | Required | Details | Example |
---|---|---|---|
accountName | Y | The storage account name | "mystorageaccount" . |
accountKey | Y | Primary or secondary storage key | "key" |
tableName | Y | The name of the table to be used for Dapr state. The table will be created for you if it doesn’t exist | "table" |
cosmosDbMode | N | If enabled, connects to Cosmos DB Table API instead of Azure Tables (Storage Accounts). Defaults to false . |
"false" |
serviceURL | N | The full storage service endpoint URL. Useful for Azure environments other than public cloud. | "https://mystorageaccount.table.core.windows.net/" |
skipCreateTable | N | Skips the check for and, if necessary, creation of the specified storage table. This is useful when using active directory authentication with minimal privileges. Defaults to false . |
"true" |
Azure Active Directory (Azure AD) authentication
The Azure Cosmos DB state store component supports authentication using all Azure Active Directory mechanisms. For further information and the relevant component metadata fields to provide depending on the choice of Azure AD authentication mechanism, see the docs for authenticating to Azure.
You can read additional information for setting up Cosmos DB with Azure AD authentication in the section below.
Option 1: Setup Azure Table Storage
Follow the instructions from the Azure documentation on how to create an Azure Storage Account.
If you wish to create a table for Dapr to use, you can do so beforehand. However, Table Storage state provider will create one for you automatically if it doesn’t exist, unless the skipCreateTable
option is enabled.
In order to setup Azure Table Storage as a state store, you will need the following properties:
- AccountName: The storage account name. For example: mystorageaccount.
- AccountKey: Primary or secondary storage key. Skip this if using Azure AD authentication.
- TableName: The name of the table to be used for Dapr state. The table will be created for you if it doesn’t exist, unless the
skipCreateTable
option is enabled. - cosmosDbMode: Set this to
false
to connect to Azure Tables.
Option 2: Setup Azure Cosmos DB Table API
Follow the instructions from the Azure documentation on creating a Cosmos DB account with Table API.
If you wish to create a table for Dapr to use, you can do so beforehand. However, Table Storage state provider will create one for you automatically if it doesn’t exist, unless the skipCreateTable
option is enabled.
In order to setup Azure Cosmos DB Table API as a state store, you will need the following properties:
- AccountName: The Cosmos DB account name. For example: mycosmosaccount.
- AccountKey: The Cosmos DB master key. Skip this if using Azure AD authentication.
- TableName: The name of the table to be used for Dapr state. The table will be created for you if it doesn’t exist, unless the
skipCreateTable
option is enabled. - cosmosDbMode: Set this to
true
to connect to Azure Tables.
Partitioning
The Azure Table Storage state store uses the key
property provided in the requests to the Dapr API to determine the row key
. Service Name is used for partition key
. This provides best performance, as each service type stores state in it’s own table partition.
This state store creates a column called Value
in the table storage and puts raw state inside it.
For example, the following operation coming from service called myservice
curl -X POST http://localhost:3500/v1.0/state \
-H "Content-Type: application/json"
-d '[
{
"key": "nihilus",
"value": "darth"
}
]'
will create the following record in a table:
PartitionKey | RowKey | Value |
---|---|---|
myservice | nihilus | darth |
Concurrency
Azure Table Storage state concurrency is achieved by using ETag
s according to the official documentation.
Related links
- Basic schema for a Dapr component
- Read this guide for instructions on configuring state store components
- State management building block
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.