azure.mgmt.cosmosdb.operations module

class azure.mgmt.cosmosdb.operations.CassandraClustersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s cassandra_clusters attribute.

begin_create_update(resource_group_name: str, cluster_name: str, body: _models.ClusterResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ClusterResource][source]
begin_create_update(resource_group_name: str, cluster_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ClusterResource]

Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

  • body (ClusterResource or IO) – The properties specifying the desired state of the managed Cassandra cluster. Is either a ClusterResource type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ClusterResource or the result of cls(response)

Return type

LROPoller[ClusterResource]

Raises

HttpResponseError –

begin_deallocate(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won’t do anything on an already deallocated cluster. Use Start to restart the cluster.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes a managed Cassandra cluster.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_invoke_command(resource_group_name: str, cluster_name: str, body: _models.CommandPostBody, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CommandOutput][source]
begin_invoke_command(resource_group_name: str, cluster_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CommandOutput]

Invoke a command like nodetool for cassandra maintenance.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

  • body (CommandPostBody or IO) – Specification which command to run where. Is either a CommandPostBody type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 CommandOutput or the result of cls(response)

Return type

LROPoller[CommandOutput]

Raises

HttpResponseError –

begin_start(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won’t do anything on an already running cluster. Use Deallocate to deallocate the cluster.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, cluster_name: str, body: _models.ClusterResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ClusterResource][source]
begin_update(resource_group_name: str, cluster_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ClusterResource]

Updates some of the properties of a managed Cassandra cluster.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

  • body (ClusterResource or IO) – Parameters to provide for specifying the managed Cassandra cluster. Is either a ClusterResource type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ClusterResource or the result of cls(response)

Return type

LROPoller[ClusterResource]

Raises

HttpResponseError –

get(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ClusterResource[source]

Get the properties of a managed Cassandra cluster.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ClusterResource or the result of cls(response)

Return type

ClusterResource

Raises

HttpResponseError –

get_backup(resource_group_name: str, cluster_name: str, backup_id: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.BackupResource[source]

Get the properties of an individual backup of this cluster that is available to restore.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

  • backup_id (str) – Id of a restorable backup of a Cassandra cluster. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BackupResource or the result of cls(response)

Return type

BackupResource

Raises

HttpResponseError –

list_backups(resource_group_name: str, cluster_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.BackupResource][source]

List the backups of this cluster that are available to restore.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either BackupResource or the result of cls(response)

Return type

ItemPaged[BackupResource]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.ClusterResource][source]

List all managed Cassandra clusters in this resource group.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ClusterResource or the result of cls(response)

Return type

ItemPaged[ClusterResource]

Raises

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.ClusterResource][source]

List all managed Cassandra clusters in this subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ClusterResource or the result of cls(response)

Return type

ItemPaged[ClusterResource]

Raises

HttpResponseError –

status(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.CassandraClusterPublicStatus[source]

Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CassandraClusterPublicStatus or the result of cls(response)

Return type

CassandraClusterPublicStatus

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.CassandraDataCentersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s cassandra_data_centers attribute.

begin_create_update(resource_group_name: str, cluster_name: str, data_center_name: str, body: _models.DataCenterResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataCenterResource][source]
begin_create_update(resource_group_name: str, cluster_name: str, data_center_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataCenterResource]

Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

  • data_center_name (str) – Data center name in a managed Cassandra cluster. Required.

  • body (DataCenterResource or IO) – Parameters specifying the managed Cassandra data center. Is either a DataCenterResource type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 DataCenterResource or the result of cls(response)

Return type

LROPoller[DataCenterResource]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, cluster_name: str, data_center_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Delete a managed Cassandra data center.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

  • data_center_name (str) – Data center name in a managed Cassandra cluster. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, cluster_name: str, data_center_name: str, body: _models.DataCenterResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataCenterResource][source]
begin_update(resource_group_name: str, cluster_name: str, data_center_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataCenterResource]

Update some of the properties of a managed Cassandra data center.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

  • data_center_name (str) – Data center name in a managed Cassandra cluster. Required.

  • body (DataCenterResource or IO) – Parameters to provide for specifying the managed Cassandra data center. Is either a DataCenterResource type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 DataCenterResource or the result of cls(response)

Return type

LROPoller[DataCenterResource]

Raises

HttpResponseError –

get(resource_group_name: str, cluster_name: str, data_center_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DataCenterResource[source]

Get the properties of a managed Cassandra data center.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

  • data_center_name (str) – Data center name in a managed Cassandra cluster. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataCenterResource or the result of cls(response)

Return type

DataCenterResource

Raises

HttpResponseError –

list(resource_group_name: str, cluster_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.DataCenterResource][source]

List all data centers in a particular managed Cassandra cluster.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • cluster_name (str) – Managed Cassandra cluster name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataCenterResource or the result of cls(response)

Return type

ItemPaged[DataCenterResource]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.CassandraResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s cassandra_resources attribute.

begin_create_update_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, create_update_cassandra_keyspace_parameters: _models.CassandraKeyspaceCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CassandraKeyspaceGetResults][source]
begin_create_update_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, create_update_cassandra_keyspace_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CassandraKeyspaceGetResults]

Create or update an Azure Cosmos DB Cassandra keyspace.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • create_update_cassandra_keyspace_parameters (CassandraKeyspaceCreateUpdateParameters or IO) – The parameters to provide for the current Cassandra keyspace. Is either a CassandraKeyspaceCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 CassandraKeyspaceGetResults or the result of cls(response)

Return type

LROPoller[CassandraKeyspaceGetResults]

Raises

HttpResponseError –

begin_create_update_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, create_update_cassandra_table_parameters: _models.CassandraTableCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CassandraTableGetResults][source]
begin_create_update_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, create_update_cassandra_table_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CassandraTableGetResults]

Create or update an Azure Cosmos DB Cassandra Table.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • table_name (str) – Cosmos DB table name. Required.

  • create_update_cassandra_table_parameters (CassandraTableCreateUpdateParameters or IO) – The parameters to provide for the current Cassandra Table. Is either a CassandraTableCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 CassandraTableGetResults or the result of cls(response)

Return type

LROPoller[CassandraTableGetResults]

Raises

HttpResponseError –

begin_create_update_cassandra_view(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, create_update_cassandra_view_parameters: _models.CassandraViewCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CassandraViewGetResults][source]
begin_create_update_cassandra_view(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, create_update_cassandra_view_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CassandraViewGetResults]

Create or update an Azure Cosmos DB Cassandra View.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • view_name (str) – Cosmos DB view name. Required.

  • create_update_cassandra_view_parameters (CassandraViewCreateUpdateParameters or IO) – The parameters to provide for the current Cassandra View. Is either a CassandraViewCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 CassandraViewGetResults or the result of cls(response)

Return type

LROPoller[CassandraViewGetResults]

Raises

HttpResponseError –

begin_delete_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Cassandra keyspace.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Cassandra table.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_cassandra_view(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Cassandra view.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • view_name (str) – Cosmos DB view name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_migrate_cassandra_keyspace_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_cassandra_keyspace_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_cassandra_table_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_cassandra_table_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_cassandra_view_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • view_name (str) – Cosmos DB view name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_cassandra_view_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • view_name (str) – Cosmos DB view name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_update_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of an Azure Cosmos DB Cassandra Keyspace.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The RUs per second of the parameters to provide for the current Cassandra Keyspace. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_update_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of an Azure Cosmos DB Cassandra table.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • table_name (str) – Cosmos DB table name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The RUs per second of the parameters to provide for the current Cassandra table. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_update_cassandra_view_throughput(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_cassandra_view_throughput(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of an Azure Cosmos DB Cassandra view.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • view_name (str) – Cosmos DB view name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The RUs per second of the parameters to provide for the current Cassandra view. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

get_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.CassandraKeyspaceGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CassandraKeyspaceGetResults or the result of cls(response)

Return type

CassandraKeyspaceGetResults

Raises

HttpResponseError –

get_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

get_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.CassandraTableGetResults[source]

Gets the Cassandra table under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CassandraTableGetResults or the result of cls(response)

Return type

CassandraTableGetResults

Raises

HttpResponseError –

get_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

get_cassandra_view(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.CassandraViewGetResults[source]

Gets the Cassandra view under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • view_name (str) – Cosmos DB view name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CassandraViewGetResults or the result of cls(response)

Return type

CassandraViewGetResults

Raises

HttpResponseError –

get_cassandra_view_throughput(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

  • view_name (str) – Cosmos DB view name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

list_cassandra_keyspaces(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.CassandraKeyspaceGetResults][source]

Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CassandraKeyspaceGetResults or the result of cls(response)

Return type

ItemPaged[CassandraKeyspaceGetResults]

Raises

HttpResponseError –

list_cassandra_tables(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.CassandraTableGetResults][source]

Lists the Cassandra table under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CassandraTableGetResults or the result of cls(response)

Return type

ItemPaged[CassandraTableGetResults]

Raises

HttpResponseError –

list_cassandra_views(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.CassandraViewGetResults][source]

Lists the Cassandra materialized views under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • keyspace_name (str) – Cosmos DB keyspace name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CassandraViewGetResults or the result of cls(response)

Return type

ItemPaged[CassandraViewGetResults]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.CollectionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s collection attribute.

list_metric_definitions(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.MetricDefinition][source]

Retrieves metric definitions for the given collection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MetricDefinition or the result of cls(response)

Return type

ItemPaged[MetricDefinition]

Raises

HttpResponseError –

list_metrics(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Metric][source]

Retrieves the metrics determined by the given filter for the given database account and collection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Metric or the result of cls(response)

Return type

ItemPaged[Metric]

Raises

HttpResponseError –

list_usages(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Usage][source]

Retrieves the usages (most recent storage data) for the given collection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

  • filter (str) – An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Usage or the result of cls(response)

Return type

ItemPaged[Usage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.CollectionPartitionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s collection_partition attribute.

list_metrics(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PartitionMetric][source]

Retrieves the metrics determined by the given filter for the given collection, split by partition.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PartitionMetric or the result of cls(response)

Return type

ItemPaged[PartitionMetric]

Raises

HttpResponseError –

list_usages(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PartitionUsage][source]

Retrieves the usages (most recent storage data) for the given collection, split by partition.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

  • filter (str) – An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PartitionUsage or the result of cls(response)

Return type

ItemPaged[PartitionUsage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.CollectionPartitionRegionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s collection_partition_region attribute.

list_metrics(resource_group_name: str, account_name: str, region: str, database_rid: str, collection_rid: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PartitionMetric][source]

Retrieves the metrics determined by the given filter for the given collection and region, split by partition.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • region (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PartitionMetric or the result of cls(response)

Return type

ItemPaged[PartitionMetric]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.CollectionRegionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s collection_region attribute.

list_metrics(resource_group_name: str, account_name: str, region: str, database_rid: str, collection_rid: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Metric][source]

Retrieves the metrics determined by the given filter for the given database account, collection and region.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • region (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Metric or the result of cls(response)

Return type

ItemPaged[Metric]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.DataTransferJobsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s data_transfer_jobs attribute.

cancel(resource_group_name: str, account_name: str, job_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DataTransferJobGetResults[source]

Cancels a Data Transfer Job.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • job_name (str) – Name of the Data Transfer Job. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataTransferJobGetResults or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

HttpResponseError –

create(resource_group_name: str, account_name: str, job_name: str, job_create_parameters: _models.CreateJobRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataTransferJobGetResults[source]
create(resource_group_name: str, account_name: str, job_name: str, job_create_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataTransferJobGetResults

Creates a Data Transfer Job.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • job_name (str) – Name of the Data Transfer Job. Required.

  • job_create_parameters (CreateJobRequest or IO) – Is either a CreateJobRequest type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

DataTransferJobGetResults or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, job_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DataTransferJobGetResults[source]

Get a Data Transfer Job.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • job_name (str) – Name of the Data Transfer Job. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataTransferJobGetResults or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

HttpResponseError –

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.DataTransferJobGetResults][source]

Get a list of Data Transfer jobs.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataTransferJobGetResults or the result of cls(response)

Return type

ItemPaged[DataTransferJobGetResults]

Raises

HttpResponseError –

pause(resource_group_name: str, account_name: str, job_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DataTransferJobGetResults[source]

Pause a Data Transfer Job.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • job_name (str) – Name of the Data Transfer Job. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataTransferJobGetResults or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

HttpResponseError –

resume(resource_group_name: str, account_name: str, job_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DataTransferJobGetResults[source]

Resumes a Data Transfer Job.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • job_name (str) – Name of the Data Transfer Job. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataTransferJobGetResults or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.DatabaseAccountRegionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s database_account_region attribute.

list_metrics(resource_group_name: str, account_name: str, region: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Metric][source]

Retrieves the metrics determined by the given filter for the given database account and region.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • region (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Metric or the result of cls(response)

Return type

ItemPaged[Metric]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.DatabaseAccountsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s database_accounts attribute.

begin_create_or_update(resource_group_name: str, account_name: str, create_update_parameters: _models.DatabaseAccountCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseAccountGetResults][source]
begin_create_or_update(resource_group_name: str, account_name: str, create_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseAccountGetResults]

Creates or updates an Azure Cosmos DB database account. The “Update” method is preferred when performing updates on an account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • create_update_parameters (DatabaseAccountCreateUpdateParameters or IO) – The parameters to provide for the current database account. Is either a DatabaseAccountCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 DatabaseAccountGetResults or the result of cls(response)

Return type

LROPoller[DatabaseAccountGetResults]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, account_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_failover_priority_change(resource_group_name: str, account_name: str, failover_parameters: _models.FailoverPolicies, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_failover_priority_change(resource_group_name: str, account_name: str, failover_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • failover_parameters (FailoverPolicies or IO) – The new failover policies for the database account. Is either a FailoverPolicies type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_offline_region(resource_group_name: str, account_name: str, region_parameter_for_offline: _models.RegionForOnlineOffline, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_offline_region(resource_group_name: str, account_name: str, region_parameter_for_offline: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Offline the specified region for the specified Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • region_parameter_for_offline (RegionForOnlineOffline or IO) – Cosmos DB region to offline for the database account. Is either a RegionForOnlineOffline type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_online_region(resource_group_name: str, account_name: str, region_parameter_for_online: _models.RegionForOnlineOffline, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_online_region(resource_group_name: str, account_name: str, region_parameter_for_online: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Online the specified region for the specified Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • region_parameter_for_online (RegionForOnlineOffline or IO) – Cosmos DB region to online for the database account. Is either a RegionForOnlineOffline type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_regenerate_key(resource_group_name: str, account_name: str, key_to_regenerate: _models.DatabaseAccountRegenerateKeyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_regenerate_key(resource_group_name: str, account_name: str, key_to_regenerate: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Regenerates an access key for the specified Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • key_to_regenerate (DatabaseAccountRegenerateKeyParameters or IO) – The name of the key to regenerate. Is either a DatabaseAccountRegenerateKeyParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, account_name: str, update_parameters: _models.DatabaseAccountUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseAccountGetResults][source]
begin_update(resource_group_name: str, account_name: str, update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DatabaseAccountGetResults]

Updates the properties of an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • update_parameters (DatabaseAccountUpdateParameters or IO) – The parameters to provide for the current database account. Is either a DatabaseAccountUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 DatabaseAccountGetResults or the result of cls(response)

Return type

LROPoller[DatabaseAccountGetResults]

Raises

HttpResponseError –

check_name_exists(account_name: str, **kwargs: Any) → bool[source]

Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the ‘-‘ character, and must be between 3 and 50 characters.

Parameters

account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountGetResults[source]

Retrieves the properties of an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseAccountGetResults or the result of cls(response)

Return type

DatabaseAccountGetResults

Raises

HttpResponseError –

get_read_only_keys(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountListReadOnlyKeysResult[source]

Lists the read-only access keys for the specified Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseAccountListReadOnlyKeysResult or the result of cls(response)

Return type

DatabaseAccountListReadOnlyKeysResult

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountGetResults][source]

Lists all the Azure Cosmos DB database accounts available under the subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseAccountGetResults or the result of cls(response)

Return type

ItemPaged[DatabaseAccountGetResults]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountGetResults][source]

Lists all the Azure Cosmos DB database accounts available under the given resource group.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseAccountGetResults or the result of cls(response)

Return type

ItemPaged[DatabaseAccountGetResults]

Raises

HttpResponseError –

list_connection_strings(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountListConnectionStringsResult[source]

Lists the connection strings for the specified Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseAccountListConnectionStringsResult or the result of cls(response)

Return type

DatabaseAccountListConnectionStringsResult

Raises

HttpResponseError –

list_keys(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountListKeysResult[source]

Lists the access keys for the specified Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseAccountListKeysResult or the result of cls(response)

Return type

DatabaseAccountListKeysResult

Raises

HttpResponseError –

list_metric_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.MetricDefinition][source]

Retrieves metric definitions for the given database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MetricDefinition or the result of cls(response)

Return type

ItemPaged[MetricDefinition]

Raises

HttpResponseError –

list_metrics(resource_group_name: str, account_name: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Metric][source]

Retrieves the metrics determined by the given filter for the given database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Metric or the result of cls(response)

Return type

ItemPaged[Metric]

Raises

HttpResponseError –

list_read_only_keys(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountListReadOnlyKeysResult[source]

Lists the read-only access keys for the specified Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseAccountListReadOnlyKeysResult or the result of cls(response)

Return type

DatabaseAccountListReadOnlyKeysResult

Raises

HttpResponseError –

list_usages(resource_group_name: str, account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Usage][source]

Retrieves the usages (most recent data) for the given database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • filter (str) – An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Usage or the result of cls(response)

Return type

ItemPaged[Usage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.DatabaseOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s database attribute.

list_metric_definitions(resource_group_name: str, account_name: str, database_rid: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.MetricDefinition][source]

Retrieves metric definitions for the given database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MetricDefinition or the result of cls(response)

Return type

ItemPaged[MetricDefinition]

Raises

HttpResponseError –

list_metrics(resource_group_name: str, account_name: str, database_rid: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Metric][source]

Retrieves the metrics determined by the given filter for the given database account and database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Metric or the result of cls(response)

Return type

ItemPaged[Metric]

Raises

HttpResponseError –

list_usages(resource_group_name: str, account_name: str, database_rid: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Usage][source]

Retrieves the usages (most recent data) for the given database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • filter (str) – An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Usage or the result of cls(response)

Return type

ItemPaged[Usage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.GraphResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s graph_resources attribute.

begin_create_update_graph(resource_group_name: str, account_name: str, graph_name: str, create_update_graph_parameters: _models.GraphResourceCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GraphResourceGetResults][source]
begin_create_update_graph(resource_group_name: str, account_name: str, graph_name: str, create_update_graph_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GraphResourceGetResults]

Create or update an Azure Cosmos DB Graph.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • graph_name (str) – Cosmos DB graph resource name. Required.

  • create_update_graph_parameters (GraphResourceCreateUpdateParameters or IO) – The parameters to provide for the current graph. Is either a GraphResourceCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 GraphResourceGetResults or the result of cls(response)

Return type

LROPoller[GraphResourceGetResults]

Raises

HttpResponseError –

begin_delete_graph_resource(resource_group_name: str, account_name: str, graph_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Graph Resource.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • graph_name (str) – Cosmos DB graph resource name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

get_graph(resource_group_name: str, account_name: str, graph_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.GraphResourceGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • graph_name (str) – Cosmos DB graph resource name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GraphResourceGetResults or the result of cls(response)

Return type

GraphResourceGetResults

Raises

HttpResponseError –

list_graphs(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.GraphResourceGetResults][source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GraphResourceGetResults or the result of cls(response)

Return type

ItemPaged[GraphResourceGetResults]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.GremlinResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s gremlin_resources attribute.

begin_create_update_gremlin_database(resource_group_name: str, account_name: str, database_name: str, create_update_gremlin_database_parameters: _models.GremlinDatabaseCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GremlinDatabaseGetResults][source]
begin_create_update_gremlin_database(resource_group_name: str, account_name: str, database_name: str, create_update_gremlin_database_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GremlinDatabaseGetResults]

Create or update an Azure Cosmos DB Gremlin database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • create_update_gremlin_database_parameters (GremlinDatabaseCreateUpdateParameters or IO) – The parameters to provide for the current Gremlin database. Is either a GremlinDatabaseCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 GremlinDatabaseGetResults or the result of cls(response)

Return type

LROPoller[GremlinDatabaseGetResults]

Raises

HttpResponseError –

begin_create_update_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, create_update_gremlin_graph_parameters: _models.GremlinGraphCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GremlinGraphGetResults][source]
begin_create_update_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, create_update_gremlin_graph_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GremlinGraphGetResults]

Create or update an Azure Cosmos DB Gremlin graph.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • graph_name (str) – Cosmos DB graph name. Required.

  • create_update_gremlin_graph_parameters (GremlinGraphCreateUpdateParameters or IO) – The parameters to provide for the current Gremlin graph. Is either a GremlinGraphCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 GremlinGraphGetResults or the result of cls(response)

Return type

LROPoller[GremlinGraphGetResults]

Raises

HttpResponseError –

begin_delete_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Gremlin database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Gremlin graph.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • graph_name (str) – Cosmos DB graph name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_migrate_gremlin_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_gremlin_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_gremlin_graph_to_autoscale(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • graph_name (str) – Cosmos DB graph name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_gremlin_graph_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • graph_name (str) – Cosmos DB graph name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, graph_name: str, location: _models.ContinuousBackupRestoreLocation, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupInformation][source]
begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, graph_name: str, location: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupInformation]

Retrieves continuous backup information for a gremlin graph.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • graph_name (str) – Cosmos DB graph name. Required.

  • location (ContinuousBackupRestoreLocation or IO) – The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 BackupInformation or the result of cls(response)

Return type

LROPoller[BackupInformation]

Raises

HttpResponseError –

begin_update_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of an Azure Cosmos DB Gremlin database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The RUs per second of the parameters to provide for the current Gremlin database. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_update_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of an Azure Cosmos DB Gremlin graph.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • graph_name (str) – Cosmos DB graph name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The RUs per second of the parameters to provide for the current Gremlin graph. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

get_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GremlinDatabaseGetResults or the result of cls(response)

Return type

GremlinDatabaseGetResults

Raises

HttpResponseError –

get_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

get_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.GremlinGraphGetResults[source]

Gets the Gremlin graph under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • graph_name (str) – Cosmos DB graph name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GremlinGraphGetResults or the result of cls(response)

Return type

GremlinGraphGetResults

Raises

HttpResponseError –

get_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • graph_name (str) – Cosmos DB graph name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

list_gremlin_databases(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseGetResults][source]

Lists the Gremlin databases under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GremlinDatabaseGetResults or the result of cls(response)

Return type

ItemPaged[GremlinDatabaseGetResults]

Raises

HttpResponseError –

list_gremlin_graphs(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.GremlinGraphGetResults][source]

Lists the Gremlin graph under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GremlinGraphGetResults or the result of cls(response)

Return type

ItemPaged[GremlinGraphGetResults]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.LocationsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s locations attribute.

get(location: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.LocationGetResult[source]

Get the properties of an existing Cosmos DB location.

Parameters

location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LocationGetResult or the result of cls(response)

Return type

LocationGetResult

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.LocationGetResult][source]

List Cosmos DB locations and their properties.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LocationGetResult or the result of cls(response)

Return type

ItemPaged[LocationGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.MongoDBResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s mongo_db_resources attribute.

begin_create_update_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, create_update_mongo_db_collection_parameters: _models.MongoDBCollectionCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.MongoDBCollectionGetResults][source]
begin_create_update_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, create_update_mongo_db_collection_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.MongoDBCollectionGetResults]

Create or update an Azure Cosmos DB MongoDB Collection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

  • create_update_mongo_db_collection_parameters (MongoDBCollectionCreateUpdateParameters or IO) – The parameters to provide for the current MongoDB Collection. Is either a MongoDBCollectionCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 MongoDBCollectionGetResults or the result of cls(response)

Return type

LROPoller[MongoDBCollectionGetResults]

Raises

HttpResponseError –

begin_create_update_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, create_update_mongo_db_database_parameters: _models.MongoDBDatabaseCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.MongoDBDatabaseGetResults][source]
begin_create_update_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, create_update_mongo_db_database_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.MongoDBDatabaseGetResults]

Create or updates Azure Cosmos DB MongoDB database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • create_update_mongo_db_database_parameters (MongoDBDatabaseCreateUpdateParameters or IO) – The parameters to provide for the current MongoDB database. Is either a MongoDBDatabaseCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 MongoDBDatabaseGetResults or the result of cls(response)

Return type

LROPoller[MongoDBDatabaseGetResults]

Raises

HttpResponseError –

begin_create_update_mongo_role_definition(mongo_role_definition_id: str, resource_group_name: str, account_name: str, create_update_mongo_role_definition_parameters: _models.MongoRoleDefinitionCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.MongoRoleDefinitionGetResults][source]
begin_create_update_mongo_role_definition(mongo_role_definition_id: str, resource_group_name: str, account_name: str, create_update_mongo_role_definition_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.MongoRoleDefinitionGetResults]

Creates or updates an Azure Cosmos DB Mongo Role Definition.

Parameters

  • mongo_role_definition_id (str) – The ID for the Role Definition {dbName.roleName}. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • create_update_mongo_role_definition_parameters (MongoRoleDefinitionCreateUpdateParameters or IO) – The properties required to create or update a Role Definition. Is either a MongoRoleDefinitionCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 MongoRoleDefinitionGetResults or the result of cls(response)

Return type

LROPoller[MongoRoleDefinitionGetResults]

Raises

HttpResponseError –

begin_create_update_mongo_user_definition(mongo_user_definition_id: str, resource_group_name: str, account_name: str, create_update_mongo_user_definition_parameters: _models.MongoUserDefinitionCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.MongoUserDefinitionGetResults][source]
begin_create_update_mongo_user_definition(mongo_user_definition_id: str, resource_group_name: str, account_name: str, create_update_mongo_user_definition_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.MongoUserDefinitionGetResults]

Creates or updates an Azure Cosmos DB Mongo User Definition.

Parameters

  • mongo_user_definition_id (str) – The ID for the User Definition {dbName.userName}. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • create_update_mongo_user_definition_parameters (MongoUserDefinitionCreateUpdateParameters or IO) – The properties required to create or update a User Definition. Is either a MongoUserDefinitionCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 MongoUserDefinitionGetResults or the result of cls(response)

Return type

LROPoller[MongoUserDefinitionGetResults]

Raises

HttpResponseError –

begin_delete_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB MongoDB Collection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB MongoDB database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_mongo_role_definition(mongo_role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Mongo Role Definition.

Parameters

  • mongo_role_definition_id (str) – The ID for the Role Definition {dbName.roleName}. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_mongo_user_definition(mongo_user_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Mongo User Definition.

Parameters

  • mongo_user_definition_id (str) – The ID for the User Definition {dbName.userName}. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_list_mongo_db_collection_partition_merge(resource_group_name: str, account_name: str, database_name: str, collection_name: str, merge_parameters: _models.MergeParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionStorageInfoCollection][source]
begin_list_mongo_db_collection_partition_merge(resource_group_name: str, account_name: str, database_name: str, collection_name: str, merge_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionStorageInfoCollection]

Merges the partitions of a MongoDB Collection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

  • merge_parameters (MergeParameters or IO) – The parameters for the merge operation. Is either a MergeParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionStorageInfoCollection or the result of cls(response)

Return type

LROPoller[PhysicalPartitionStorageInfoCollection]

Raises

HttpResponseError –

begin_migrate_mongo_db_collection_to_autoscale(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_mongo_db_collection_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_mongo_db_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_mongo_db_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_mongo_db_container_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, redistribute_throughput_parameters: _models.RedistributeThroughputParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult][source]
begin_mongo_db_container_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, redistribute_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult]

Redistribute throughput for an Azure Cosmos DB MongoDB container.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

  • redistribute_throughput_parameters (RedistributeThroughputParameters or IO) – The parameters to provide for redistributing throughput for the current MongoDB container. Is either a RedistributeThroughputParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionThroughputInfoResult or the result of cls(response)

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

HttpResponseError –

begin_mongo_db_container_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, collection_name: str, retrieve_throughput_parameters: _models.RetrieveThroughputParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult][source]
begin_mongo_db_container_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, collection_name: str, retrieve_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult]

Retrieve throughput distribution for an Azure Cosmos DB MongoDB container.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

  • retrieve_throughput_parameters (RetrieveThroughputParameters or IO) – The parameters to provide for retrieving throughput distribution for the current MongoDB container. Is either a RetrieveThroughputParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionThroughputInfoResult or the result of cls(response)

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

HttpResponseError –

begin_mongo_db_database_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, redistribute_throughput_parameters: _models.RedistributeThroughputParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult][source]
begin_mongo_db_database_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, redistribute_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult]

Redistribute throughput for an Azure Cosmos DB MongoDB database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • redistribute_throughput_parameters (RedistributeThroughputParameters or IO) – The parameters to provide for redistributing throughput for the current MongoDB database. Is either a RedistributeThroughputParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionThroughputInfoResult or the result of cls(response)

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

HttpResponseError –

begin_mongo_db_database_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, retrieve_throughput_parameters: _models.RetrieveThroughputParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult][source]
begin_mongo_db_database_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, retrieve_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult]

Retrieve throughput distribution for an Azure Cosmos DB MongoDB database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • retrieve_throughput_parameters (RetrieveThroughputParameters or IO) – The parameters to provide for retrieving throughput distribution for the current MongoDB database. Is either a RetrieveThroughputParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionThroughputInfoResult or the result of cls(response)

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

HttpResponseError –

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, collection_name: str, location: _models.ContinuousBackupRestoreLocation, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupInformation][source]
begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, collection_name: str, location: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupInformation]

Retrieves continuous backup information for a Mongodb collection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

  • location (ContinuousBackupRestoreLocation or IO) – The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 BackupInformation or the result of cls(response)

Return type

LROPoller[BackupInformation]

Raises

HttpResponseError –

begin_update_mongo_db_collection_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_mongo_db_collection_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update the RUs per second of an Azure Cosmos DB MongoDB collection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The RUs per second of the parameters to provide for the current MongoDB collection. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_update_mongo_db_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_mongo_db_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of the an Azure Cosmos DB MongoDB database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The RUs per second of the parameters to provide for the current MongoDB database. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

get_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.MongoDBCollectionGetResults[source]

Gets the MongoDB collection under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

MongoDBCollectionGetResults or the result of cls(response)

Return type

MongoDBCollectionGetResults

Raises

HttpResponseError –

get_mongo_db_collection_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • collection_name (str) – Cosmos DB collection name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

get_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.MongoDBDatabaseGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

MongoDBDatabaseGetResults or the result of cls(response)

Return type

MongoDBDatabaseGetResults

Raises

HttpResponseError –

get_mongo_db_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

get_mongo_role_definition(mongo_role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.MongoRoleDefinitionGetResults[source]

Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.

Parameters

  • mongo_role_definition_id (str) – The ID for the Role Definition {dbName.roleName}. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

MongoRoleDefinitionGetResults or the result of cls(response)

Return type

MongoRoleDefinitionGetResults

Raises

HttpResponseError –

get_mongo_user_definition(mongo_user_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.MongoUserDefinitionGetResults[source]

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

Parameters

  • mongo_user_definition_id (str) – The ID for the User Definition {dbName.userName}. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

MongoUserDefinitionGetResults or the result of cls(response)

Return type

MongoUserDefinitionGetResults

Raises

HttpResponseError –

list_mongo_db_collections(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.MongoDBCollectionGetResults][source]

Lists the MongoDB collection under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MongoDBCollectionGetResults or the result of cls(response)

Return type

ItemPaged[MongoDBCollectionGetResults]

Raises

HttpResponseError –

list_mongo_db_databases(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.MongoDBDatabaseGetResults][source]

Lists the MongoDB databases under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MongoDBDatabaseGetResults or the result of cls(response)

Return type

ItemPaged[MongoDBDatabaseGetResults]

Raises

HttpResponseError –

list_mongo_role_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.MongoRoleDefinitionGetResults][source]

Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MongoRoleDefinitionGetResults or the result of cls(response)

Return type

ItemPaged[MongoRoleDefinitionGetResults]

Raises

HttpResponseError –

list_mongo_user_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.MongoUserDefinitionGetResults][source]

Retrieves the list of all Azure Cosmos DB Mongo User Definition.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MongoUserDefinitionGetResults or the result of cls(response)

Return type

ItemPaged[MongoUserDefinitionGetResults]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.NotebookWorkspacesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s notebook_workspaces attribute.

begin_create_or_update(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, _models.NotebookWorkspaceName], notebook_create_update_parameters: _models.NotebookWorkspaceCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NotebookWorkspace][source]
begin_create_or_update(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, _models.NotebookWorkspaceName], notebook_create_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NotebookWorkspace]

Creates the notebook workspace for a Cosmos DB account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource. “default” Required.

  • notebook_create_update_parameters (NotebookWorkspaceCreateUpdateParameters or IO) – The notebook workspace to create for the current database account. Is either a NotebookWorkspaceCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 NotebookWorkspace or the result of cls(response)

Return type

LROPoller[NotebookWorkspace]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes the notebook workspace for a Cosmos DB account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource. “default” Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_regenerate_auth_token(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Regenerates the auth token for the notebook workspace.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource. “default” Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_start(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Starts the notebook workspace.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource. “default” Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspace[source]

Gets the notebook workspace for a Cosmos DB account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource. “default” Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NotebookWorkspace or the result of cls(response)

Return type

NotebookWorkspace

Raises

HttpResponseError –

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspace][source]

Gets the notebook workspace resources of an existing Cosmos DB account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NotebookWorkspace or the result of cls(response)

Return type

ItemPaged[NotebookWorkspace]

Raises

HttpResponseError –

list_connection_info(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspaceConnectionInfoResult[source]

Retrieves the connection info for the notebook workspace.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource. “default” Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NotebookWorkspaceConnectionInfoResult or the result of cls(response)

Return type

NotebookWorkspaceConnectionInfoResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.Operation][source]

Lists all of the available Cosmos DB Resource Provider operations.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Operation or the result of cls(response)

Return type

ItemPaged[Operation]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.PartitionKeyRangeIdOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s partition_key_range_id attribute.

list_metrics(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, partition_key_range_id: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PartitionMetric][source]

Retrieves the metrics determined by the given filter for the given partition key range id.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

  • partition_key_range_id (str) – Partition Key Range Id for which to get data. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PartitionMetric or the result of cls(response)

Return type

ItemPaged[PartitionMetric]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.PartitionKeyRangeIdRegionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s partition_key_range_id_region attribute.

list_metrics(resource_group_name: str, account_name: str, region: str, database_rid: str, collection_rid: str, partition_key_range_id: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PartitionMetric][source]

Retrieves the metrics determined by the given filter for the given partition key range id and region.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • region (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • database_rid (str) – Cosmos DB database rid. Required.

  • collection_rid (str) – Cosmos DB collection rid. Required.

  • partition_key_range_id (str) – Partition Key Range Id for which to get data. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PartitionMetric or the result of cls(response)

Return type

ItemPaged[PartitionMetric]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.PercentileOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s percentile attribute.

list_metrics(resource_group_name: str, account_name: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PercentileMetric][source]

Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PercentileMetric or the result of cls(response)

Return type

ItemPaged[PercentileMetric]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.PercentileSourceTargetOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s percentile_source_target attribute.

list_metrics(resource_group_name: str, account_name: str, source_region: str, target_region: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PercentileMetric][source]

Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • source_region (str) – Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized. Required.

  • target_region (str) – Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PercentileMetric or the result of cls(response)

Return type

ItemPaged[PercentileMetric]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.PercentileTargetOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s percentile_target attribute.

list_metrics(resource_group_name: str, account_name: str, target_region: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PercentileMetric][source]

Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • target_region (str) – Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PercentileMetric or the result of cls(response)

Return type

ItemPaged[PercentileMetric]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s private_endpoint_connections attribute.

begin_create_or_update(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, parameters: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection][source]
begin_create_or_update(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

Approve or reject a private endpoint connection with a given name.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

  • parameters (PrivateEndpointConnection or IO) – Is either a PrivateEndpointConnection type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PrivateEndpointConnection or the result of cls(response)

Return type

LROPoller[PrivateEndpointConnection]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes a private endpoint connection with a given name.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection[source]

Gets a private endpoint connection.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnection or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

HttpResponseError –

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection][source]

List all private endpoint connections on a Cosmos DB account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateEndpointConnection or the result of cls(response)

Return type

ItemPaged[PrivateEndpointConnection]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s private_link_resources attribute.

get(resource_group_name: str, account_name: str, group_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.PrivateLinkResource[source]

Gets the private link resources that need to be created for a Cosmos DB account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • group_name (str) – The name of the private link resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResource or the result of cls(response)

Return type

PrivateLinkResource

Raises

HttpResponseError –

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.PrivateLinkResource][source]

Gets the private link resources that need to be created for a Cosmos DB account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateLinkResource or the result of cls(response)

Return type

ItemPaged[PrivateLinkResource]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableDatabaseAccountsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_database_accounts attribute.

get_by_location(location: str, instance_id: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.RestorableDatabaseAccountGetResult[source]

Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RestorableDatabaseAccountGetResult or the result of cls(response)

Return type

RestorableDatabaseAccountGetResult

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableDatabaseAccountGetResult][source]

Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read’ permission.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableDatabaseAccountGetResult or the result of cls(response)

Return type

ItemPaged[RestorableDatabaseAccountGetResult]

Raises

HttpResponseError –

list_by_location(location: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableDatabaseAccountGetResult][source]

Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read’ permission.

Parameters

location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableDatabaseAccountGetResult or the result of cls(response)

Return type

ItemPaged[RestorableDatabaseAccountGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableGremlinDatabasesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_gremlin_databases attribute.

list(location: str, instance_id: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableGremlinDatabaseGetResult][source]

Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableGremlinDatabaseGetResult or the result of cls(response)

Return type

ItemPaged[RestorableGremlinDatabaseGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableGremlinGraphsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_gremlin_graphs attribute.

list(location: str, instance_id: str, restorable_gremlin_database_rid: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableGremlinGraphGetResult][source]

Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin graphs under a specific database. This helps in scenario where container was accidentally deleted. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

  • restorable_gremlin_database_rid (str) – The resource ID of the Gremlin database. Default value is None.

  • start_time (str) – Restorable Gremlin graphs event feed start time. Default value is None.

  • end_time (str) – Restorable Gremlin graphs event feed end time. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableGremlinGraphGetResult or the result of cls(response)

Return type

ItemPaged[RestorableGremlinGraphGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableGremlinResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_gremlin_resources attribute.

list(location: str, instance_id: str, restore_location: Optional[str] = None, restore_timestamp_in_utc: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableGremlinResourcesGetResult][source]

Return a list of gremlin database and graphs combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

  • restore_location (str) – The location where the restorable resources are located. Default value is None.

  • restore_timestamp_in_utc (str) – The timestamp when the restorable resources existed. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableGremlinResourcesGetResult or the result of cls(response)

Return type

ItemPaged[RestorableGremlinResourcesGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableMongodbCollectionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_mongodb_collections attribute.

list(location: str, instance_id: str, restorable_mongodb_database_rid: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableMongodbCollectionGetResult][source]

Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database. This helps in scenario where container was accidentally deleted. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

  • restorable_mongodb_database_rid (str) – The resource ID of the MongoDB database. Default value is None.

  • start_time (str) – Restorable MongoDB collections event feed start time. Default value is None.

  • end_time (str) – Restorable MongoDB collections event feed end time. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableMongodbCollectionGetResult or the result of cls(response)

Return type

ItemPaged[RestorableMongodbCollectionGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableMongodbDatabasesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_mongodb_databases attribute.

list(location: str, instance_id: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableMongodbDatabaseGetResult][source]

Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableMongodbDatabaseGetResult or the result of cls(response)

Return type

ItemPaged[RestorableMongodbDatabaseGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableMongodbResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_mongodb_resources attribute.

list(location: str, instance_id: str, restore_location: Optional[str] = None, restore_timestamp_in_utc: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableMongodbResourcesGetResult][source]

Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

  • restore_location (str) – The location where the restorable resources are located. Default value is None.

  • restore_timestamp_in_utc (str) – The timestamp when the restorable resources existed. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableMongodbResourcesGetResult or the result of cls(response)

Return type

ItemPaged[RestorableMongodbResourcesGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableSqlContainersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_sql_containers attribute.

list(location: str, instance_id: str, restorable_sql_database_rid: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlContainerGetResult][source]

Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a specific database. This helps in scenario where container was accidentally deleted. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

  • restorable_sql_database_rid (str) – The resource ID of the SQL database. Default value is None.

  • start_time (str) – Restorable Sql containers event feed start time. Default value is None.

  • end_time (str) – Restorable Sql containers event feed end time. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableSqlContainerGetResult or the result of cls(response)

Return type

ItemPaged[RestorableSqlContainerGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableSqlDatabasesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_sql_databases attribute.

list(location: str, instance_id: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlDatabaseGetResult][source]

Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableSqlDatabaseGetResult or the result of cls(response)

Return type

ItemPaged[RestorableSqlDatabaseGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableSqlResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_sql_resources attribute.

list(location: str, instance_id: str, restore_location: Optional[str] = None, restore_timestamp_in_utc: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlResourcesGetResult][source]

Return a list of database and container combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

  • restore_location (str) – The location where the restorable resources are located. Default value is None.

  • restore_timestamp_in_utc (str) – The timestamp when the restorable resources existed. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableSqlResourcesGetResult or the result of cls(response)

Return type

ItemPaged[RestorableSqlResourcesGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableTableResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_table_resources attribute.

list(location: str, instance_id: str, restore_location: Optional[str] = None, restore_timestamp_in_utc: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableTableResourcesGetResult][source]

Return a list of tables that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

  • restore_location (str) – The location where the restorable resources are located. Default value is None.

  • restore_timestamp_in_utc (str) – The timestamp when the restorable resources existed. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableTableResourcesGetResult or the result of cls(response)

Return type

ItemPaged[RestorableTableResourcesGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.RestorableTablesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s restorable_tables attribute.

list(location: str, instance_id: str, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableTableGetResult][source]

Show the event feed of all mutations done on all the Azure Cosmos DB Tables. This helps in scenario where table was accidentally deleted. This API requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/…/read’ permission.

Parameters

  • location (str) – Cosmos DB region, with spaces between words and each word capitalized. Required.

  • instance_id (str) – The instanceId GUID of a restorable database account. Required.

  • start_time (str) – Restorable Tables event feed start time. Default value is None.

  • end_time (str) – Restorable Tables event feed end time. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableTableGetResult or the result of cls(response)

Return type

ItemPaged[RestorableTableGetResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.ServiceOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s service attribute.

begin_create(resource_group_name: str, account_name: str, service_name: str, create_update_parameters: _models.ServiceResourceCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceResource][source]
begin_create(resource_group_name: str, account_name: str, service_name: str, create_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceResource]

Creates a service.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • service_name (str) – Cosmos DB service name. Required.

  • create_update_parameters (ServiceResourceCreateUpdateParameters or IO) – The Service resource parameters. Is either a ServiceResourceCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ServiceResource or the result of cls(response)

Return type

LROPoller[ServiceResource]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, account_name: str, service_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes service with the given serviceName.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • service_name (str) – Cosmos DB service name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, account_name: str, service_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ServiceResource[source]

Gets the status of service.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • service_name (str) – Cosmos DB service name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceResource or the result of cls(response)

Return type

ServiceResource

Raises

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.ServiceResource][source]

Gets the status of service.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServiceResource or the result of cls(response)

Return type

ItemPaged[ServiceResource]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.SqlResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s sql_resources attribute.

begin_create_update_client_encryption_key(resource_group_name: str, account_name: str, database_name: str, client_encryption_key_name: str, create_update_client_encryption_key_parameters: _models.ClientEncryptionKeyCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ClientEncryptionKeyGetResults][source]
begin_create_update_client_encryption_key(resource_group_name: str, account_name: str, database_name: str, client_encryption_key_name: str, create_update_client_encryption_key_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ClientEncryptionKeyGetResults]

Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • client_encryption_key_name (str) – Cosmos DB ClientEncryptionKey name. Required.

  • create_update_client_encryption_key_parameters (ClientEncryptionKeyCreateUpdateParameters or IO) – The parameters to provide for the client encryption key. Is either a ClientEncryptionKeyCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ClientEncryptionKeyGetResults or the result of cls(response)

Return type

LROPoller[ClientEncryptionKeyGetResults]

Raises

HttpResponseError –

begin_create_update_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, create_update_sql_container_parameters: _models.SqlContainerCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlContainerGetResults][source]
begin_create_update_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, create_update_sql_container_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlContainerGetResults]

Create or update an Azure Cosmos DB SQL container.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • create_update_sql_container_parameters (SqlContainerCreateUpdateParameters or IO) – The parameters to provide for the current SQL container. Is either a SqlContainerCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 SqlContainerGetResults or the result of cls(response)

Return type

LROPoller[SqlContainerGetResults]

Raises

HttpResponseError –

begin_create_update_sql_database(resource_group_name: str, account_name: str, database_name: str, create_update_sql_database_parameters: _models.SqlDatabaseCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlDatabaseGetResults][source]
begin_create_update_sql_database(resource_group_name: str, account_name: str, database_name: str, create_update_sql_database_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlDatabaseGetResults]

Create or update an Azure Cosmos DB SQL database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • create_update_sql_database_parameters (SqlDatabaseCreateUpdateParameters or IO) – The parameters to provide for the current SQL database. Is either a SqlDatabaseCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 SqlDatabaseGetResults or the result of cls(response)

Return type

LROPoller[SqlDatabaseGetResults]

Raises

HttpResponseError –

begin_create_update_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, create_update_sql_role_assignment_parameters: _models.SqlRoleAssignmentCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlRoleAssignmentGetResults][source]
begin_create_update_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, create_update_sql_role_assignment_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlRoleAssignmentGetResults]

Creates or updates an Azure Cosmos DB SQL Role Assignment.

Parameters

  • role_assignment_id (str) – The GUID for the Role Assignment. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • create_update_sql_role_assignment_parameters (SqlRoleAssignmentCreateUpdateParameters or IO) – The properties required to create or update a Role Assignment. Is either a SqlRoleAssignmentCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 SqlRoleAssignmentGetResults or the result of cls(response)

Return type

LROPoller[SqlRoleAssignmentGetResults]

Raises

HttpResponseError –

begin_create_update_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, create_update_sql_role_definition_parameters: _models.SqlRoleDefinitionCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlRoleDefinitionGetResults][source]
begin_create_update_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, create_update_sql_role_definition_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlRoleDefinitionGetResults]

Creates or updates an Azure Cosmos DB SQL Role Definition.

Parameters

  • role_definition_id (str) – The GUID for the Role Definition. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • create_update_sql_role_definition_parameters (SqlRoleDefinitionCreateUpdateParameters or IO) – The properties required to create or update a Role Definition. Is either a SqlRoleDefinitionCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 SqlRoleDefinitionGetResults or the result of cls(response)

Return type

LROPoller[SqlRoleDefinitionGetResults]

Raises

HttpResponseError –

begin_create_update_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, create_update_sql_stored_procedure_parameters: _models.SqlStoredProcedureCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlStoredProcedureGetResults][source]
begin_create_update_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, create_update_sql_stored_procedure_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlStoredProcedureGetResults]

Create or update an Azure Cosmos DB SQL storedProcedure.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • stored_procedure_name (str) – Cosmos DB storedProcedure name. Required.

  • create_update_sql_stored_procedure_parameters (SqlStoredProcedureCreateUpdateParameters or IO) – The parameters to provide for the current SQL storedProcedure. Is either a SqlStoredProcedureCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 SqlStoredProcedureGetResults or the result of cls(response)

Return type

LROPoller[SqlStoredProcedureGetResults]

Raises

HttpResponseError –

begin_create_update_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, create_update_sql_trigger_parameters: _models.SqlTriggerCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlTriggerGetResults][source]
begin_create_update_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, create_update_sql_trigger_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlTriggerGetResults]

Create or update an Azure Cosmos DB SQL trigger.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • trigger_name (str) – Cosmos DB trigger name. Required.

  • create_update_sql_trigger_parameters (SqlTriggerCreateUpdateParameters or IO) – The parameters to provide for the current SQL trigger. Is either a SqlTriggerCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 SqlTriggerGetResults or the result of cls(response)

Return type

LROPoller[SqlTriggerGetResults]

Raises

HttpResponseError –

begin_create_update_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, create_update_sql_user_defined_function_parameters: _models.SqlUserDefinedFunctionCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlUserDefinedFunctionGetResults][source]
begin_create_update_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, create_update_sql_user_defined_function_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SqlUserDefinedFunctionGetResults]

Create or update an Azure Cosmos DB SQL userDefinedFunction.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • user_defined_function_name (str) – Cosmos DB userDefinedFunction name. Required.

  • create_update_sql_user_defined_function_parameters (SqlUserDefinedFunctionCreateUpdateParameters or IO) – The parameters to provide for the current SQL userDefinedFunction. Is either a SqlUserDefinedFunctionCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 SqlUserDefinedFunctionGetResults or the result of cls(response)

Return type

LROPoller[SqlUserDefinedFunctionGetResults]

Raises

HttpResponseError –

begin_delete_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB SQL container.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB SQL database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB SQL Role Assignment.

Parameters

  • role_assignment_id (str) – The GUID for the Role Assignment. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB SQL Role Definition.

Parameters

  • role_definition_id (str) – The GUID for the Role Definition. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB SQL storedProcedure.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • stored_procedure_name (str) – Cosmos DB storedProcedure name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB SQL trigger.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • trigger_name (str) – Cosmos DB trigger name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_delete_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • user_defined_function_name (str) – Cosmos DB userDefinedFunction name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

begin_list_sql_container_partition_merge(resource_group_name: str, account_name: str, database_name: str, container_name: str, merge_parameters: _models.MergeParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionStorageInfoCollection][source]
begin_list_sql_container_partition_merge(resource_group_name: str, account_name: str, database_name: str, container_name: str, merge_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionStorageInfoCollection]

Merges the partitions of a SQL Container.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • merge_parameters (MergeParameters or IO) – The parameters for the merge operation. Is either a MergeParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionStorageInfoCollection or the result of cls(response)

Return type

LROPoller[PhysicalPartitionStorageInfoCollection]

Raises

HttpResponseError –

begin_migrate_sql_container_to_autoscale(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_sql_container_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_sql_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_migrate_sql_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults][source]

Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, container_name: str, location: _models.ContinuousBackupRestoreLocation, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupInformation][source]
begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, container_name: str, location: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupInformation]

Retrieves continuous backup information for a container resource.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • location (ContinuousBackupRestoreLocation or IO) – The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 BackupInformation or the result of cls(response)

Return type

LROPoller[BackupInformation]

Raises

HttpResponseError –

begin_sql_container_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, redistribute_throughput_parameters: _models.RedistributeThroughputParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult][source]
begin_sql_container_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, redistribute_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult]

Redistribute throughput for an Azure Cosmos DB SQL container.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • redistribute_throughput_parameters (RedistributeThroughputParameters or IO) – The parameters to provide for redistributing throughput for the current SQL container. Is either a RedistributeThroughputParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionThroughputInfoResult or the result of cls(response)

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

HttpResponseError –

begin_sql_container_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, container_name: str, retrieve_throughput_parameters: _models.RetrieveThroughputParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult][source]
begin_sql_container_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, container_name: str, retrieve_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult]

Retrieve throughput distribution for an Azure Cosmos DB SQL container.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • retrieve_throughput_parameters (RetrieveThroughputParameters or IO) – The parameters to provide for retrieving throughput distribution for the current SQL container. Is either a RetrieveThroughputParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionThroughputInfoResult or the result of cls(response)

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

HttpResponseError –

begin_sql_database_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, redistribute_throughput_parameters: _models.RedistributeThroughputParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult][source]
begin_sql_database_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, redistribute_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult]

Redistribute throughput for an Azure Cosmos DB SQL database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • redistribute_throughput_parameters (RedistributeThroughputParameters or IO) – The parameters to provide for redistributing throughput for the current SQL database. Is either a RedistributeThroughputParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionThroughputInfoResult or the result of cls(response)

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

HttpResponseError –

begin_sql_database_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, retrieve_throughput_parameters: _models.RetrieveThroughputParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult][source]
begin_sql_database_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, retrieve_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PhysicalPartitionThroughputInfoResult]

Retrieve throughput distribution for an Azure Cosmos DB SQL database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • retrieve_throughput_parameters (RetrieveThroughputParameters or IO) – The parameters to provide for retrieving throughput distribution for the current SQL database. Is either a RetrieveThroughputParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 PhysicalPartitionThroughputInfoResult or the result of cls(response)

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

HttpResponseError –

begin_update_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of an Azure Cosmos DB SQL container.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The parameters to provide for the RUs per second of the current SQL container. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

begin_update_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of an Azure Cosmos DB SQL database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The parameters to provide for the RUs per second of the current SQL database. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

get_client_encryption_key(resource_group_name: str, account_name: str, database_name: str, client_encryption_key_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ClientEncryptionKeyGetResults[source]

Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • client_encryption_key_name (str) – Cosmos DB ClientEncryptionKey name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ClientEncryptionKeyGetResults or the result of cls(response)

Return type

ClientEncryptionKeyGetResults

Raises

HttpResponseError –

get_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlContainerGetResults[source]

Gets the SQL container under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlContainerGetResults or the result of cls(response)

Return type

SqlContainerGetResults

Raises

HttpResponseError –

get_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

get_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlDatabaseGetResults or the result of cls(response)

Return type

SqlDatabaseGetResults

Raises

HttpResponseError –

get_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

get_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentGetResults[source]

Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.

Parameters

  • role_assignment_id (str) – The GUID for the Role Assignment. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlRoleAssignmentGetResults or the result of cls(response)

Return type

SqlRoleAssignmentGetResults

Raises

HttpResponseError –

get_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionGetResults[source]

Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.

Parameters

  • role_definition_id (str) – The GUID for the Role Definition. Required.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlRoleDefinitionGetResults or the result of cls(response)

Return type

SqlRoleDefinitionGetResults

Raises

HttpResponseError –

get_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureGetResults[source]

Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • stored_procedure_name (str) – Cosmos DB storedProcedure name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlStoredProcedureGetResults or the result of cls(response)

Return type

SqlStoredProcedureGetResults

Raises

HttpResponseError –

get_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlTriggerGetResults[source]

Gets the SQL trigger under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • trigger_name (str) – Cosmos DB trigger name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlTriggerGetResults or the result of cls(response)

Return type

SqlTriggerGetResults

Raises

HttpResponseError –

get_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionGetResults[source]

Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

  • user_defined_function_name (str) – Cosmos DB userDefinedFunction name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlUserDefinedFunctionGetResults or the result of cls(response)

Return type

SqlUserDefinedFunctionGetResults

Raises

HttpResponseError –

list_client_encryption_keys(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.ClientEncryptionKeyGetResults][source]

Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ClientEncryptionKeyGetResults or the result of cls(response)

Return type

ItemPaged[ClientEncryptionKeyGetResults]

Raises

HttpResponseError –

list_sql_containers(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlContainerGetResults][source]

Lists the SQL container under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlContainerGetResults or the result of cls(response)

Return type

ItemPaged[SqlContainerGetResults]

Raises

HttpResponseError –

list_sql_databases(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseGetResults][source]

Lists the SQL databases under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlDatabaseGetResults or the result of cls(response)

Return type

ItemPaged[SqlDatabaseGetResults]

Raises

HttpResponseError –

list_sql_role_assignments(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentGetResults][source]

Retrieves the list of all Azure Cosmos DB SQL Role Assignments.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlRoleAssignmentGetResults or the result of cls(response)

Return type

ItemPaged[SqlRoleAssignmentGetResults]

Raises

HttpResponseError –

list_sql_role_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionGetResults][source]

Retrieves the list of all Azure Cosmos DB SQL Role Definitions.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlRoleDefinitionGetResults or the result of cls(response)

Return type

ItemPaged[SqlRoleDefinitionGetResults]

Raises

HttpResponseError –

list_sql_stored_procedures(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureGetResults][source]

Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlStoredProcedureGetResults or the result of cls(response)

Return type

ItemPaged[SqlStoredProcedureGetResults]

Raises

HttpResponseError –

list_sql_triggers(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlTriggerGetResults][source]

Lists the SQL trigger under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlTriggerGetResults or the result of cls(response)

Return type

ItemPaged[SqlTriggerGetResults]

Raises

HttpResponseError –

list_sql_user_defined_functions(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionGetResults][source]

Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • database_name (str) – Cosmos DB database name. Required.

  • container_name (str) – Cosmos DB container name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlUserDefinedFunctionGetResults or the result of cls(response)

Return type

ItemPaged[SqlUserDefinedFunctionGetResults]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>
class azure.mgmt.cosmosdb.operations.TableResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CosmosDBManagementClient’s table_resources attribute.

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) → LROPoller[_models.TableGetResults][source]
begin_create_update_table(resource_group_name: str, account_name: str, table_name: str, create_update_table_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.TableGetResults]

Create or update an Azure Cosmos DB Table.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • table_name (str) – Cosmos DB table name. Required.

  • create_update_table_parameters (TableCreateUpdateParameters or IO) – The parameters to provide for the current Table. Is either a TableCreateUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[TableGetResults]

Raises

HttpResponseError –

begin_delete_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an existing Azure Cosmos DB Table.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

  • 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

LROPoller[None]

Raises

HttpResponseError –

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][source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

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][source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

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) → LROPoller[_models.BackupInformation][source]
begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, table_name: str, location: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupInformation]

Retrieves continuous backup information for a table.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • table_name (str) – Cosmos DB table name. Required.

  • location (ContinuousBackupRestoreLocation or IO) – The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 BackupInformation or the result of cls(response)

Return type

LROPoller[BackupInformation]

Raises

HttpResponseError –

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) → LROPoller[_models.ThroughputSettingsGetResults][source]
begin_update_table_throughput(resource_group_name: str, account_name: str, table_name: str, update_throughput_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ThroughputSettingsGetResults]

Update RUs per second of an Azure Cosmos DB Table.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • table_name (str) – Cosmos DB table name. Required.

  • update_throughput_parameters (ThroughputSettingsUpdateParameters or IO) – The parameters to provide for the RUs per second of the current Table. Is either a ThroughputSettingsUpdateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ThroughputSettingsGetResults]

Raises

HttpResponseError –

get_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.TableGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TableGetResults or the result of cls(response)

Return type

TableGetResults

Raises

HttpResponseError –

get_table_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

  • table_name (str) – Cosmos DB table name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

HttpResponseError –

list_tables(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.TableGetResults][source]

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

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • account_name (str) – Cosmos DB database account name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TableGetResults or the result of cls(response)

Return type

ItemPaged[TableGetResults]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>