TableResourcesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:table_resources> attribute.

Inheritance

builtins.object

TableResourcesOperations

Constructor

TableResourcesOperations(*args, **kwargs)

Methods

begin_create_update_table	Create or update an Azure Cosmos DB Table.
begin_delete_table	Deletes an existing Azure Cosmos DB Table.
begin_migrate_table_to_autoscale	Migrate an Azure Cosmos DB Table from manual throughput to autoscale.
begin_migrate_table_to_manual_throughput	Migrate an Azure Cosmos DB Table from autoscale to manual throughput.
begin_retrieve_continuous_backup_information	Retrieves continuous backup information for a table.
begin_update_table_throughput	Update RUs per second of an Azure Cosmos DB Table.
get_table	Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
get_table_throughput	Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.
list_tables	Lists the Tables under an existing Azure Cosmos DB database account.

begin_create_update_table

Create or update an Azure Cosmos DB Table.

async begin_create_update_table(resource_group_name: str, account_name: str, table_name: str, create_update_table_parameters: _models.TableCreateUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.TableGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
table_name Required	str Cosmos DB table name. Required.
create_update_table_parameters Required	TableCreateUpdateParameters or IO[bytes] The parameters to provide for the current Table. Is either a TableCreateUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[TableGetResults]	An instance of AsyncLROPoller that returns either TableGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_table

Deletes an existing Azure Cosmos DB Table.

async begin_delete_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_table_to_autoscale

Migrate an Azure Cosmos DB Table from manual throughput to autoscale.

async begin_migrate_table_to_autoscale(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_table_to_manual_throughput

Migrate an Azure Cosmos DB Table from autoscale to manual throughput.

async begin_migrate_table_to_manual_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_retrieve_continuous_backup_information

Retrieves continuous backup information for a table.

async begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, table_name: str, location: _models.ContinuousBackupRestoreLocation, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BackupInformation]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
table_name Required	str Cosmos DB table name. Required.
location Required	ContinuousBackupRestoreLocation or IO[bytes] The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[BackupInformation]	An instance of AsyncLROPoller that returns either BackupInformation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_table_throughput

Update RUs per second of an Azure Cosmos DB Table.

async begin_update_table_throughput(resource_group_name: str, account_name: str, table_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
table_name Required	str Cosmos DB table name. Required.
update_throughput_parameters Required	ThroughputSettingsUpdateParameters or IO[bytes] The parameters to provide for the RUs per second of the current Table. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_table

Gets the Tables under an existing Azure Cosmos DB database account with the provided name.

async get_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> TableGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
TableGetResults	TableGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_table_throughput

Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.

async get_table_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> ThroughputSettingsGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
ThroughputSettingsGetResults	ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_tables

Lists the Tables under an existing Azure Cosmos DB database account.

list_tables(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[TableGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.

Returns

Type	Description
AsyncItemPaged[TableGetResults]	An iterator like instance of either TableGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>