azure.mgmt.cosmosdb.operations module¶

begin_delete(resource_group_name: str, account_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_failover_priority_change(resource_group_name: str, account_name: str, failover_parameters: ‘models.FailoverPolicies’, **kwargs: Any) → LROPoller[None][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
failover_parameters (FailoverPolicies) – The new failover policies for the database account.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_offline_region(resource_group_name: str, account_name: str, region_parameter_for_offline: ‘models.RegionForOnlineOffline’, **kwargs: Any) → LROPoller[None][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
region_parameter_for_offline (RegionForOnlineOffline) – Cosmos DB region to offline for the database account.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_online_region(resource_group_name: str, account_name: str, region_parameter_for_online: ‘models.RegionForOnlineOffline’, **kwargs: Any) → LROPoller[None][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
region_parameter_for_online (RegionForOnlineOffline) – Cosmos DB region to online for the database account.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_regenerate_key(resource_group_name: str, account_name: str, key_to_regenerate: ‘models.DatabaseAccountRegenerateKeyParameters’, **kwargs: Any) → LROPoller[None][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
key_to_regenerate (DatabaseAccountRegenerateKeyParameters) – The name of the key to regenerate.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

LROPoller[DatabaseAccountGetResults]

begin_update(resource_group_name: str, account_name: str, update_parameters: ‘models.DatabaseAccountUpdateParameters’, **kwargs: Any) → LROPoller[‘models.DatabaseAccountGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
update_parameters (DatabaseAccountUpdateParameters) – The parameters to provide for the current database account.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

DatabaseAccountGetResults

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

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

Parameters: account_name (str) – Cosmos DB database account name.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: bool, or the result of cls(response)
Return type: bool
Raises: ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, account_name: str, **kwargs: Any) → ’models.DatabaseAccountGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.

Keyword Arguments

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

Returns

DatabaseAccountGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_read_only_keys(resource_group_name: str, account_name: str, **kwargs: Any) → ’models.DatabaseAccountListReadOnlyKeysResult’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.

Keyword Arguments

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

Returns

DatabaseAccountListReadOnlyKeysResult, or the result of cls(response)

Return type

DatabaseAccountListReadOnlyKeysResult

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘models.DatabaseAccountsListResult’][source]¶

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

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DatabaseAccountsListResult or the result of cls(response)
Return type: ItemPaged[DatabaseAccountsListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘models.DatabaseAccountsListResult’][source]¶

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

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DatabaseAccountsListResult or the result of cls(response)
Return type: ItemPaged[DatabaseAccountsListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_connection_strings(resource_group_name: str, account_name: str, **kwargs: Any) → ’models.DatabaseAccountListConnectionStringsResult’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.

Keyword Arguments

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

Returns

DatabaseAccountListConnectionStringsResult, or the result of cls(response)

Return type

DatabaseAccountListConnectionStringsResult

Raises

~azure.core.exceptions.HttpResponseError

list_keys(resource_group_name: str, account_name: str, **kwargs: Any) → ’models.DatabaseAccountListKeysResult’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.

Keyword Arguments

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

Returns

DatabaseAccountListKeysResult, or the result of cls(response)

Return type

DatabaseAccountListKeysResult

Raises

~azure.core.exceptions.HttpResponseError

list_metric_definitions(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[‘models.MetricDefinitionsListResult’][source]¶

Retrieves metric definitions for the given database account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricDefinitionsListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_metrics(resource_group_name: str, account_name: str, filter: str, **kwargs: Any) → Iterable[‘models.MetricListResult’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
filter (str) – An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Keyword Arguments

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

Returns

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

Return type

DatabaseAccountListReadOnlyKeysResult

Raises

~azure.core.exceptions.HttpResponseError

list_read_only_keys(resource_group_name: str, account_name: str, **kwargs: Any) → ’models.DatabaseAccountListReadOnlyKeysResult’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.

Keyword Arguments

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

Returns

DatabaseAccountListReadOnlyKeysResult, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

list(**kwargs: Any) → Iterable[‘models.OperationListResult’][source]¶

Lists all of the available Cosmos DB Resource Provider operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either OperationListResult or the result of cls(response)
Return type: ItemPaged[OperationListResult]
Raises: ~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

list_metric_definitions(resource_group_name: str, account_name: str, database_rid: str, **kwargs: Any) → Iterable[‘models.MetricDefinitionsListResult’][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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricDefinitionsListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricDefinitionsListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

list_metric_definitions(resource_group_name: str, account_name: str, database_rid: str, collection_rid: str, **kwargs: Any) → Iterable[‘models.MetricDefinitionsListResult’][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.

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PercentileMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

list_metrics(resource_group_name: str, account_name: str, source_region: str, target_region: str, filter: str, **kwargs: Any) → Iterable[‘models.PercentileMetricListResult’][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.

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PercentileMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PercentileMetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PartitionUsagesResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

list_metrics(resource_group_name: str, account_name: str, region: str, database_rid: str, collection_rid: str, partition_key_range_id: str, filter: str, **kwargs: Any) → Iterable[‘models.PartitionMetricListResult’][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.

Keyword Arguments

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

Returns

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

Return type

LROPoller[SqlContainerGetResults]

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

begin_create_update_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, create_update_sql_container_parameters: ‘models.SqlContainerCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.SqlContainerGetResults’][source]¶

Create or update an Azure Cosmos DB SQL container.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
create_update_sql_container_parameters (SqlContainerCreateUpdateParameters) – The parameters to provide for the current SQL container.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

LROPoller[SqlDatabaseGetResults]

begin_create_update_sql_database(resource_group_name: str, account_name: str, database_name: str, create_update_sql_database_parameters: ‘models.SqlDatabaseCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.SqlDatabaseGetResults’][source]¶

Create or update an Azure Cosmos DB SQL database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
create_update_sql_database_parameters (SqlDatabaseCreateUpdateParameters) – The parameters to provide for the current SQL database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

LROPoller[SqlStoredProcedureGetResults]

begin_create_update_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, create_update_sql_stored_procedure_parameters: ‘models.SqlStoredProcedureCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.SqlStoredProcedureGetResults’][source]¶

Create or update an Azure Cosmos DB SQL storedProcedure.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
stored_procedure_name (str) – Cosmos DB storedProcedure name.
create_update_sql_stored_procedure_parameters (SqlStoredProcedureCreateUpdateParameters) – The parameters to provide for the current SQL storedProcedure.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

LROPoller[SqlTriggerGetResults]

begin_create_update_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, create_update_sql_trigger_parameters: ‘models.SqlTriggerCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.SqlTriggerGetResults’][source]¶

Create or update an Azure Cosmos DB SQL trigger.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
trigger_name (str) – Cosmos DB trigger name.
create_update_sql_trigger_parameters (SqlTriggerCreateUpdateParameters) – The parameters to provide for the current SQL trigger.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

LROPoller[SqlUserDefinedFunctionGetResults]

begin_create_update_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, create_update_sql_user_defined_function_parameters: ‘models.SqlUserDefinedFunctionCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.SqlUserDefinedFunctionGetResults’][source]¶

Create or update an Azure Cosmos DB SQL userDefinedFunction.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
user_defined_function_name (str) – Cosmos DB userDefinedFunction name.
create_update_sql_user_defined_function_parameters (SqlUserDefinedFunctionCreateUpdateParameters) – The parameters to provide for the current SQL userDefinedFunction.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB SQL container.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB SQL database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB SQL storedProcedure.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
stored_procedure_name (str) – Cosmos DB storedProcedure name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB SQL trigger.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
trigger_name (str) – Cosmos DB trigger name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
user_defined_function_name (str) – Cosmos DB userDefinedFunction name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_sql_container_to_autoscale(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_sql_container_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_sql_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_sql_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The parameters to provide for the RUs per second of the current SQL container.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The parameters to provide for the RUs per second of the current SQL database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

get_sql_container(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → ’models.SqlContainerGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.

Keyword Arguments

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

Returns

SqlContainerGetResults, or the result of cls(response)

Return type

SqlContainerGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_container_throughput(resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_sql_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → ’models.SqlDatabaseGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

SqlDatabaseGetResults, or the result of cls(response)

Return type

SqlDatabaseGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

SqlStoredProcedureGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_stored_procedure(resource_group_name: str, account_name: str, database_name: str, container_name: str, stored_procedure_name: str, **kwargs: Any) → ’models.SqlStoredProcedureGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
stored_procedure_name (str) – Cosmos DB storedProcedure name.

Keyword Arguments

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

Returns

SqlStoredProcedureGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_sql_trigger(resource_group_name: str, account_name: str, database_name: str, container_name: str, trigger_name: str, **kwargs: Any) → ’models.SqlTriggerGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
trigger_name (str) – Cosmos DB trigger name.

Keyword Arguments

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

Returns

SqlTriggerGetResults, or the result of cls(response)

Return type

SqlTriggerGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_sql_user_defined_function(resource_group_name: str, account_name: str, database_name: str, container_name: str, user_defined_function_name: str, **kwargs: Any) → ’models.SqlUserDefinedFunctionGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
container_name (str) – Cosmos DB container name.
user_defined_function_name (str) – Cosmos DB userDefinedFunction name.

Keyword Arguments

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

Returns

SqlUserDefinedFunctionGetResults, or the result of cls(response)

Return type

SqlUserDefinedFunctionGetResults

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlContainerListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlStoredProcedureListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlTriggerListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlUserDefinedFunctionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

begin_create_update_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, create_update_mongo_db_collection_parameters: ‘models.MongoDBCollectionCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.MongoDBCollectionGetResults’][source]¶

Create or update an Azure Cosmos DB MongoDB Collection.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.
create_update_mongo_db_collection_parameters (MongoDBCollectionCreateUpdateParameters) – The parameters to provide for the current MongoDB Collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[MongoDBCollectionGetResults]

Raises

LROPoller[MongoDBDatabaseGetResults]

begin_create_update_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, create_update_mongo_db_database_parameters: ‘models.MongoDBDatabaseCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.MongoDBDatabaseGetResults’][source]¶

Create or updates Azure Cosmos DB MongoDB database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
create_update_mongo_db_database_parameters (MongoDBDatabaseCreateUpdateParameters) – The parameters to provide for the current MongoDB database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB MongoDB Collection.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB MongoDB database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_mongo_db_collection_to_autoscale(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_mongo_db_collection_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_mongo_db_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_mongo_db_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_mongo_db_collection_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current MongoDB collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_mongo_db_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current MongoDB database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

MongoDBCollectionGetResults

get_mongo_db_collection(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → ’models.MongoDBCollectionGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.

Keyword Arguments

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

Returns

MongoDBCollectionGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_mongo_db_collection_throughput(resource_group_name: str, account_name: str, database_name: str, collection_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
collection_name (str) – Cosmos DB collection name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

MongoDBDatabaseGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_mongo_db_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → ’models.MongoDBDatabaseGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

MongoDBDatabaseGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_mongo_db_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ItemPaged[MongoDBCollectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MongoDBDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

begin_create_update_table(resource_group_name: str, account_name: str, table_name: str, create_update_table_parameters: ‘models.TableCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.TableGetResults’][source]¶

Create or update an Azure Cosmos DB Table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.
create_update_table_parameters (TableCreateUpdateParameters) – The parameters to provide for the current Table.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[TableGetResults]

Raises

begin_delete_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB Table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_table_to_autoscale(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_table_to_manual_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_table_throughput(resource_group_name: str, account_name: str, table_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

Update RUs per second of an Azure Cosmos DB Table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The parameters to provide for the RUs per second of the current Table.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

get_table(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → ’models.TableGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

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

Returns

TableGetResults, or the result of cls(response)

Return type

TableGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_table_throughput(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ItemPaged[TableListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

begin_create_update_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, create_update_cassandra_keyspace_parameters: ‘models.CassandraKeyspaceCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.CassandraKeyspaceGetResults’][source]¶

Create or update an Azure Cosmos DB Cassandra keyspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
create_update_cassandra_keyspace_parameters (CassandraKeyspaceCreateUpdateParameters) – The parameters to provide for the current Cassandra keyspace.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[CassandraKeyspaceGetResults]

Raises

LROPoller[CassandraTableGetResults]

begin_create_update_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, create_update_cassandra_table_parameters: ‘models.CassandraTableCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.CassandraTableGetResults’][source]¶

Create or update an Azure Cosmos DB Cassandra Table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.
create_update_cassandra_table_parameters (CassandraTableCreateUpdateParameters) – The parameters to provide for the current Cassandra Table.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB Cassandra keyspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB Cassandra table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_cassandra_keyspace_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_cassandra_keyspace_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_cassandra_table_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_cassandra_table_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Cassandra Keyspace.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Cassandra table.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

CassandraKeyspaceGetResults

get_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → ’models.CassandraKeyspaceGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

Returns

CassandraKeyspaceGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → ’models.CassandraTableGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

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

Returns

CassandraTableGetResults, or the result of cls(response)

Return type

CassandraTableGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
keyspace_name (str) – Cosmos DB keyspace name.
table_name (str) – Cosmos DB table name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ItemPaged[CassandraKeyspaceListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CassandraTableListResult]

Raises

~azure.core.exceptions.HttpResponseError

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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

begin_create_update_gremlin_database(resource_group_name: str, account_name: str, database_name: str, create_update_gremlin_database_parameters: ‘models.GremlinDatabaseCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.GremlinDatabaseGetResults’][source]¶

Create or update an Azure Cosmos DB Gremlin database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
create_update_gremlin_database_parameters (GremlinDatabaseCreateUpdateParameters) – The parameters to provide for the current Gremlin database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[GremlinDatabaseGetResults]

Raises

LROPoller[GremlinGraphGetResults]

begin_create_update_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, create_update_gremlin_graph_parameters: ‘models.GremlinGraphCreateUpdateParameters’, **kwargs: Any) → LROPoller[‘models.GremlinGraphGetResults’][source]¶

Create or update an Azure Cosmos DB Gremlin graph.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.
create_update_gremlin_graph_parameters (GremlinGraphCreateUpdateParameters) – The parameters to provide for the current Gremlin graph.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB Gremlin database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_delete_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes an existing Azure Cosmos DB Gremlin graph.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_gremlin_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_gremlin_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_gremlin_graph_to_autoscale(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_migrate_gremlin_graph_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Gremlin database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_update_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, update_throughput_parameters: ‘models.ThroughputSettingsUpdateParameters’, **kwargs: Any) → LROPoller[‘models.ThroughputSettingsGetResults’][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.
update_throughput_parameters (ThroughputSettingsUpdateParameters) – The RUs per second of the parameters to provide for the current Gremlin graph.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

GremlinDatabaseGetResults

get_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → ’models.GremlinDatabaseGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

GremlinDatabaseGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → ’models.GremlinGraphGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.

Keyword Arguments

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

Returns

GremlinGraphGetResults, or the result of cls(response)

Return type

GremlinGraphGetResults

Raises

~azure.core.exceptions.HttpResponseError

get_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) → ’models.ThroughputSettingsGetResults’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
database_name (str) – Cosmos DB database name.
graph_name (str) – Cosmos DB graph name.

Keyword Arguments

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

Returns

ThroughputSettingsGetResults, or the result of cls(response)

Return type

ItemPaged[GremlinDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GremlinGraphListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

begin_create_or_update(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, ‘models.NotebookWorkspaceName’], notebook_create_update_parameters: ‘models.ARMProxyResource’, **kwargs: Any) → LROPoller[‘models.NotebookWorkspace’][source]¶

Creates the notebook workspace for a Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.
notebook_create_update_parameters (ARMProxyResource) – The notebook workspace to create for the current database account.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NotebookWorkspace]

Raises

begin_delete(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, ‘models.NotebookWorkspaceName’], **kwargs: Any) → LROPoller[None][source]¶

Deletes the notebook workspace for a Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_regenerate_auth_token(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, ‘models.NotebookWorkspaceName’], **kwargs: Any) → LROPoller[None][source]¶

Regenerates the auth token for the notebook workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

begin_start(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, ‘models.NotebookWorkspaceName’], **kwargs: Any) → LROPoller[None][source]¶

Starts the notebook workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

ItemPaged[NotebookWorkspaceListResult]

get(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, ‘models.NotebookWorkspaceName’], **kwargs: Any) → ’models.NotebookWorkspace’[source]¶

Gets the notebook workspace for a Cosmos DB account.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

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

Returns

NotebookWorkspace, or the result of cls(response)

Return type

NotebookWorkspace

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_connection_info(resource_group_name: str, account_name: str, notebook_workspace_name: Union[str, ‘models.NotebookWorkspaceName’], **kwargs: Any) → ’models.NotebookWorkspaceConnectionInfoResult’[source]¶

Retrieves the connection info for the notebook workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
notebook_workspace_name (str or NotebookWorkspaceName) – The name of the notebook workspace resource.

Keyword Arguments

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

Returns

NotebookWorkspaceConnectionInfoResult, or the result of cls(response)

Return type

NotebookWorkspaceConnectionInfoResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

get(resource_group_name: str, account_name: str, group_name: str, **kwargs: Any) → ’models.PrivateLinkResource’[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
group_name (str) – The name of the private link resource.

Keyword Arguments

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

Returns

PrivateLinkResource, or the result of cls(response)

Return type

PrivateLinkResource

Raises

~azure.core.exceptions.HttpResponseError

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PrivateLinkResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.cosmosdb.models' from '/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters

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

begin_create_or_update(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, parameters: ‘models.PrivateEndpointConnectionAutoGenerated’, **kwargs: Any) → LROPoller[‘models.PrivateEndpointConnectionAutoGenerated’][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 (PrivateEndpointConnectionAutoGenerated) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PrivateEndpointConnectionAutoGenerated]

Raises

begin_delete(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes a private endpoint connection with a given name.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
account_name (str) – Cosmos DB database account name.
private_endpoint_connection_name (str) – The name of the private endpoint connection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises