Azure Table storage is a service that stores structured NoSQL data in the cloud, providing a key/attribute store with a schemaless design. Sign into your Storage account to create, update, and query tables and more.
Status: Production |
Tier: Premium |
Version: 1.0.0 |
Name |
Summary |
GetTables ([advanced][Optional]string x-ms-client-request-id) |
List tables |
CreateTable (string TableName, [advanced][Optional]string x-ms-client-request-id) |
Create table |
GetTable (string tableName, [advanced][Optional]string x-ms-client-request-id) |
Get a table |
DeleteTable (string tableName, [advanced][Optional]string x-ms-client-request-id) |
Delete a table |
Get entities |
|
Insert Entity |
|
Get entity |
|
Insert or Replace Entity |
|
Insert or Merge Entity |
|
Replace Entity |
|
Delete Entity |
|
Merge Entity |
Name |
Summary |
Name |
Summary |
|
|
Get entities result |
|
An entity |
|
Table metadata |
|
|
|
Entity |
|
|
|
|
|
An entity |
|
|
|
|
Summary: List tables
Description: This operation lists the tables in the account.
Syntax:
AzureTableStorage.GetTables ([advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-client-request-id |
string (Client Request Id) |
Unique identifier for tracking the request. |
False |
Returns:
Type:getTablesResponse
Description: Table query response object
Summary: Create table
Description: This operation adds a table to the storage account.
Syntax:
AzureTableStorage.CreateTable (string TableName, [advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
TableName |
string
|
|
True |
|
x-ms-client-request-id |
string (Client Request Id) |
Unique identifier for tracking the request. |
False |
Returns:
Type:getTableResponse
Summary: Table metadata
Description: The metadata for the table
Summary: Get a table
Description: This operation gets the metadata of a table.
Syntax:
AzureTableStorage.GetTable (string tableName, [advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
x-ms-client-request-id |
string (Client Request Id) |
Unique identifier for tracking the request. |
False |
Returns:
Type:getTableResponse
Summary: Table metadata
Description: The metadata for the table
Summary: Delete a table
Description: Delete a table.
Syntax:
AzureTableStorage.DeleteTable (string tableName, [advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
x-ms-client-request-id |
string (Client Request Id) |
Unique identifier for tracking the request. |
False |
Returns:
Summary: Get entities
Description: This operation queries the entities in a table.
Syntax:
AzureTableStorage.GetEntities (string tableName, [internal][Optional]string NextPartitionKey, [internal][Optional]string NextRowKey, [advanced][Optional]string x-ms-client-request-id, [advanced][Optional]string $filter, [advanced][Optional]string $select)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
NextPartitionKey |
string (Partition Continuation Token) |
The next partition key returned for queries and read-feed operations if there are more results to be read. |
False |
|
NextRowKey |
string (Row Continuation Token) |
The next row key returned for queries and read-feed operations if there are more results to be read. |
False |
|
x-ms-client-request-id |
string (Client Request Id) |
Unique identifier for tracking the request. |
False |
|
$filter |
string (Filter Query) |
OData filter query for which entities to return. Example: Column eq 'Value' and Column2 ne 2. Invalid OData queries, such as not wrapping string values in quotes will return 501. |
False |
|
$select |
string (Select Query) |
OData select query for the columns to be returned. Example: Column, PartitionKey |
False |
Returns:
Type:getEntitiesResponse
Summary: Get entities result
Description: Entity Response Object
Summary: Insert Entity
Description: Operation to add an entity to a table.
Syntax:
AzureTableStorage.CreateEntity (string tableName, CreateEntityParameterEntity entity, [advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
entity |
|
|
True |
|
x-ms-client-request-id |
string (Client Request Id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
Returns:
Type:InsertEntityResponse
Summary: Entity
Description: Data for a single entity
Summary: Get entity
Description: This operation gets the entity in a table based on the partition and row key.
Syntax:
AzureTableStorage.GetEntity (string tableName, string PartitionKey, string RowKey, [advanced][Optional]string x-ms-client-request-id, [advanced][Optional]string $select)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
PartitionKey |
string (Partition Key) |
The partition id containing this entity |
True |
|
RowKey |
string (Row Key) |
The row id containing this entity |
True |
|
x-ms-client-request-id |
string (Client Request Id) |
Unique identifier for tracking the request. |
False |
|
$select |
string (Select Query) |
OData select query for the columns to be returned. Example: Column, PartitionKey |
False |
Returns:
Type:getEntityResponse
Summary: An entity
Description: An entity
Summary: Insert or Replace Entity
Description: Operation to replace an entity in a table, creating a new entity if needed.
Syntax:
AzureTableStorage.InsertReplaceEntity (string tableName, string PartitionKey, string RowKey, InsertReplaceEntityParameterEntity entity, [advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
PartitionKey |
string (Partition Key) |
The partition id containing this entity |
True |
|
RowKey |
string (Row Key) |
The row id containing this entity |
True |
|
entity |
InsertReplaceEntityParameterEntity
|
|
True |
|
x-ms-client-request-id |
string (Client Request Id) |
Unique identifier for tracking the request.. |
False |
Returns:
Summary: Insert or Merge Entity
Description: Operation to merge data with an entity in a table, creating a new entity if needed.
Syntax:
AzureTableStorage.InsertMergeEntity (string tableName, string PartitionKey, string RowKey, InsertMergeEntityParameterEntity entity, [advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
PartitionKey |
string (Partition Key) |
The partition id containing this entity |
True |
|
RowKey |
string (Row Key) |
The row id containing this entity |
True |
|
entity |
InsertMergeEntityParameterEntity
|
|
True |
|
x-ms-client-request-id |
string (Client Request Id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
Returns:
Summary: Replace Entity
Description: Operation to replace an entity in a table.
Syntax:
AzureTableStorage.ReplaceEntity (string tableName, string PartitionKey, string RowKey, string If-Match, ReplaceEntityParameterEntity entity, [advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
PartitionKey |
string (Partition Key) |
The partition id containing this entity |
True |
|
RowKey |
string (Row Key) |
The row id containing this entity |
True |
|
If-Match |
string (ETag) |
ETag to match for concurrency. * to match all values. |
True |
|
entity |
|
|
True |
|
x-ms-client-request-id |
string (Client Request Id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
Returns:
Summary: Delete Entity
Description: Operation to delete an entity.
Syntax:
AzureTableStorage.DeleteEntity (string tableName, string PartitionKey, string RowKey, [advanced][Optional]string x-ms-client-request-id, [Optional]string If-Match)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
PartitionKey |
string (Partition Key) |
The partition id containing this entity |
True |
|
RowKey |
string (Row Key) |
The row id containing this entity |
True |
|
x-ms-client-request-id |
string (Client Request Id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
|
If-Match |
string (ETag) |
Etag to match for concurrency. * to match all values. |
False |
Returns:
Summary: Merge Entity
Description: Operation to merge data with an entity in a table.
Syntax:
AzureTableStorage.MergeEntity (string tableName, string PartitionKey, string RowKey, MergeEntityParameterEntity entity, string If-Match, [advanced][Optional]string x-ms-client-request-id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tableName |
string (Table) |
Specify the table. |
True |
|
PartitionKey |
string (Partition Key) |
The partition id containing this entity |
True |
|
RowKey |
string (Row Key) |
The row id containing this entity |
True |
|
entity |
|
|
True |
|
If-Match |
string (ETag) |
Etag to match for concurrency. * to match all values. |
True |
|
x-ms-client-request-id |
string (Client Request Id) |
Unique identifier for tracking the request. |
False |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary: Get entities result
Description: Entity Response Object
Properties:
Name |
Type |
Summary |
odata.metadata |
string Table Metadata location |
Table Metadata location |
value |
array of (Item) List of Entities |
List of Entities |
Summary: An entity
Description: An entity
Properties:
Name |
Type |
Summary |
odata.metadata |
string Table Metadata location |
Table Metadata location |
PartitionKey |
string Partition Key |
Partition Key |
RowKey |
string Row Key |
Row Key |
additionalProperties |
string Entity data |
The unique columns for the entity |
Summary: Table metadata
Description: The metadata for the table
Properties:
Name |
Type |
Summary |
odata.id |
string Table location |
URL to the Table data |
TableName |
string Table Name |
Table Name |
Summary:
Description: Table query response object
Properties:
Name |
Type |
Summary |
odata.metadata |
string Account metadata location |
URL to the account metadata |
value |
array of (ValueItem) List of tables |
List of tables |
Summary: Table metadata
Description: The metadata for the table
Properties:
Name |
Type |
Summary |
odata.id |
string Table location |
URL to the Table data |
TableName |
string Table Name |
Table Name |
Summary: Entity
Description: Data for a single entity
Properties:
Name |
Type |
Summary |
odata.metadata |
string Entity Metadata location |
Entity Metadata location |
PartitionKey |
string Partition Key |
Partition Key |
RowKey |
string Row Key |
Row Key |
additionalProperties |
string Entity data |
The unique columns for the entity |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary: An entity
Description: An entity
Properties:
Name |
Type |
Summary |
PartitionKey |
string Partition Key |
Partition Key |
RowKey |
string Row Key |
Row Key |
additionalProperties |
string Entity data |
The unique columns for the entity |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |