azure.mgmt.cosmosdb.operations module¶

Raises

CloudError

list_read_only_keys(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseAccountListReadOnlyKeysResult or ClientRawResponse if raw=true

Return type

DatabaseAccountListReadOnlyKeysResult or ClientRawResponse

Raises

CloudError

list_usages(resource_group_name, account_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CloudError

offline_region(resource_group_name, account_name, region, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
region (str) – Cosmos DB region, with spaces between words and each word capitalized.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

online_region(resource_group_name, account_name, region, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
region (str) – Cosmos DB region, with spaces between words and each word capitalized.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

OperationPaged[Operation]

regenerate_key(resource_group_name, account_name, key_kind, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
key_kind (str or KeyKind) – The access key to regenerate. Possible values include: ‘primary’, ‘secondary’, ‘primaryReadonly’, ‘secondaryReadonly’
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

update(resource_group_name, account_name, update_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
update_parameters (DatabaseAccountUpdateParameters) – The parameters to provide for the current database account.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DatabaseAccountGetResults or ClientRawResponse<DatabaseAccountGetResults> if raw==True

Return type

AzureOperationPoller[DatabaseAccountGetResults] or AzureOperationPoller[ClientRawResponse[DatabaseAccountGetResults]]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.Operations(client, config, serializer, deserializer)[source]¶

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all of the available Cosmos DB Resource Provider operations.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.DatabaseOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metric_definitions(resource_group_name, account_name, database_rid, custom_headers=None, raw=False, **operation_config)[source]¶

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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of MetricDefinition

Return type

MetricDefinitionPaged[MetricDefinition]

Raises

CloudError

list_metrics(resource_group_name, account_name, database_rid, filter, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Metric

Return type

MetricDefinitionPaged[MetricDefinition]

Raises

CloudError

list_usages(resource_group_name, account_name, database_rid, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.CollectionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CollectionOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metric_definitions(resource_group_name, account_name, database_rid, collection_rid, custom_headers=None, raw=False, **operation_config)[source]¶

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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of MetricDefinition

Return type

Raises

CloudError

list_metrics(resource_group_name, account_name, database_rid, collection_rid, filter, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Metric

Return type

Raises

CloudError

list_usages(resource_group_name, account_name, database_rid, collection_rid, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.CollectionRegionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CollectionRegionOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, region, database_rid, collection_rid, filter, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Metric

Return type

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.DatabaseAccountRegionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseAccountRegionOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, region, filter, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Metric

Return type

PercentileMetricPaged[PercentileMetric]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.PercentileSourceTargetOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PercentileSourceTargetOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, source_region, target_region, filter, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PercentileMetric

Return type

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.PercentileTargetOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PercentileTargetOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, target_region, filter, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PercentileMetric

Return type

PercentileMetricPaged[PercentileMetric]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.PercentileOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PercentileOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, filter, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PercentileMetric

Return type

PercentileMetricPaged[PercentileMetric]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.CollectionPartitionRegionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CollectionPartitionRegionOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, region, database_rid, collection_rid, filter, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PartitionMetric

Return type

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.CollectionPartitionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CollectionPartitionOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, database_rid, collection_rid, filter, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PartitionMetric

Return type

PartitionUsagePaged[PartitionUsage]

Raises

CloudError

list_usages(resource_group_name, account_name, database_rid, collection_rid, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PartitionUsage

Return type

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.PartitionKeyRangeIdOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PartitionKeyRangeIdOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, database_rid, collection_rid, partition_key_range_id, filter, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the metrics determined by the given filter for the given partition key range id.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PartitionMetric

Return type

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.PartitionKeyRangeIdRegionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PartitionKeyRangeIdRegionOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

list_metrics(resource_group_name, account_name, region, database_rid, collection_rid, partition_key_range_id, filter, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the metrics determined by the given filter for the given partition key range id and region.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PartitionMetric

Return type

SqlContainerGetResultsPaged[SqlContainerGetResults]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.SqlResourcesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SqlResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

create_update_sql_container(resource_group_name, account_name, database_name, container_name, create_update_sql_container_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB SQL container.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SqlContainerGetResults or ClientRawResponse<SqlContainerGetResults> if raw==True

Return type

AzureOperationPoller[SqlContainerGetResults] or AzureOperationPoller[ClientRawResponse[SqlContainerGetResults]]

Raises

CloudError

create_update_sql_database(resource_group_name, account_name, database_name, create_update_sql_database_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB SQL database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SqlDatabaseGetResults or ClientRawResponse<SqlDatabaseGetResults> if raw==True

Return type

AzureOperationPoller[SqlDatabaseGetResults] or AzureOperationPoller[ClientRawResponse[SqlDatabaseGetResults]]

Raises

CloudError

create_update_sql_stored_procedure(resource_group_name, account_name, database_name, container_name, stored_procedure_name, create_update_sql_stored_procedure_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB SQL storedProcedure.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SqlStoredProcedureGetResults or ClientRawResponse<SqlStoredProcedureGetResults> if raw==True

Return type

AzureOperationPoller[SqlStoredProcedureGetResults] or AzureOperationPoller[ClientRawResponse[SqlStoredProcedureGetResults]]

Raises

CloudError

create_update_sql_trigger(resource_group_name, account_name, database_name, container_name, trigger_name, create_update_sql_trigger_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB SQL trigger.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SqlTriggerGetResults or ClientRawResponse<SqlTriggerGetResults> if raw==True

Return type

AzureOperationPoller[SqlTriggerGetResults] or AzureOperationPoller[ClientRawResponse[SqlTriggerGetResults]]

Raises

CloudError

create_update_sql_user_defined_function(resource_group_name, account_name, database_name, container_name, user_defined_function_name, create_update_sql_user_defined_function_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB SQL userDefinedFunction.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SqlUserDefinedFunctionGetResults or ClientRawResponse<SqlUserDefinedFunctionGetResults> if raw==True

Return type

AzureOperationPoller[SqlUserDefinedFunctionGetResults] or AzureOperationPoller[ClientRawResponse[SqlUserDefinedFunctionGetResults]]

Raises

CloudError

delete_sql_container(resource_group_name, account_name, database_name, container_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB SQL container.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_sql_database(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB SQL database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_sql_stored_procedure(resource_group_name, account_name, database_name, container_name, stored_procedure_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB SQL storedProcedure.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_sql_trigger(resource_group_name, account_name, database_name, container_name, trigger_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB SQL trigger.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_sql_user_defined_function(resource_group_name, account_name, database_name, container_name, user_defined_function_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get_sql_container(resource_group_name, account_name, database_name, container_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the SQL container under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SqlContainerGetResults or ClientRawResponse if raw=true

Return type

SqlContainerGetResults or ClientRawResponse

Raises

CloudError

get_sql_container_throughput(resource_group_name, account_name, database_name, container_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

get_sql_database(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SqlDatabaseGetResults or ClientRawResponse if raw=true

Return type

SqlDatabaseGetResults or ClientRawResponse

Raises

CloudError

get_sql_database_throughput(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

get_sql_stored_procedure(resource_group_name, account_name, database_name, container_name, stored_procedure_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SqlStoredProcedureGetResults or ClientRawResponse if raw=true

Return type

SqlStoredProcedureGetResults or ClientRawResponse

Raises

CloudError

get_sql_trigger(resource_group_name, account_name, database_name, container_name, trigger_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the SQL trigger under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SqlTriggerGetResults or ClientRawResponse if raw=true

Return type

SqlTriggerGetResults or ClientRawResponse

Raises

CloudError

get_sql_user_defined_function(resource_group_name, account_name, database_name, container_name, user_defined_function_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SqlUserDefinedFunctionGetResults or ClientRawResponse if raw=true

Return type

SqlUserDefinedFunctionGetResults or ClientRawResponse

Raises

CloudError

list_sql_containers(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the SQL container under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SqlContainerGetResults

Return type

Raises

CloudError

list_sql_databases(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SqlDatabaseGetResults

Return type

SqlDatabaseGetResultsPaged[SqlDatabaseGetResults]

Raises

CloudError

list_sql_stored_procedures(resource_group_name, account_name, database_name, container_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SqlStoredProcedureGetResults

Return type

SqlStoredProcedureGetResultsPaged[SqlStoredProcedureGetResults]

Raises

CloudError

list_sql_triggers(resource_group_name, account_name, database_name, container_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the SQL trigger under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SqlTriggerGetResults

Return type

SqlTriggerGetResultsPaged[SqlTriggerGetResults]

Raises

CloudError

list_sql_user_defined_functions(resource_group_name, account_name, database_name, container_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SqlUserDefinedFunctionGetResults

Return type

SqlUserDefinedFunctionGetResultsPaged[SqlUserDefinedFunctionGetResults]

Raises

CloudError

migrate_sql_container_to_autoscale(resource_group_name, account_name, database_name, container_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_sql_container_to_manual_throughput(resource_group_name, account_name, database_name, container_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_sql_database_to_autoscale(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_sql_database_to_manual_throughput(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_sql_container_throughput(resource_group_name, account_name, database_name, container_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Update RUs per second of an Azure Cosmos DB SQL container.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_sql_database_throughput(resource_group_name, account_name, database_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.MongoDBResourcesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

MongoDBResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

create_update_mongo_db_collection(resource_group_name, account_name, database_name, collection_name, create_update_mongo_db_collection_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB MongoDB Collection.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns MongoDBCollectionGetResults or ClientRawResponse<MongoDBCollectionGetResults> if raw==True

Return type

AzureOperationPoller[MongoDBCollectionGetResults] or AzureOperationPoller[ClientRawResponse[MongoDBCollectionGetResults]]

Raises

CloudError

create_update_mongo_db_database(resource_group_name, account_name, database_name, create_update_mongo_db_database_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or updates Azure Cosmos DB MongoDB database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns MongoDBDatabaseGetResults or ClientRawResponse<MongoDBDatabaseGetResults> if raw==True

Return type

AzureOperationPoller[MongoDBDatabaseGetResults] or AzureOperationPoller[ClientRawResponse[MongoDBDatabaseGetResults]]

Raises

CloudError

delete_mongo_db_collection(resource_group_name, account_name, database_name, collection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB MongoDB Collection.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_mongo_db_database(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB MongoDB database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get_mongo_db_collection(resource_group_name, account_name, database_name, collection_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

MongoDBCollectionGetResults or ClientRawResponse if raw=true

Return type

MongoDBCollectionGetResults or ClientRawResponse

Raises

CloudError

get_mongo_db_collection_throughput(resource_group_name, account_name, database_name, collection_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

get_mongo_db_database(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

MongoDBDatabaseGetResults or ClientRawResponse if raw=true

Return type

MongoDBDatabaseGetResults or ClientRawResponse

Raises

CloudError

get_mongo_db_database_throughput(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

list_mongo_db_collections(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of MongoDBCollectionGetResults

Return type

MongoDBCollectionGetResultsPaged[MongoDBCollectionGetResults]

Raises

CloudError

list_mongo_db_databases(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of MongoDBDatabaseGetResults

Return type

MongoDBDatabaseGetResultsPaged[MongoDBDatabaseGetResults]

Raises

CloudError

migrate_mongo_db_collection_to_autoscale(resource_group_name, account_name, database_name, collection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_mongo_db_collection_to_manual_throughput(resource_group_name, account_name, database_name, collection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_mongo_db_database_to_autoscale(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_mongo_db_database_to_manual_throughput(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_mongo_db_collection_throughput(resource_group_name, account_name, database_name, collection_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_mongo_db_database_throughput(resource_group_name, account_name, database_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.TableResourcesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TableResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

create_update_table(resource_group_name, account_name, table_name, create_update_table_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB Table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns TableGetResults or ClientRawResponse<TableGetResults> if raw==True

Return type

AzureOperationPoller[TableGetResults] or AzureOperationPoller[ClientRawResponse[TableGetResults]]

Raises

CloudError

delete_table(resource_group_name, account_name, table_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get_table(resource_group_name, account_name, table_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

TableGetResults or ClientRawResponse if raw=true

Return type

TableGetResults or ClientRawResponse

Raises

CloudError

get_table_throughput(resource_group_name, account_name, table_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

list_tables(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of TableGetResults

Return type

TableGetResultsPaged[TableGetResults]

Raises

CloudError

migrate_table_to_autoscale(resource_group_name, account_name, table_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_table_to_manual_throughput(resource_group_name, account_name, table_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_table_throughput(resource_group_name, account_name, table_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Update RUs per second of an Azure Cosmos DB Table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.CassandraResourcesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CassandraResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

create_update_cassandra_keyspace(resource_group_name, account_name, keyspace_name, create_update_cassandra_keyspace_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB Cassandra keyspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns CassandraKeyspaceGetResults or ClientRawResponse<CassandraKeyspaceGetResults> if raw==True

Return type

AzureOperationPoller[CassandraKeyspaceGetResults] or AzureOperationPoller[ClientRawResponse[CassandraKeyspaceGetResults]]

Raises

CloudError

create_update_cassandra_table(resource_group_name, account_name, keyspace_name, table_name, create_update_cassandra_table_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB Cassandra Table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns CassandraTableGetResults or ClientRawResponse<CassandraTableGetResults> if raw==True

Return type

AzureOperationPoller[CassandraTableGetResults] or AzureOperationPoller[ClientRawResponse[CassandraTableGetResults]]

Raises

CloudError

delete_cassandra_keyspace(resource_group_name, account_name, keyspace_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB Cassandra keyspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_cassandra_table(resource_group_name, account_name, keyspace_name, table_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB Cassandra table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get_cassandra_keyspace(resource_group_name, account_name, keyspace_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

CassandraKeyspaceGetResults or ClientRawResponse if raw=true

Return type

CassandraKeyspaceGetResults or ClientRawResponse

Raises

CloudError

get_cassandra_keyspace_throughput(resource_group_name, account_name, keyspace_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

get_cassandra_table(resource_group_name, account_name, keyspace_name, table_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

CassandraTableGetResults or ClientRawResponse if raw=true

Return type

CassandraTableGetResults or ClientRawResponse

Raises

CloudError

get_cassandra_table_throughput(resource_group_name, account_name, keyspace_name, table_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

list_cassandra_keyspaces(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of CassandraKeyspaceGetResults

Return type

CassandraKeyspaceGetResultsPaged[CassandraKeyspaceGetResults]

Raises

CloudError

list_cassandra_tables(resource_group_name, account_name, keyspace_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of CassandraTableGetResults

Return type

CassandraTableGetResultsPaged[CassandraTableGetResults]

Raises

CloudError

migrate_cassandra_keyspace_to_autoscale(resource_group_name, account_name, keyspace_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_cassandra_keyspace_to_manual_throughput(resource_group_name, account_name, keyspace_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_cassandra_table_to_autoscale(resource_group_name, account_name, keyspace_name, table_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_cassandra_table_to_manual_throughput(resource_group_name, account_name, keyspace_name, table_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_cassandra_keyspace_throughput(resource_group_name, account_name, keyspace_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_cassandra_table_throughput(resource_group_name, account_name, keyspace_name, table_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.GremlinResourcesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GremlinResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.

create_update_gremlin_database(resource_group_name, account_name, database_name, create_update_gremlin_database_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB Gremlin database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns GremlinDatabaseGetResults or ClientRawResponse<GremlinDatabaseGetResults> if raw==True

Return type

AzureOperationPoller[GremlinDatabaseGetResults] or AzureOperationPoller[ClientRawResponse[GremlinDatabaseGetResults]]

Raises

CloudError

create_update_gremlin_graph(resource_group_name, account_name, database_name, graph_name, create_update_gremlin_graph_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update an Azure Cosmos DB Gremlin graph.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns GremlinGraphGetResults or ClientRawResponse<GremlinGraphGetResults> if raw==True

Return type

AzureOperationPoller[GremlinGraphGetResults] or AzureOperationPoller[ClientRawResponse[GremlinGraphGetResults]]

Raises

CloudError

delete_gremlin_database(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB Gremlin database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_gremlin_graph(resource_group_name, account_name, database_name, graph_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing Azure Cosmos DB Gremlin graph.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get_gremlin_database(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

GremlinDatabaseGetResults or ClientRawResponse if raw=true

Return type

GremlinDatabaseGetResults or ClientRawResponse

Raises

CloudError

get_gremlin_database_throughput(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

get_gremlin_graph(resource_group_name, account_name, database_name, graph_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

GremlinGraphGetResults or ClientRawResponse if raw=true

Return type

GremlinGraphGetResults or ClientRawResponse

Raises

CloudError

get_gremlin_graph_throughput(resource_group_name, account_name, database_name, graph_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ThroughputSettingsGetResults or ClientRawResponse if raw=true

Return type

ThroughputSettingsGetResults or ClientRawResponse

Raises

CloudError

list_gremlin_databases(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of GremlinDatabaseGetResults

Return type

GremlinDatabaseGetResultsPaged[GremlinDatabaseGetResults]

Raises

CloudError

list_gremlin_graphs(resource_group_name, account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of GremlinGraphGetResults

Return type

GremlinGraphGetResultsPaged[GremlinGraphGetResults]

Raises

CloudError

migrate_gremlin_database_to_autoscale(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_gremlin_database_to_manual_throughput(resource_group_name, account_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_gremlin_graph_to_autoscale(resource_group_name, account_name, database_name, graph_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

migrate_gremlin_graph_to_manual_throughput(resource_group_name, account_name, database_name, graph_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_gremlin_database_throughput(resource_group_name, account_name, database_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

update_gremlin_graph_throughput(resource_group_name, account_name, database_name, graph_name, update_throughput_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ThroughputSettingsGetResults or ClientRawResponse<ThroughputSettingsGetResults> if raw==True

Return type

AzureOperationPoller[ThroughputSettingsGetResults] or AzureOperationPoller[ClientRawResponse[ThroughputSettingsGetResults]]

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.NotebookWorkspacesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NotebookWorkspacesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-04-01”.
notebook_workspace_name – The name of the notebook workspace resource. Constant value: “default”.

create_or_update(resource_group_name, account_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates the notebook workspace for a Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NotebookWorkspace or ClientRawResponse<NotebookWorkspace> if raw==True

Return type

AzureOperationPoller[NotebookWorkspace] or AzureOperationPoller[ClientRawResponse[NotebookWorkspace]]

Raises

delete(resource_group_name, account_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the notebook workspace for a Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the notebook workspace for a Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NotebookWorkspace or ClientRawResponse if raw=true

Return type

NotebookWorkspace or ClientRawResponse

Raises

NotebookWorkspacePaged[NotebookWorkspace]

list_by_database_account(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the notebook workspace resources of an existing Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NotebookWorkspace

Return type

Raises

list_connection_info(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the connection info for the notebook workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NotebookWorkspaceConnectionInfoResult or ClientRawResponse if raw=true

Return type

NotebookWorkspaceConnectionInfoResult or ClientRawResponse

Raises

regenerate_auth_token(resource_group_name, account_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Regenerates the auth token for the notebook workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

start(resource_group_name, account_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

PrivateLinkResourcePaged[PrivateLinkResource]

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.PrivateLinkResourcesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PrivateLinkResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-08-01-preview”.

get(resource_group_name, account_name, group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the private link resources that need to be created for a Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
group_name (str) – The name of the private link resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

PrivateLinkResource or ClientRawResponse if raw=true

Return type

PrivateLinkResource or ClientRawResponse

Raises

CloudError

list_by_database_account(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the private link resources that need to be created for a Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PrivateLinkResource

Return type

Raises

CloudError

models = <module 'azure.mgmt.cosmosdb.models' from '/home/vsts/work/1/s/sdk/cosmos/azure-mgmt-cosmosdb/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cosmosdb/models/__init__.py'>¶

class azure.mgmt.cosmosdb.operations.PrivateEndpointConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PrivateEndpointConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-08-01-preview”.

create_or_update(resource_group_name, account_name, private_endpoint_connection_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Approve or reject a private endpoint connection with a given name.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
private_endpoint_connection_name (str) – The name of the private endpoint connection.
parameters (PrivateEndpointConnection) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PrivateEndpointConnection or ClientRawResponse<PrivateEndpointConnection> if raw==True

Return type

AzureOperationPoller[PrivateEndpointConnection] or AzureOperationPoller[ClientRawResponse[PrivateEndpointConnection]]

Raises

delete(resource_group_name, account_name, private_endpoint_connection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a private endpoint connection with a given name.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
private_endpoint_connection_name (str) – The name of the private endpoint connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises