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] = field(default_factory=dict)

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] = field(default=None, metadata={'wire_name': 'odata.metadata'})

Entity Metadata location

partition_key class-attribute instance-attribute

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

Partition Key

row_key class-attribute instance-attribute

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

Row Key

additional_properties class-attribute instance-attribute

additional_properties: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'odata.id'})

URL to the Table data

table_name class-attribute instance-attribute

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

Table Name

GetEntitiesResponse dataclass

GetEntitiesResponse(odata_metadata: Optional[str] = None, value: Optional[List[EntityItem]] = None)

Response for Get entities

Attributes

odata_metadata class-attribute instance-attribute

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

Table Metadata location

value class-attribute instance-attribute

value: Optional[List[EntityItem]] = None

List of Entities

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] = field(default=None, metadata={'wire_name': 'odata.metadata'})

Table Metadata location

partition_key class-attribute instance-attribute

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

Partition Key

row_key class-attribute instance-attribute

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

Row Key

additional_properties class-attribute instance-attribute

additional_properties: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'odata.metadata'})

URL to the account metadata

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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

StorageAccountList dataclass

StorageAccountList(value: Optional[List[StorageAccount]] = None)

Response for Get storage accounts

Attributes

value class-attribute instance-attribute

value: Optional[List[StorageAccount]] = None

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] = field(default=None, metadata={'wire_name': 'Name'})

The name of the storage account.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'PartitionKey'})

Partition Key

row_key class-attribute instance-attribute

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

Row Key

additional_properties class-attribute instance-attribute

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

Dynamic entity columns returned by the service.

AzuretablesClient

AzuretablesClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

create_entity_async async

create_entity_async(input: CreateEntityInput, storage_account_name: str, table_name: str) -> dict[str, Any] | None

Insert Entity

Operation to add an entity to a table.

create_table_async async

create_table_async(input: CreateTableInput, storage_account_name: str) -> dict[str, Any] | None

Create table

This operation adds a table to the storage account.

delete_entity_async async

delete_entity_async(storage_account_name: str, table_name: str, partition_key: str, row_key: str) -> None

Delete Entity

Operation to delete an entity.

delete_table_async async

delete_table_async(storage_account_name: str, table_name: str) -> None

Delete a table

Delete a table.

get_entities_async async

get_entities_async(storage_account_name: str, table_name: str, filter: Optional[str] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get entities

This operation queries the entities in a table.

get_entity_async async

get_entity_async(storage_account_name: str, table_name: str, partition_key: str, row_key: str, select: Optional[str] = None) -> dict[str, Any] | None

Get entity

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

get_table_async async

get_table_async(storage_account_name: str, table_name: str) -> dict[str, Any] | None

Get a table

This operation gets the metadata of a table.

get_tables_async async

get_tables_async(storage_account_name: str) -> dict[str, Any] | None

List tables

List all the tables for your storage account.

insert_merge_entity_async async

insert_merge_entity_async(input: InsertMergeEntityInput, storage_account_name: str, table_name: str, partition_key: str, row_key: str) -> None

Insert or Merge Entity

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

insert_replace_entity_async async

insert_replace_entity_async(input: InsertReplaceEntityInput, storage_account_name: str, table_name: str, partition_key: str, row_key: str) -> None

Insert or Replace Entity

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

merge_entity_async async

merge_entity_async(input: MergeEntityInput, storage_account_name: str, table_name: str, partition_key: str, row_key: str) -> None

Merge Entity

Operation to merge data with an entity in a table.

replace_entity_async async

replace_entity_async(input: ReplaceEntityInput, storage_account_name: str, table_name: str, partition_key: str, row_key: str) -> None

Replace Entity

Operation to replace an entity in a table.

get_storage_accounts_async async

get_storage_accounts_async() -> dict[str, Any] | None

Get storage accounts

This operation list the user's Azure Storage Account.