azure.mgmt.cosmosdb.operations module

begin_deallocate(resource_group_name: str, cluster_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

LROPoller[CommandOutput]

begin_invoke_command(resource_group_name: str, cluster_name: str, body: CommandPostBody | IO[bytes], **kwargs: Any) → LROPoller[CommandOutput][source]

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[bytes]) – Specification which command to run where. Is either a CommandPostBody type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either CommandOutput or the result of cls(response)

Return type:

Raises:

begin_start(resource_group_name: str, cluster_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

LROPoller[ClusterResource]

begin_update(resource_group_name: str, cluster_name: str, body: ClusterResource | IO[bytes], **kwargs: Any) → LROPoller[ClusterResource][source]

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[bytes]) – Parameters to provide for specifying the managed Cassandra cluster. Is either a ClusterResource type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ClusterResource or the result of cls(response)

Return type:

Raises:

get(resource_group_name: str, cluster_name: str, **kwargs: Any) → 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.

Returns:

ClusterResource or the result of cls(response)

Return type:

ClusterResource

Raises:

CassandraClusterPublicStatus

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[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.
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[ClusterResource][source]

List all managed Cassandra clusters in this subscription.

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) → 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.

Returns:

CassandraClusterPublicStatus or the result of cls(response)

Return type:

Raises:

LROPoller[DataCenterResource]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: DataCenterResource | IO[bytes], **kwargs: Any) → LROPoller[DataCenterResource][source]

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[bytes]) – Parameters specifying the managed Cassandra data center. Is either a DataCenterResource type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DataCenterResource or the result of cls(response)

Return type:

Raises:

begin_delete(resource_group_name: str, cluster_name: str, data_center_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

LROPoller[DataCenterResource]

begin_update(resource_group_name: str, cluster_name: str, data_center_name: str, body: DataCenterResource | IO[bytes], **kwargs: Any) → LROPoller[DataCenterResource][source]

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[bytes]) – Parameters to provide for specifying the managed Cassandra data center. Is either a DataCenterResource type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DataCenterResource or the result of cls(response)

Return type:

Raises:

get(resource_group_name: str, cluster_name: str, data_center_name: str, **kwargs: Any) → 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.

Returns:

DataCenterResource or the result of cls(response)

Return type:

DataCenterResource

Raises:

ItemPaged[DataCenterResource]

list(resource_group_name: str, cluster_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

LROPoller[CassandraKeyspaceGetResults]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: CassandraKeyspaceCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[CassandraKeyspaceGetResults][source]

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[bytes]) – The parameters to provide for the current Cassandra keyspace. Is either a CassandraKeyspaceCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either CassandraKeyspaceGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[CassandraTableGetResults]

begin_create_update_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, create_update_cassandra_table_parameters: CassandraTableCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[CassandraTableGetResults][source]

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[bytes]) – The parameters to provide for the current Cassandra Table. Is either a CassandraTableCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either CassandraTableGetResults or the result of cls(response)

Return type:

Raises:

begin_delete_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_migrate_cassandra_keyspace_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_cassandra_keyspace_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_cassandra_table_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_cassandra_table_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_update_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The RUs per second of the parameters to provide for the current Cassandra Keyspace. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_update_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The RUs per second of the parameters to provide for the current Cassandra table. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

CassandraKeyspaceGetResults

get_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → 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.

Returns:

CassandraKeyspaceGetResults or the result of cls(response)

Return type:

Raises:

get_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

CassandraTableGetResults

get_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → 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.

Returns:

CassandraTableGetResults or the result of cls(response)

Return type:

Raises:

get_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

ItemPaged[CassandraKeyspaceGetResults]

list_cassandra_keyspaces(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[CassandraTableGetResults]

list_cassandra_tables(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[MetricDefinition]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

list_metrics(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

list_usages(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

ItemPaged[Usage]

Raises:

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

ItemPaged[PartitionUsage]

list_usages(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, filter: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

LROPoller[DatabaseAccountGetResults]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: DatabaseAccountCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[DatabaseAccountGetResults][source]

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[bytes]) – The parameters to provide for the current database account. Is either a DatabaseAccountCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DatabaseAccountGetResults or the result of cls(response)

Return type:

Raises:

begin_delete(resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_failover_priority_change(resource_group_name: str, account_name: str, failover_parameters: FailoverPolicies | IO[bytes], **kwargs: Any) → LROPoller[None][source]

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[bytes]) – The new failover policies for the database account. Is either a FailoverPolicies type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_offline_region(resource_group_name: str, account_name: str, region_parameter_for_offline: RegionForOnlineOffline | IO[bytes], **kwargs: Any) → LROPoller[None][source]

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[bytes]) – Cosmos DB region to offline for the database account. Is either a RegionForOnlineOffline type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_online_region(resource_group_name: str, account_name: str, region_parameter_for_online: RegionForOnlineOffline | IO[bytes], **kwargs: Any) → LROPoller[None][source]

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[bytes]) – Cosmos DB region to online for the database account. Is either a RegionForOnlineOffline type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_regenerate_key(resource_group_name: str, account_name: str, key_to_regenerate: DatabaseAccountRegenerateKeyParameters | IO[bytes], **kwargs: Any) → LROPoller[None][source]

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[bytes]) – The name of the key to regenerate. Is either a DatabaseAccountRegenerateKeyParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

LROPoller[DatabaseAccountGetResults]

begin_update(resource_group_name: str, account_name: str, update_parameters: DatabaseAccountUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[DatabaseAccountGetResults][source]

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[bytes]) – The parameters to provide for the current database account. Is either a DatabaseAccountUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DatabaseAccountGetResults or the result of cls(response)

Return type:

Raises:

DatabaseAccountGetResults

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.
Returns:: bool or the result of cls(response)
Return type:: bool
Raises:: HttpResponseError –

get(resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

DatabaseAccountGetResults or the result of cls(response)

Return type:

Raises:

DatabaseAccountListReadOnlyKeysResult

get_read_only_keys(resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

DatabaseAccountListReadOnlyKeysResult or the result of cls(response)

Return type:

Raises:

DatabaseAccountListConnectionStringsResult

list(**kwargs: Any) → Iterable[DatabaseAccountGetResults][source]

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

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[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.
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) → 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.

Returns:

DatabaseAccountListConnectionStringsResult or the result of cls(response)

Return type:

Raises:

DatabaseAccountListKeysResult

list_keys(resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

DatabaseAccountListKeysResult or the result of cls(response)

Return type:

Raises:

ItemPaged[MetricDefinition]

list_metric_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

list_metrics(resource_group_name: str, account_name: str, filter: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

DatabaseAccountListReadOnlyKeysResult

list_read_only_keys(resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

DatabaseAccountListReadOnlyKeysResult or the result of cls(response)

Return type:

Raises:

list_usages(resource_group_name: str, account_name: str, filter: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

ItemPaged[Usage]

Raises:

ItemPaged[MetricDefinition]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

list_metrics(resource_group_name: str, account_name: str, database_rid: str, filter: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

list_usages(resource_group_name: str, account_name: str, database_rid: str, filter: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

ItemPaged[Usage]

Raises:

LROPoller[GremlinDatabaseGetResults]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: GremlinDatabaseCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[GremlinDatabaseGetResults][source]

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[bytes]) – The parameters to provide for the current Gremlin database. Is either a GremlinDatabaseCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either GremlinDatabaseGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[GremlinGraphGetResults]

begin_create_update_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, create_update_gremlin_graph_parameters: GremlinGraphCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[GremlinGraphGetResults][source]

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[bytes]) – The parameters to provide for the current Gremlin graph. Is either a GremlinGraphCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either GremlinGraphGetResults or the result of cls(response)

Return type:

Raises:

begin_delete_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_migrate_gremlin_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_gremlin_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_gremlin_graph_to_autoscale(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_gremlin_graph_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, graph_name: str, location: ContinuousBackupRestoreLocation | IO[bytes], **kwargs: Any) → LROPoller[BackupInformation][source]

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[bytes]) – The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either BackupInformation or the result of cls(response)

Return type:

Raises:

begin_update_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The RUs per second of the parameters to provide for the current Gremlin database. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_update_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The RUs per second of the parameters to provide for the current Gremlin graph. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

GremlinDatabaseGetResults

get_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

GremlinDatabaseGetResults or the result of cls(response)

Return type:

Raises:

get_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

get_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → 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.

Returns:

GremlinGraphGetResults or the result of cls(response)

Return type:

GremlinGraphGetResults

Raises:

get_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

ItemPaged[GremlinDatabaseGetResults]

list_gremlin_databases(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[GremlinGraphGetResults]

list_gremlin_graphs(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

LROPoller[MongoDBCollectionGetResults]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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) → 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.
Returns:: LocationGetResult or the result of cls(response)
Return type:: LocationGetResult
Raises:: HttpResponseError –

list(**kwargs: Any) → Iterable[LocationGetResult][source]

List Cosmos DB locations and their properties.

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.13/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: MongoDBCollectionCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[MongoDBCollectionGetResults][source]

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[bytes]) – The parameters to provide for the current MongoDB Collection. Is either a MongoDBCollectionCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either MongoDBCollectionGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[MongoDBDatabaseGetResults]

begin_create_update_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, create_update_mongo_db_database_parameters: MongoDBDatabaseCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[MongoDBDatabaseGetResults][source]

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[bytes]) – The parameters to provide for the current MongoDB database. Is either a MongoDBDatabaseCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either MongoDBDatabaseGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[MongoRoleDefinitionGetResults]

begin_create_update_mongo_role_definition(mongo_role_definition_id: str, resource_group_name: str, account_name: str, create_update_mongo_role_definition_parameters: MongoRoleDefinitionCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[MongoRoleDefinitionGetResults][source]

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[bytes]) – The properties required to create or update a Role Definition. Is either a MongoRoleDefinitionCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either MongoRoleDefinitionGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[MongoUserDefinitionGetResults]

begin_create_update_mongo_user_definition(mongo_user_definition_id: str, resource_group_name: str, account_name: str, create_update_mongo_user_definition_parameters: MongoUserDefinitionCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[MongoUserDefinitionGetResults][source]

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[bytes]) – The properties required to create or update a User Definition. Is either a MongoUserDefinitionCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either MongoUserDefinitionGetResults or the result of cls(response)

Return type:

Raises:

begin_delete_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_mongo_role_definition(mongo_role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_mongo_user_definition(mongo_user_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_migrate_mongo_db_collection_to_autoscale(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_mongo_db_collection_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_mongo_db_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_mongo_db_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, collection_name: str, location: ContinuousBackupRestoreLocation | IO[bytes], **kwargs: Any) → LROPoller[BackupInformation][source]

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[bytes]) – The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either BackupInformation or the result of cls(response)

Return type:

Raises:

begin_update_mongo_db_collection_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The RUs per second of the parameters to provide for the current MongoDB collection. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_update_mongo_db_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The RUs per second of the parameters to provide for the current MongoDB database. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

MongoDBCollectionGetResults

get_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → 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.

Returns:

MongoDBCollectionGetResults or the result of cls(response)

Return type:

Raises:

get_mongo_db_collection_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

MongoDBDatabaseGetResults

get_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

MongoDBDatabaseGetResults or the result of cls(response)

Return type:

Raises:

get_mongo_db_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

MongoRoleDefinitionGetResults

get_mongo_role_definition(mongo_role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

MongoRoleDefinitionGetResults or the result of cls(response)

Return type:

Raises:

MongoUserDefinitionGetResults

get_mongo_user_definition(mongo_user_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

MongoUserDefinitionGetResults or the result of cls(response)

Return type:

Raises:

ItemPaged[MongoDBCollectionGetResults]

list_mongo_db_collections(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[MongoDBDatabaseGetResults]

list_mongo_db_databases(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[MongoRoleDefinitionGetResults]

list_mongo_role_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[MongoUserDefinitionGetResults]

list_mongo_user_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

LROPoller[NotebookWorkspace]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | NotebookWorkspaceName, notebook_create_update_parameters: NotebookWorkspaceCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[NotebookWorkspace][source]

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[bytes]) – The notebook workspace to create for the current database account. Is either a NotebookWorkspaceCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either NotebookWorkspace or the result of cls(response)

Return type:

Raises:

begin_delete(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_regenerate_auth_token(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_start(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

get(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) → 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.

Returns:

NotebookWorkspace or the result of cls(response)

Return type:

NotebookWorkspace

Raises:

ItemPaged[NotebookWorkspace]

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

NotebookWorkspaceConnectionInfoResult

list_connection_info(resource_group_name: str, account_name: str, notebook_workspace_name: str | NotebookWorkspaceName, **kwargs: Any) → 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.

Returns:

NotebookWorkspaceConnectionInfoResult or the result of cls(response)

Return type:

Raises:

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[Operation][source]

Lists all of the available Cosmos DB Resource Provider operations.

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.13/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[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.

Returns:

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

Return type:

Raises:

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

ItemPaged[PercentileMetric]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

ItemPaged[PercentileMetric]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

ItemPaged[PercentileMetric]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

LROPoller[PrivateEndpointConnection]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: PrivateEndpointConnection | IO[bytes], **kwargs: Any) → LROPoller[PrivateEndpointConnection][source]

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[bytes]) – Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response)

Return type:

Raises:

begin_delete(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

PrivateEndpointConnection

get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → 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.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

Raises:

ItemPaged[PrivateEndpointConnection]

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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) → 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.

Returns:

PrivateLinkResource or the result of cls(response)

Return type:

PrivateLinkResource

Raises:

ItemPaged[PrivateLinkResource]

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

RestorableDatabaseAccountGetResult

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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) → 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.

Returns:

RestorableDatabaseAccountGetResult or the result of cls(response)

Return type:

Raises:

ItemPaged[RestorableGremlinDatabaseGetResult]

list(**kwargs: Any) → Iterable[RestorableDatabaseAccountGetResult][source]

Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires ‘Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read’ permission.

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[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.
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.13/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[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableGremlinGraphGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | None = None, start_time: str | None = None, end_time: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableGremlinResourcesGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | None = None, restore_timestamp_in_utc: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableMongodbCollectionGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | None = None, start_time: str | None = None, end_time: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableMongodbDatabaseGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableMongodbResourcesGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | None = None, restore_timestamp_in_utc: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableSqlContainerGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | None = None, start_time: str | None = None, end_time: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableSqlDatabaseGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableSqlResourcesGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | None = None, restore_timestamp_in_utc: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableTableResourcesGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | None = None, restore_timestamp_in_utc: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[RestorableTableGetResult]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: str | None = None, end_time: str | None = None, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

LROPoller[ServiceResource]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: ServiceResourceCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ServiceResource][source]

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[bytes]) – The Service resource parameters. Is either a ServiceResourceCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ServiceResource or the result of cls(response)

Return type:

Raises:

begin_delete(resource_group_name: str, account_name: str, service_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

get(resource_group_name: str, account_name: str, service_name: str, **kwargs: Any) → 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.

Returns:

ServiceResource or the result of cls(response)

Return type:

ServiceResource

Raises:

ItemPaged[ServiceResource]

list(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

LROPoller[ClientEncryptionKeyGetResults]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: ClientEncryptionKeyCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ClientEncryptionKeyGetResults][source]

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[bytes]) – The parameters to provide for the client encryption key. Is either a ClientEncryptionKeyCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ClientEncryptionKeyGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[SqlContainerGetResults]

begin_create_update_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, create_update_sql_container_parameters: SqlContainerCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[SqlContainerGetResults][source]

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[bytes]) – The parameters to provide for the current SQL container. Is either a SqlContainerCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either SqlContainerGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[SqlDatabaseGetResults]

begin_create_update_sql_database(resource_group_name: str, account_name: str, database_name: str, create_update_sql_database_parameters: SqlDatabaseCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[SqlDatabaseGetResults][source]

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[bytes]) – The parameters to provide for the current SQL database. Is either a SqlDatabaseCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either SqlDatabaseGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[SqlRoleAssignmentGetResults]

begin_create_update_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, create_update_sql_role_assignment_parameters: SqlRoleAssignmentCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[SqlRoleAssignmentGetResults][source]

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[bytes]) – The properties required to create or update a Role Assignment. Is either a SqlRoleAssignmentCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either SqlRoleAssignmentGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[SqlRoleDefinitionGetResults]

begin_create_update_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, create_update_sql_role_definition_parameters: SqlRoleDefinitionCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[SqlRoleDefinitionGetResults][source]

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[bytes]) – The properties required to create or update a Role Definition. Is either a SqlRoleDefinitionCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either SqlRoleDefinitionGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[SqlStoredProcedureGetResults]

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: SqlStoredProcedureCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[SqlStoredProcedureGetResults][source]

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[bytes]) – The parameters to provide for the current SQL storedProcedure. Is either a SqlStoredProcedureCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either SqlStoredProcedureGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[SqlTriggerGetResults]

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: SqlTriggerCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[SqlTriggerGetResults][source]

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[bytes]) – The parameters to provide for the current SQL trigger. Is either a SqlTriggerCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either SqlTriggerGetResults or the result of cls(response)

Return type:

Raises:

LROPoller[SqlUserDefinedFunctionGetResults]

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: SqlUserDefinedFunctionCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[SqlUserDefinedFunctionGetResults][source]

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[bytes]) – The parameters to provide for the current SQL userDefinedFunction. Is either a SqlUserDefinedFunctionCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either SqlUserDefinedFunctionGetResults or the result of cls(response)

Return type:

Raises:

begin_delete_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_delete_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

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) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_migrate_sql_container_to_autoscale(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_sql_container_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_sql_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_sql_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, container_name: str, location: ContinuousBackupRestoreLocation | IO[bytes], **kwargs: Any) → LROPoller[BackupInformation][source]

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[bytes]) – The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either BackupInformation or the result of cls(response)

Return type:

Raises:

begin_update_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The parameters to provide for the RUs per second of the current SQL container. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_update_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The parameters to provide for the RUs per second of the current SQL database. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

ClientEncryptionKeyGetResults

get_client_encryption_key(resource_group_name: str, account_name: str, database_name: str, client_encryption_key_name: str, **kwargs: Any) → 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.

Returns:

ClientEncryptionKeyGetResults or the result of cls(response)

Return type:

Raises:

get_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → 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.

Returns:

SqlContainerGetResults or the result of cls(response)

Return type:

SqlContainerGetResults

Raises:

get_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

get_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

SqlDatabaseGetResults or the result of cls(response)

Return type:

SqlDatabaseGetResults

Raises:

get_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

SqlRoleAssignmentGetResults

get_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

SqlRoleAssignmentGetResults or the result of cls(response)

Return type:

Raises:

SqlRoleDefinitionGetResults

get_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → 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.

Returns:

SqlRoleDefinitionGetResults or the result of cls(response)

Return type:

Raises:

SqlStoredProcedureGetResults

get_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) → 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.

Returns:

SqlStoredProcedureGetResults or the result of cls(response)

Return type:

Raises:

get_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) → 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.

Returns:

SqlTriggerGetResults or the result of cls(response)

Return type:

SqlTriggerGetResults

Raises:

SqlUserDefinedFunctionGetResults

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) → 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.

Returns:

SqlUserDefinedFunctionGetResults or the result of cls(response)

Return type:

Raises:

ItemPaged[ClientEncryptionKeyGetResults]

list_client_encryption_keys(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[SqlContainerGetResults]

list_sql_containers(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[SqlDatabaseGetResults]

list_sql_databases(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[SqlRoleAssignmentGetResults]

list_sql_role_assignments(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[SqlRoleDefinitionGetResults]

list_sql_role_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[SqlStoredProcedureGetResults]

list_sql_stored_procedures(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[SqlTriggerGetResults]

list_sql_triggers(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

ItemPaged[SqlUserDefinedFunctionGetResults]

list_sql_user_defined_functions(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises:

LROPoller[TableGetResults]

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.13/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: TableCreateUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[TableGetResults][source]

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[bytes]) – The parameters to provide for the current Table. Is either a TableCreateUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either TableGetResults or the result of cls(response)

Return type:

Raises:

begin_delete_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → 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.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

begin_migrate_table_to_autoscale(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_migrate_table_to_manual_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → LROPoller[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.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, table_name: str, location: ContinuousBackupRestoreLocation | IO[bytes], **kwargs: Any) → LROPoller[BackupInformation][source]

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[bytes]) – The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either BackupInformation or the result of cls(response)

Return type:

Raises:

begin_update_table_throughput(resource_group_name: str, account_name: str, table_name: str, update_throughput_parameters: ThroughputSettingsUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[ThroughputSettingsGetResults][source]

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[bytes]) – The parameters to provide for the RUs per second of the current Table. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

get_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → 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.

Returns:

TableGetResults or the result of cls(response)

Return type:

TableGetResults

Raises:

get_table_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → 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.

Returns:

ThroughputSettingsGetResults or the result of cls(response)

Return type:

Raises:

ItemPaged[TableGetResults]

list_tables(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[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.

Returns:

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

Return type:

Raises: