TableResourcesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:table_resources> attribute.
- Inheritance
-
builtins.objectTableResourcesOperations
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_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.
begin_create_update_table(resource_group_name: str, account_name: str, table_name: str, create_update_table_parameters: azure.mgmt.cosmosdb.models._models_py3.TableCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.TableGetResults]Parameters
- create_update_table_parameters
- TableCreateUpdateParameters
The parameters to provide for the current Table.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either TableGetResults or the result of cls(response)
Return type
Exceptions
begin_delete_table
Deletes an existing Azure Cosmos DB Table.
begin_delete_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_migrate_table_to_autoscale
Migrate an Azure Cosmos DB Table from manual throughput to autoscale.
begin_migrate_table_to_autoscale(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
begin_migrate_table_to_manual_throughput
Migrate an Azure Cosmos DB Table from autoscale to manual throughput.
begin_migrate_table_to_manual_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
begin_update_table_throughput
Update RUs per second of an Azure Cosmos DB Table.
begin_update_table_throughput(resource_group_name: str, account_name: str, table_name: str, update_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- update_throughput_parameters
- ThroughputSettingsUpdateParameters
The parameters to provide for the RUs per second of the current Table.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
get_table
Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
get_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.TableGetResultsParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
TableGetResults, or the result of cls(response)
Return type
Exceptions
get_table_throughput
Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.
get_table_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResultsParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ThroughputSettingsGetResults, or the result of cls(response)
Return type
Exceptions
list_tables
Lists the Tables under an existing Azure Cosmos DB database account.
list_tables(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.TableListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either TableListResult or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>Feedback
Submit and view feedback for