AzuretablesClient

Attributes

CreateTableInput module-attribute

CreateTableInput = str

Classes

CreateEntityInput dataclass

CreateEntityInput(*, additional_properties: Dict[str, Any] = dict())

Insert Entity

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

InsertEntityResponse dataclass

InsertEntityResponse(*, odata_metadata: Optional[str] = None, partition_key: Optional[str] = None, row_key: Optional[str] = None, additional_properties: Optional[str] = None)

Response for Insert Entity

Attributes

odata_metadata class-attribute instance-attribute

odata_metadata: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'odata.metadata'})

Entity Metadata location

partition_key class-attribute instance-attribute

partition_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PartitionKey'})

Partition Key

row_key class-attribute instance-attribute

row_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowKey'})

Row Key

additional_properties class-attribute instance-attribute

additional_properties: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'additionalProperties'})

Dynamic entity columns returned by the service.

GetTableResponse dataclass

GetTableResponse(*, odata_id: Optional[str] = None, table_name: Optional[str] = None)

Response for Create table

Attributes

odata_id class-attribute instance-attribute

odata_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'odata.id'})

URL to the Table data

table_name class-attribute instance-attribute

table_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TableName'})

Table Name

GetEntitiesResponse dataclass

GetEntitiesResponse(*, odata_metadata: Optional[str] = None, value: Optional[List[EntityItem | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Get entities

Attributes

odata_metadata class-attribute instance-attribute

odata_metadata: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'odata.metadata'})

Table Metadata location

value class-attribute instance-attribute

value: Optional[List[EntityItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Entities

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to retrieve the next page.

GetEntityResponse dataclass

GetEntityResponse(*, odata_metadata: Optional[str] = None, partition_key: Optional[str] = None, row_key: Optional[str] = None, additional_properties: Optional[str] = None)

Response for Get entity

Attributes

odata_metadata class-attribute instance-attribute

odata_metadata: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'odata.metadata'})

Table Metadata location

partition_key class-attribute instance-attribute

partition_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PartitionKey'})

Partition Key

row_key class-attribute instance-attribute

row_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowKey'})

Row Key

additional_properties class-attribute instance-attribute

additional_properties: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'additionalProperties'})

Dynamic entity columns returned by the service.

GetTablesResponse dataclass

GetTablesResponse(*, odata_metadata: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List tables

Attributes

odata_metadata class-attribute instance-attribute

odata_metadata: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'odata.metadata'})

URL to the account metadata

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of tables

InsertMergeEntityInput dataclass

InsertMergeEntityInput(*, additional_properties: Dict[str, Any] = dict())

Insert or Merge Entity

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

InsertReplaceEntityInput dataclass

InsertReplaceEntityInput(*, additional_properties: Dict[str, Any] = dict())

Insert or Replace Entity

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

MergeEntityInput dataclass

MergeEntityInput(*, additional_properties: Dict[str, Any] = dict())

Merge Entity

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ReplaceEntityInput dataclass

ReplaceEntityInput(*, additional_properties: Dict[str, Any] = dict())

Replace Entity

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

StorageAccountList dataclass

StorageAccountList(*, value: Optional[List[StorageAccount | Mapping[str, Any]]] = None)

Response for Get storage accounts

Attributes

value class-attribute instance-attribute

value: Optional[List[StorageAccount | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of storage account names

StorageAccount dataclass

StorageAccount(*, name: Optional[str] = None, display_name: Optional[str] = None)

Definition: StorageAccount

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the storage account.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name of the storage account.

EntityItem dataclass

EntityItem(*, partition_key: Optional[str] = None, row_key: Optional[str] = None, additional_properties: Optional[str] = None)

Definition: Item

Attributes

partition_key class-attribute instance-attribute

partition_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PartitionKey'})

Partition Key

row_key class-attribute instance-attribute

row_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RowKey'})

Row Key

additional_properties class-attribute instance-attribute

additional_properties: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'additionalProperties'})

Dynamic entity columns returned by the service.

AzuretablesClient

AzuretablesClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for azuretables connector.

Initialize a AzuretablesClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

create_entity async

create_entity(input: CreateEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Insert Entity

Operation to add an entity to a table.

Swagger operation ID: CreateEntity_V2.

Parameters:

Name	Type	Description	Default
input	CreateEntityInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_table async

create_table(input: CreateTableInput, storage_account_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create table

This operation adds a table to the storage account.

Swagger operation ID: CreateTable_V2.

Parameters:

Name	Type	Description	Default
input	CreateTableInput	The request body.	required
storage_account_name	str	Azure Storage account name or table endpoint.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_entity async

delete_entity(storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete Entity

Operation to delete an entity.

Swagger operation ID: DeleteEntity_V2.

Parameters:

Name	Type	Description	Default
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
partition_key	str	The partition id containing this entity.	required
row_key	str	The row id containing this entity.	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_table async

delete_table(storage_account_name: str, table_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a table

Delete a table.

Swagger operation ID: DeleteTable_V2.

Parameters:

Name	Type	Description	Default
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_entities

list_entities(storage_account_name: str, table_name: str, *, filter: Optional[str] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get entities

This operation queries the entities in a table.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetEntities_V2.

Parameters:

Name	Type	Description	Default
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
filter	Optional[str]	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.	None
select	Optional[str]	OData select query for the columns to be returned. Example: Column, PartitionKey.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_entity async

get_entity(storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get entity

This operation gets the entity in a table based on the partition and row key.

Swagger operation ID: GetEntity_V2.

Parameters:

Name	Type	Description	Default
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
partition_key	str	The partition id containing this entity.	required
row_key	str	The row id containing this entity.	required
select	Optional[str]	OData select query for the columns to be returned. Example: Column, PartitionKey.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_table async

get_table(storage_account_name: str, table_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a table

This operation gets the metadata of a table.

Swagger operation ID: GetTable_V2.

Parameters:

Name	Type	Description	Default
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables

list_tables(storage_account_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List tables

List all the tables for your storage account.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTables_V2.

Parameters:

Name	Type	Description	Default
storage_account_name	str	Azure Storage account name or table endpoint.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

insert_merge_entity async

insert_merge_entity(input: InsertMergeEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Insert or Merge Entity

Operation to merge data with an entity in a table, creating a new entity if needed.

Swagger operation ID: InsertMergeEntity_V2.

Parameters:

Name	Type	Description	Default
input	InsertMergeEntityInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
partition_key	str	The partition id containing this entity.	required
row_key	str	The row id containing this entity.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

insert_replace_entity async

insert_replace_entity(input: InsertReplaceEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Insert or Replace Entity

Operation to replace an entity in a table, creating a new entity if needed.

Swagger operation ID: InsertReplaceEntity_V2.

Parameters:

Name	Type	Description	Default
input	InsertReplaceEntityInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
partition_key	str	The partition id containing this entity.	required
row_key	str	The row id containing this entity.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

merge_entity async

merge_entity(input: MergeEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Merge Entity

Operation to merge data with an entity in a table.

Swagger operation ID: MergeEntity_V2.

Parameters:

Name	Type	Description	Default
input	MergeEntityInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
partition_key	str	The partition id containing this entity.	required
row_key	str	The row id containing this entity.	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

replace_entity async

replace_entity(input: ReplaceEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Replace Entity

Operation to replace an entity in a table.

Swagger operation ID: ReplaceEntity_V2.

Parameters:

Name	Type	Description	Default
input	ReplaceEntityInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
storage_account_name	str	Azure Storage account name or table endpoint.	required
table_name	str	Specify the table.	required
partition_key	str	The partition id containing this entity.	required
row_key	str	The row id containing this entity.	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_storage_accounts

list_storage_accounts(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get storage accounts

This operation list the user's Azure Storage Account.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetStorageAccounts.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.