azure.mgmt.cosmosdb.operations module

class azure.mgmt.cosmosdb.operations.CassandraClustersOperations(client, config, serializer, deserializer)

Bases: object

CassandraClustersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_update(resource_group_name: str, cluster_name: str, body: azure.mgmt.cosmosdb.models._models_py3.ClusterResource, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ClusterResource]

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

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

• body (ClusterResource) – The properties specifying the desired state of the managed Cassandra cluster.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ClusterResource]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

• cluster_name (str) – Managed Cassandra cluster name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes a managed Cassandra cluster.

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_invoke_command(resource_group_name: str, cluster_name: str, body: azure.mgmt.cosmosdb.models._models_py3.CommandPostBody, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.CommandOutput]

Invoke a command like nodetool for cassandra maintenance.

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

• body (CommandPostBody) – Specification which command to run where.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[CommandOutput]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

• cluster_name (str) – Managed Cassandra cluster name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, cluster_name: str, body: azure.mgmt.cosmosdb.models._models_py3.ClusterResource, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ClusterResource]

Updates some of the properties of a managed Cassandra cluster.

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

• body (ClusterResource) – Parameters to provide for specifying the managed Cassandra cluster.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ClusterResource]

Raises

~azure.core.exceptions.HttpResponseError

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

Get the properties of a managed Cassandra cluster.

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

Keyword Arguments

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

Returns

ClusterResource, or the result of cls(response)

Return type

ClusterResource

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

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

Keyword Arguments

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

Returns

BackupResource, or the result of cls(response)

Return type

BackupResource

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ListBackups]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ListClusters]

Raises

~azure.core.exceptions.HttpResponseError

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

List all managed Cassandra clusters in this subscription.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ListClusters]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

• cluster_name (str) – Managed Cassandra cluster name.

Keyword Arguments

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

Returns

CassandraClusterPublicStatus, or the result of cls(response)

Return type

CassandraClusterPublicStatus

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.CassandraDataCentersOperations(client, config, serializer, deserializer)

Bases: object

CassandraDataCentersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_update(resource_group_name: str, cluster_name: str, data_center_name: str, body: azure.mgmt.cosmosdb.models._models_py3.DataCenterResource, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.DataCenterResource]

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

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

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

• body (DataCenterResource) – Parameters specifying the managed Cassandra data center.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[DataCenterResource]

Raises

~azure.core.exceptions.HttpResponseError

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

Delete a managed Cassandra data center.

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

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

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, cluster_name: str, data_center_name: str, body: azure.mgmt.cosmosdb.models._models_py3.DataCenterResource, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.DataCenterResource]

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

Parameters

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

• cluster_name (str) – Managed Cassandra cluster name.

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

• body (DataCenterResource) – Parameters to provide for specifying the managed Cassandra data center.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[DataCenterResource]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

• cluster_name (str) – Managed Cassandra cluster name.

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

Keyword Arguments

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

Returns

DataCenterResource, or the result of cls(response)

Return type

DataCenterResource

Raises

~azure.core.exceptions.HttpResponseError

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

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.

• cluster_name (str) – Managed Cassandra cluster name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ListDataCenters]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.CassandraResourcesOperations(client, config, serializer, deserializer)

Bases: object

CassandraResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_update_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, create_update_cassandra_keyspace_parameters: azure.mgmt.cosmosdb.models._models_py3.CassandraKeyspaceCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.CassandraKeyspaceGetResults]

Create or update an Azure Cosmos DB Cassandra keyspace.

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• create_update_cassandra_keyspace_parameters (CassandraKeyspaceCreateUpdateParameters) – The parameters to provide for the current Cassandra keyspace.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[CassandraKeyspaceGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, create_update_cassandra_table_parameters: azure.mgmt.cosmosdb.models._models_py3.CassandraTableCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.CassandraTableGetResults]

Create or update an Azure Cosmos DB Cassandra Table.

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• table_name (str) – Cosmos DB table name.

• create_update_cassandra_table_parameters (CassandraTableCreateUpdateParameters) – The parameters to provide for the current Cassandra Table.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[CassandraTableGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_cassandra_view(resource_group_name: str, account_name: str, keyspace_name: str, view_name: str, create_update_cassandra_view_parameters: azure.mgmt.cosmosdb.models._models_py3.CassandraViewCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.CassandraViewGetResults]

Create or update an Azure Cosmos DB Cassandra View.

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• view_name (str) – Cosmos DB view name.

• create_update_cassandra_view_parameters (CassandraViewCreateUpdateParameters) – The parameters to provide for the current Cassandra View.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[CassandraViewGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB Cassandra keyspace.

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB Cassandra table.

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB Cassandra view.

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• view_name (str) – Cosmos DB view name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• view_name (str) – Cosmos DB view name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• view_name (str) – Cosmos DB view name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Cassandra Keyspace.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

• table_name (str) – Cosmos DB table name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Cassandra table.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• view_name (str) – Cosmos DB view name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Cassandra view.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

Returns

CassandraKeyspaceGetResults, or the result of cls(response)

Return type

CassandraKeyspaceGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

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

Returns

CassandraTableGetResults, or the result of cls(response)

Return type

CassandraTableGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• view_name (str) – Cosmos DB view name.

Keyword Arguments

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

Returns

CassandraViewGetResults, or the result of cls(response)

Return type

CassandraViewGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

• view_name (str) – Cosmos DB view name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CassandraKeyspaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CassandraTableListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CassandraViewListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.CollectionOperations(client, config, serializer, deserializer)

Bases: object

CollectionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Retrieves metric definitions for the given collection.

Parameters

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

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricDefinitionsListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.CollectionPartitionOperations(client, config, serializer, deserializer)

Bases: object

CollectionPartitionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PartitionMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PartitionUsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.CollectionPartitionRegionOperations(client, config, serializer, deserializer)

Bases: object

CollectionPartitionRegionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PartitionMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.CollectionRegionOperations(client, config, serializer, deserializer)

Bases: object

CollectionRegionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.DataTransferJobsOperations(client, config, serializer, deserializer)

Bases: object

DataTransferJobsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Cancels a Data Transfer Job.

Parameters

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

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

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

Keyword Arguments

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

Returns

DataTransferJobGetResults, or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

~azure.core.exceptions.HttpResponseError

create(resource_group_name: str, account_name: str, job_name: str, job_create_parameters: azure.mgmt.cosmosdb.models._models_py3.CreateJobRequest, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.DataTransferJobGetResults

Creates a Data Transfer Job.

Parameters

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

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

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

• job_create_parameters (CreateJobRequest) –

Keyword Arguments

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

Returns

DataTransferJobGetResults, or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

Get a Data Transfer Job.

Parameters

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

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

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

Keyword Arguments

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

Returns

DataTransferJobGetResults, or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

Get a list of Data Transfer jobs.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DataTransferJobFeedResults]

Raises

~azure.core.exceptions.HttpResponseError

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

Pause a Data Transfer Job.

Parameters

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

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

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

Keyword Arguments

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

Returns

DataTransferJobGetResults, or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

Resumes a Data Transfer Job.

Parameters

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

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

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

Keyword Arguments

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

Returns

DataTransferJobGetResults, or the result of cls(response)

Return type

DataTransferJobGetResults

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.DatabaseAccountRegionOperations(client, config, serializer, deserializer)

Bases: object

DatabaseAccountRegionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

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

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.DatabaseAccountsOperations(client, config, serializer, deserializer)

Bases: object

DatabaseAccountsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, account_name: str, create_update_parameters: azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountGetResults]

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

Parameters

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

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

• create_update_parameters (DatabaseAccountCreateUpdateParameters) – The parameters to provide for the current database account.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[DatabaseAccountGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB database account.

Parameters

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

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

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_failover_priority_change(resource_group_name: str, account_name: str, failover_parameters: azure.mgmt.cosmosdb.models._models_py3.FailoverPolicies, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

Parameters

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

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

• failover_parameters (FailoverPolicies) – The new failover policies for the database account.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_offline_region(resource_group_name: str, account_name: str, region_parameter_for_offline: azure.mgmt.cosmosdb.models._models_py3.RegionForOnlineOffline, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

Parameters

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

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

• region_parameter_for_offline (RegionForOnlineOffline) – Cosmos DB region to offline for the database account.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_online_region(resource_group_name: str, account_name: str, region_parameter_for_online: azure.mgmt.cosmosdb.models._models_py3.RegionForOnlineOffline, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

Parameters

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

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

• region_parameter_for_online (RegionForOnlineOffline) – Cosmos DB region to online for the database account.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_regenerate_key(resource_group_name: str, account_name: str, key_to_regenerate: azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountRegenerateKeyParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

Parameters

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

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

• key_to_regenerate (DatabaseAccountRegenerateKeyParameters) – The name of the key to regenerate.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, account_name: str, update_parameters: azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountGetResults]

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

Parameters

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

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

• update_parameters (DatabaseAccountUpdateParameters) – The parameters to provide for the current database account.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[DatabaseAccountGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

Keyword Arguments

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

Returns

bool, or the result of cls(response)

Return type

bool

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

DatabaseAccountGetResults, or the result of cls(response)

Return type

DatabaseAccountGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

DatabaseAccountListReadOnlyKeysResult, or the result of cls(response)

Return type

DatabaseAccountListReadOnlyKeysResult

Raises

~azure.core.exceptions.HttpResponseError

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseAccountsListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseAccountsListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

DatabaseAccountListConnectionStringsResult, or the result of cls(response)

Return type

DatabaseAccountListConnectionStringsResult

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

DatabaseAccountListKeysResult, or the result of cls(response)

Return type

DatabaseAccountListKeysResult

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieves metric definitions for the given database account.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricDefinitionsListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

DatabaseAccountListReadOnlyKeysResult, or the result of cls(response)

Return type

DatabaseAccountListReadOnlyKeysResult

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.DatabaseOperations(client, config, serializer, deserializer)

Bases: object

DatabaseOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Retrieves metric definitions for the given database.

Parameters

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

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

• database_rid (str) – Cosmos DB database rid.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricDefinitionsListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_rid (str) – Cosmos DB database rid.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_rid (str) – Cosmos DB database rid.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.GraphResourcesOperations(client, config, serializer, deserializer)

Bases: object

GraphResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_update_graph(resource_group_name: str, account_name: str, graph_name: str, create_update_graph_parameters: azure.mgmt.cosmosdb.models._models_py3.GraphResourceCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.GraphResourceGetResults]

Create or update an Azure Cosmos DB Graph.

Parameters

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

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

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

• create_update_graph_parameters (GraphResourceCreateUpdateParameters) – The parameters to provide for the current graph.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[GraphResourceGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB Graph Resource.

Parameters

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

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

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

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

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

Keyword Arguments

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

Returns

GraphResourceGetResults, or the result of cls(response)

Return type

GraphResourceGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GraphResourcesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.GremlinResourcesOperations(client, config, serializer, deserializer)

Bases: object

GremlinResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_update_gremlin_database(resource_group_name: str, account_name: str, database_name: str, create_update_gremlin_database_parameters: azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseGetResults]

Create or update an Azure Cosmos DB Gremlin database.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• create_update_gremlin_database_parameters (GremlinDatabaseCreateUpdateParameters) – The parameters to provide for the current Gremlin database.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[GremlinDatabaseGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, create_update_gremlin_graph_parameters: azure.mgmt.cosmosdb.models._models_py3.GremlinGraphCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.GremlinGraphGetResults]

Create or update an Azure Cosmos DB Gremlin graph.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• graph_name (str) – Cosmos DB graph name.

• create_update_gremlin_graph_parameters (GremlinGraphCreateUpdateParameters) – The parameters to provide for the current Gremlin graph.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[GremlinGraphGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB Gremlin database.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB Gremlin graph.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• graph_name (str) – Cosmos DB graph name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• graph_name (str) – Cosmos DB graph name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• graph_name (str) – Cosmos DB graph name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, graph_name: str, location: azure.mgmt.cosmosdb.models._models_py3.ContinuousBackupRestoreLocation, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.BackupInformation]

Retrieves continuous backup information for a gremlin graph.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• graph_name (str) – Cosmos DB graph name.

• location (ContinuousBackupRestoreLocation) – The name of the continuous backup restore location.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[BackupInformation]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Gremlin database.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• graph_name (str) – Cosmos DB graph name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Gremlin graph.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

GremlinDatabaseGetResults, or the result of cls(response)

Return type

GremlinDatabaseGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• graph_name (str) – Cosmos DB graph name.

Keyword Arguments

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

Returns

GremlinGraphGetResults, or the result of cls(response)

Return type

GremlinGraphGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• graph_name (str) – Cosmos DB graph name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GremlinDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GremlinGraphListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.LocationsOperations(client, config, serializer, deserializer)

Bases: object

LocationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Get the properties of an existing Cosmos DB location.

Parameters

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

Keyword Arguments

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

Returns

LocationGetResult, or the result of cls(response)

Return type

LocationGetResult

Raises

~azure.core.exceptions.HttpResponseError

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

List Cosmos DB locations and their properties.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LocationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.MongoDBResourcesOperations(client, config, serializer, deserializer)

Bases: object

MongoDBResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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: azure.mgmt.cosmosdb.models._models_py3.MongoDBCollectionCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.MongoDBCollectionGetResults]

Create or update an Azure Cosmos DB MongoDB Collection.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

• create_update_mongo_db_collection_parameters (MongoDBCollectionCreateUpdateParameters) – The parameters to provide for the current MongoDB Collection.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[MongoDBCollectionGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, create_update_mongo_db_database_parameters: azure.mgmt.cosmosdb.models._models_py3.MongoDBDatabaseCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.MongoDBDatabaseGetResults]

Create or updates Azure Cosmos DB MongoDB database.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• create_update_mongo_db_database_parameters (MongoDBDatabaseCreateUpdateParameters) – The parameters to provide for the current MongoDB database.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[MongoDBDatabaseGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_mongo_role_definition(mongo_role_definition_id: str, resource_group_name: str, account_name: str, create_update_mongo_role_definition_parameters: azure.mgmt.cosmosdb.models._models_py3.MongoRoleDefinitionCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.MongoRoleDefinitionGetResults]

Creates or updates an Azure Cosmos DB Mongo Role Definition.

Parameters

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

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

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

• create_update_mongo_role_definition_parameters (MongoRoleDefinitionCreateUpdateParameters) – The properties required to create or update a Role Definition.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[MongoRoleDefinitionGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_mongo_user_definition(mongo_user_definition_id: str, resource_group_name: str, account_name: str, create_update_mongo_user_definition_parameters: azure.mgmt.cosmosdb.models._models_py3.MongoUserDefinitionCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.MongoUserDefinitionGetResults]

Creates or updates an Azure Cosmos DB Mongo User Definition.

Parameters

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

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

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

• create_update_mongo_user_definition_parameters (MongoUserDefinitionCreateUpdateParameters) – The properties required to create or update a User Definition.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[MongoUserDefinitionGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB MongoDB Collection.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB MongoDB database.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB Mongo Role Definition.

Parameters

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

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

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

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB Mongo User Definition.

Parameters

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

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

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

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_list_mongo_db_collection_partition_merge(resource_group_name: str, account_name: str, database_name: str, collection_name: str, merge_parameters: azure.mgmt.cosmosdb.models._models_py3.MergeParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.PhysicalPartitionStorageInfoCollection]

Merges the partitions of a MongoDB Collection.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

• merge_parameters (MergeParameters) – The parameters for the merge operation.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PhysicalPartitionStorageInfoCollection]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_mongo_db_container_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, redistribute_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.RedistributeThroughputParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.PhysicalPartitionThroughputInfoResult]

Redistribute throughput for an Azure Cosmos DB MongoDB container.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

• redistribute_throughput_parameters (RedistributeThroughputParameters) – The parameters to provide for redistributing throughput for the current MongoDB container.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_mongo_db_container_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, collection_name: str, retrieve_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.RetrieveThroughputParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.PhysicalPartitionThroughputInfoResult]

Retrieve throughput distribution for an Azure Cosmos DB MongoDB container.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

• retrieve_throughput_parameters (RetrieveThroughputParameters) – The parameters to provide for retrieving throughput distribution for the current MongoDB container.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, collection_name: str, location: azure.mgmt.cosmosdb.models._models_py3.ContinuousBackupRestoreLocation, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.BackupInformation]

Retrieves continuous backup information for a Mongodb collection.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

• location (ContinuousBackupRestoreLocation) – The name of the continuous backup restore location.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[BackupInformation]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current MongoDB collection.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current MongoDB database.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

Keyword Arguments

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

Returns

MongoDBCollectionGetResults, or the result of cls(response)

Return type

MongoDBCollectionGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• collection_name (str) – Cosmos DB collection name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

MongoDBDatabaseGetResults, or the result of cls(response)

Return type

MongoDBDatabaseGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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}.

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

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

Keyword Arguments

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

Returns

MongoRoleDefinitionGetResults, or the result of cls(response)

Return type

MongoRoleDefinitionGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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}.

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

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

Keyword Arguments

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

Returns

MongoUserDefinitionGetResults, or the result of cls(response)

Return type

MongoUserDefinitionGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MongoDBCollectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MongoDBDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MongoRoleDefinitionListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MongoUserDefinitionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.NotebookWorkspacesOperations(client, config, serializer, deserializer)

Bases: object

NotebookWorkspacesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], notebook_create_update_parameters: azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspaceCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspace]

Creates the notebook workspace for a Cosmos DB account.

Parameters

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

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

• notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

• notebook_create_update_parameters (NotebookWorkspaceCreateUpdateParameters) – The notebook workspace to create for the current database account.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NotebookWorkspace]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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.

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

• notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_regenerate_auth_token(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Regenerates the auth token for the notebook workspace.

Parameters

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

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

• notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_start(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Starts the notebook workspace.

Parameters

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

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

• notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspace

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.

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

• notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

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

Returns

NotebookWorkspace, or the result of cls(response)

Return type

NotebookWorkspace

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NotebookWorkspaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_connection_info(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, azure.mgmt.cosmosdb.models._cosmos_db_management_client_enums.NotebookWorkspaceName], **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.NotebookWorkspaceConnectionInfoResult

Retrieves the connection info for the notebook workspace.

Parameters

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

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

• notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

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

Returns

NotebookWorkspaceConnectionInfoResult, or the result of cls(response)

Return type

NotebookWorkspaceConnectionInfoResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.Operations(client, config, serializer, deserializer)

Bases: object

Operations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Lists all of the available Cosmos DB Resource Provider operations.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[OperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.PartitionKeyRangeIdOperations(client, config, serializer, deserializer)

Bases: object

PartitionKeyRangeIdOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

• partition_key_range_id (str) – Partition Key Range Id for which to get data.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PartitionMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.PartitionKeyRangeIdRegionOperations(client, config, serializer, deserializer)

Bases: object

PartitionKeyRangeIdRegionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

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

• database_rid (str) – Cosmos DB database rid.

• collection_rid (str) – Cosmos DB collection rid.

• partition_key_range_id (str) – Partition Key Range Id for which to get data.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PartitionMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.PercentileOperations(client, config, serializer, deserializer)

Bases: object

PercentileOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PercentileMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.PercentileSourceTargetOperations(client, config, serializer, deserializer)

Bases: object

PercentileSourceTargetOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

• source_region (str) – Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized.

• target_region (str) – Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PercentileMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.PercentileTargetOperations(client, config, serializer, deserializer)

Bases: object

PercentileTargetOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

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.

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

• target_region (str) – Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized.

• 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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PercentileMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.PrivateEndpointConnectionsOperations(client, config, serializer, deserializer)

Bases: object

PrivateEndpointConnectionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection]

Approve or reject a private endpoint connection with a given name.

Parameters

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

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

• private_endpoint_connection_name (str) – The name of the private endpoint connection.

• parameters (PrivateEndpointConnection) –

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PrivateEndpointConnection]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• private_endpoint_connection_name (str) – The name of the private endpoint connection.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection

Gets a private endpoint connection.

Parameters

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

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

• private_endpoint_connection_name (str) – The name of the private endpoint connection.

Keyword Arguments

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

Returns

PrivateEndpointConnection, or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PrivateEndpointConnectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.PrivateLinkResourcesOperations(client, config, serializer, deserializer)

Bases: object

PrivateLinkResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, account_name: str, group_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.PrivateLinkResource

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.

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

• group_name (str) – The name of the private link resource.

Keyword Arguments

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

Returns

PrivateLinkResource, or the result of cls(response)

Return type

PrivateLinkResource

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PrivateLinkResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableDatabaseAccountsOperations(client, config, serializer, deserializer)

Bases: object

RestorableDatabaseAccountsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get_by_location(location: str, instance_id: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.RestorableDatabaseAccountGetResult

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

Keyword Arguments

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

Returns

RestorableDatabaseAccountGetResult, or the result of cls(response)

Return type

RestorableDatabaseAccountGetResult

Raises

~azure.core.exceptions.HttpResponseError

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableDatabaseAccountsListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_location(location: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableDatabaseAccountsListResult]

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableDatabaseAccountsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableGremlinDatabasesOperations(client, config, serializer, deserializer)

Bases: object

RestorableGremlinDatabasesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableGremlinDatabasesListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableGremlinDatabasesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableGremlinGraphsOperations(client, config, serializer, deserializer)

Bases: object

RestorableGremlinGraphsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, restorable_gremlin_database_rid: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableGremlinGraphsListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

• restorable_gremlin_database_rid (str) – The resource ID of the Gremlin database. Default value is None.

• start_time (str) – Restorable Gremlin graphs event feed start time. Default value is None.

• end_time (str) – Restorable Gremlin graphs event feed end time. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableGremlinGraphsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableGremlinResourcesOperations(client, config, serializer, deserializer)

Bases: object

RestorableGremlinResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, restore_location: Optional[str] = None, restore_timestamp_in_utc: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableGremlinResourcesListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

• restore_location (str) – The location where the restorable resources are located. Default value is None.

• restore_timestamp_in_utc (str) – The timestamp when the restorable resources existed. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableGremlinResourcesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableMongodbCollectionsOperations(client, config, serializer, deserializer)

Bases: object

RestorableMongodbCollectionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, restorable_mongodb_database_rid: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableMongodbCollectionsListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

• restorable_mongodb_database_rid (str) – The resource ID of the MongoDB database. Default value is None.

• start_time (str) – Restorable MongoDB collections event feed start time. Default value is None.

• end_time (str) – Restorable MongoDB collections event feed end time. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableMongodbCollectionsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableMongodbDatabasesOperations(client, config, serializer, deserializer)

Bases: object

RestorableMongodbDatabasesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableMongodbDatabasesListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableMongodbDatabasesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableMongodbResourcesOperations(client, config, serializer, deserializer)

Bases: object

RestorableMongodbResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, restore_location: Optional[str] = None, restore_timestamp_in_utc: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableMongodbResourcesListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

• restore_location (str) – The location where the restorable resources are located. Default value is None.

• restore_timestamp_in_utc (str) – The timestamp when the restorable resources existed. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableMongodbResourcesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableSqlContainersOperations(client, config, serializer, deserializer)

Bases: object

RestorableSqlContainersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, restorable_sql_database_rid: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlContainersListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

• restorable_sql_database_rid (str) – The resource ID of the SQL database. Default value is None.

• start_time (str) – Restorable Sql containers event feed start time. Default value is None.

• end_time (str) – Restorable Sql containers event feed end time. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableSqlContainersListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableSqlDatabasesOperations(client, config, serializer, deserializer)

Bases: object

RestorableSqlDatabasesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlDatabasesListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableSqlDatabasesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableSqlResourcesOperations(client, config, serializer, deserializer)

Bases: object

RestorableSqlResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, restore_location: Optional[str] = None, restore_timestamp_in_utc: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlResourcesListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

• restore_location (str) – The location where the restorable resources are located. Default value is None.

• restore_timestamp_in_utc (str) – The timestamp when the restorable resources existed. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableSqlResourcesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableTableResourcesOperations(client, config, serializer, deserializer)

Bases: object

RestorableTableResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, restore_location: Optional[str] = None, restore_timestamp_in_utc: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableTableResourcesListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

• restore_location (str) – The location where the restorable resources are located. Default value is None.

• restore_timestamp_in_utc (str) – The timestamp when the restorable resources existed. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableTableResourcesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.RestorableTablesOperations(client, config, serializer, deserializer)

Bases: object

RestorableTablesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(location: str, instance_id: str, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.RestorableTablesListResult]

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.

• instance_id (str) – The instanceId GUID of a restorable database account.

• start_time (str) – Restorable Tables event feed start time. Default value is None.

• end_time (str) – Restorable Tables event feed end time. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableTablesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.ServiceOperations(client, config, serializer, deserializer)

Bases: object

ServiceOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create(resource_group_name: str, account_name: str, service_name: str, create_update_parameters: azure.mgmt.cosmosdb.models._models_py3.ServiceResourceCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ServiceResource]

Creates a service.

Parameters

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

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

• service_name (str) – Cosmos DB service name.

• create_update_parameters (ServiceResourceCreateUpdateParameters) – The Service resource parameters.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ServiceResource]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes service with the given serviceName.

Parameters

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

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

• service_name (str) – Cosmos DB service name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, account_name: str, service_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ServiceResource

Gets the status of service.

Parameters

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

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

• service_name (str) – Cosmos DB service name.

Keyword Arguments

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

Returns

ServiceResource, or the result of cls(response)

Return type

ServiceResource

Raises

~azure.core.exceptions.HttpResponseError

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

Gets the status of service.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServiceResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.SqlResourcesOperations(client, config, serializer, deserializer)

Bases: object

SqlResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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: azure.mgmt.cosmosdb.models._models_py3.ClientEncryptionKeyCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ClientEncryptionKeyGetResults]

Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• client_encryption_key_name (str) – Cosmos DB ClientEncryptionKey name.

• create_update_client_encryption_key_parameters (ClientEncryptionKeyCreateUpdateParameters) – The parameters to provide for the client encryption key.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ClientEncryptionKeyGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, create_update_sql_container_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlContainerCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlContainerGetResults]

Create or update an Azure Cosmos DB SQL container.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• create_update_sql_container_parameters (SqlContainerCreateUpdateParameters) – The parameters to provide for the current SQL container.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SqlContainerGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_sql_database(resource_group_name: str, account_name: str, database_name: str, create_update_sql_database_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseGetResults]

Create or update an Azure Cosmos DB SQL database.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• create_update_sql_database_parameters (SqlDatabaseCreateUpdateParameters) – The parameters to provide for the current SQL database.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SqlDatabaseGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, create_update_sql_role_assignment_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentGetResults]

Creates or updates an Azure Cosmos DB SQL Role Assignment.

Parameters

• role_assignment_id (str) – The GUID for the Role Assignment.

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

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

• create_update_sql_role_assignment_parameters (SqlRoleAssignmentCreateUpdateParameters) – The properties required to create or update a Role Assignment.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SqlRoleAssignmentGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, create_update_sql_role_definition_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionGetResults]

Creates or updates an Azure Cosmos DB SQL Role Definition.

Parameters

• role_definition_id (str) – The GUID for the Role Definition.

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

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

• create_update_sql_role_definition_parameters (SqlRoleDefinitionCreateUpdateParameters) – The properties required to create or update a Role Definition.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SqlRoleDefinitionGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, create_update_sql_stored_procedure_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureGetResults]

Create or update an Azure Cosmos DB SQL storedProcedure.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• stored_procedure_name (str) – Cosmos DB storedProcedure name.

• create_update_sql_stored_procedure_parameters (SqlStoredProcedureCreateUpdateParameters) – The parameters to provide for the current SQL storedProcedure.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SqlStoredProcedureGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, create_update_sql_trigger_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlTriggerCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlTriggerGetResults]

Create or update an Azure Cosmos DB SQL trigger.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• trigger_name (str) – Cosmos DB trigger name.

• create_update_sql_trigger_parameters (SqlTriggerCreateUpdateParameters) – The parameters to provide for the current SQL trigger.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SqlTriggerGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_update_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, create_update_sql_user_defined_function_parameters: azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionGetResults]

Create or update an Azure Cosmos DB SQL userDefinedFunction.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• user_defined_function_name (str) – Cosmos DB userDefinedFunction name.

• create_update_sql_user_defined_function_parameters (SqlUserDefinedFunctionCreateUpdateParameters) – The parameters to provide for the current SQL userDefinedFunction.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SqlUserDefinedFunctionGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB SQL container.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB SQL database.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB SQL Role Assignment.

Parameters

• role_assignment_id (str) – The GUID for the Role Assignment.

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

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

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB SQL Role Definition.

Parameters

• role_definition_id (str) – The GUID for the Role Definition.

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

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

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB SQL storedProcedure.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• stored_procedure_name (str) – Cosmos DB storedProcedure name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB SQL trigger.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• trigger_name (str) – Cosmos DB trigger name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• user_defined_function_name (str) – Cosmos DB userDefinedFunction name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_list_sql_container_partition_merge(resource_group_name: str, account_name: str, database_name: str, container_name: str, merge_parameters: azure.mgmt.cosmosdb.models._models_py3.MergeParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.PhysicalPartitionStorageInfoCollection]

Merges the partitions of a SQL Container.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• merge_parameters (MergeParameters) – The parameters for the merge operation.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PhysicalPartitionStorageInfoCollection]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, container_name: str, location: azure.mgmt.cosmosdb.models._models_py3.ContinuousBackupRestoreLocation, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.BackupInformation]

Retrieves continuous backup information for a container resource.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• location (ContinuousBackupRestoreLocation) – The name of the continuous backup restore location.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[BackupInformation]

Raises

~azure.core.exceptions.HttpResponseError

begin_sql_container_redistribute_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, redistribute_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.RedistributeThroughputParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.PhysicalPartitionThroughputInfoResult]

Redistribute throughput for an Azure Cosmos DB SQL container.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• redistribute_throughput_parameters (RedistributeThroughputParameters) – The parameters to provide for redistributing throughput for the current SQL container.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_sql_container_retrieve_throughput_distribution(resource_group_name: str, account_name: str, database_name: str, container_name: str, retrieve_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.RetrieveThroughputParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.PhysicalPartitionThroughputInfoResult]

Retrieve throughput distribution for an Azure Cosmos DB SQL container.

Parameters

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

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• retrieve_throughput_parameters (RetrieveThroughputParameters) – The parameters to provide for retrieving throughput distribution for the current SQL container.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PhysicalPartitionThroughputInfoResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The parameters to provide for the RUs per second of the current SQL container.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The parameters to provide for the RUs per second of the current SQL database.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

get_client_encryption_key(resource_group_name: str, account_name: str, database_name: str, client_encryption_key_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ClientEncryptionKeyGetResults

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.

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

• database_name (str) – Cosmos DB database name.

• client_encryption_key_name (str) – Cosmos DB ClientEncryptionKey name.

Keyword Arguments

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

Returns

ClientEncryptionKeyGetResults, or the result of cls(response)

Return type

ClientEncryptionKeyGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlContainerGetResults

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

Keyword Arguments

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

Returns

SqlContainerGetResults, or the result of cls(response)

Return type

SqlContainerGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseGetResults

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

SqlDatabaseGetResults, or the result of cls(response)

Return type

SqlDatabaseGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_role_assignment(role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlRoleAssignmentGetResults

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.

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

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

Keyword Arguments

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

Returns

SqlRoleAssignmentGetResults, or the result of cls(response)

Return type

SqlRoleAssignmentGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_role_definition(role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlRoleDefinitionGetResults

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.

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

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

Keyword Arguments

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

Returns

SqlRoleDefinitionGetResults, or the result of cls(response)

Return type

SqlRoleDefinitionGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureGetResults

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• stored_procedure_name (str) – Cosmos DB storedProcedure name.

Keyword Arguments

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

Returns

SqlStoredProcedureGetResults, or the result of cls(response)

Return type

SqlStoredProcedureGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlTriggerGetResults

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• trigger_name (str) – Cosmos DB trigger name.

Keyword Arguments

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

Returns

SqlTriggerGetResults, or the result of cls(response)

Return type

SqlTriggerGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionGetResults

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

• user_defined_function_name (str) – Cosmos DB userDefinedFunction name.

Keyword Arguments

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

Returns

SqlUserDefinedFunctionGetResults, or the result of cls(response)

Return type

SqlUserDefinedFunctionGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ClientEncryptionKeysListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

• database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlContainerListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlRoleAssignmentListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

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.

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlRoleDefinitionListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_sql_stored_procedures(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureListResult]

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlStoredProcedureListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_sql_triggers(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlTriggerListResult]

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.

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

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlTriggerListResult or the result of cls(response)

Return type

ItemPaged[SqlTriggerListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_sql_user_defined_functions(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionListResult]

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.

• account_name (str) – Cosmos DB database account name.

• database_name (str) – Cosmos DB database name.

• container_name (str) – Cosmos DB container name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SqlUserDefinedFunctionListResult or the result of cls(response)

Return type

ItemPaged[SqlUserDefinedFunctionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>

class azure.mgmt.cosmosdb.operations.TableResourcesOperations(client, config, serializer, deserializer)

Bases: object

TableResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_update_table(resource_group_name: str, account_name: str, table_name: str, create_update_table_parameters: azure.mgmt.cosmosdb.models._models_py3.TableCreateUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.TableGetResults]

Create or update an Azure Cosmos DB Table.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• account_name (str) – Cosmos DB database account name.

• table_name (str) – Cosmos DB table name.

• create_update_table_parameters (TableCreateUpdateParameters) – The parameters to provide for the current Table.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either TableGetResults or the result of cls(response)

Return type

LROPoller[TableGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes an existing Azure Cosmos DB Table.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• account_name (str) – Cosmos DB database account name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_migrate_table_to_autoscale(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

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.

• account_name (str) – Cosmos DB database account name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_migrate_table_to_manual_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

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.

• account_name (str) – Cosmos DB database account name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, table_name: str, location: azure.mgmt.cosmosdb.models._models_py3.ContinuousBackupRestoreLocation, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.BackupInformation]

Retrieves continuous backup information for a table.

Parameters

• resource_group_name (str) – The name of the resource group. The name is case insensitive.

• account_name (str) – Cosmos DB database account name.

• table_name (str) – Cosmos DB table name.

• location (ContinuousBackupRestoreLocation) – The name of the continuous backup restore location.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either BackupInformation or the result of cls(response)

Return type

LROPoller[BackupInformation]

Raises

~azure.core.exceptions.HttpResponseError

begin_update_table_throughput(resource_group_name: str, account_name: str, table_name: str, update_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]

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.

• account_name (str) – Cosmos DB database account name.

• table_name (str) – Cosmos DB table name.

• update_throughput_parameters (ThroughputSettingsUpdateParameters) – The parameters to provide for the RUs per second of the current Table.

Keyword Arguments

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Return type

LROPoller[ThroughputSettingsGetResults]

Raises

~azure.core.exceptions.HttpResponseError

get_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.TableGetResults

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.

• account_name (str) – Cosmos DB database account name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TableGetResults, or the result of cls(response)

Return type

TableGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_table_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults

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.

• account_name (str) – Cosmos DB database account name.

• table_name (str) – Cosmos DB table name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ThroughputSettingsGetResults

Raises

~azure.core.exceptions.HttpResponseError

list_tables(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.cosmosdb.models._models_py3.TableListResult]

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.

• account_name (str) – Cosmos DB database account name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TableListResult or the result of cls(response)

Return type

ItemPaged[TableListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/mnt/vss/_work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>