azure.mgmt.cosmosdb.models module¶

class azure.mgmt.cosmosdb.models.ARMProxyResource(**kwargs)[source]¶

Bases: msrest.serialization.Model

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the database account.
name (str) – The name of the database account.
type (str) – The type of Azure resource.

class azure.mgmt.cosmosdb.models.ARMResourceProperties(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The core properties of ARM resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

class azure.mgmt.cosmosdb.models.ApiProperties(*, server_version: Union[str, ServerVersion, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ApiProperties.

Parameters: server_version (str or ServerVersion) – Describes the ServerVersion of an a MongoDB account. Possible values include: “3.2”, “3.6”.

class azure.mgmt.cosmosdb.models.AutoUpgradePolicyResource(*, throughput_policy: Optional[ThroughputPolicyResource] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB resource auto-upgrade policy.

Parameters: throughput_policy (ThroughputPolicyResource) – Represents throughput policy which service must adhere to for auto- upgrade.

class azure.mgmt.cosmosdb.models.AutoscaleSettings(*, max_throughput: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

AutoscaleSettings.

Parameters: max_throughput (int) – Represents maximum throughput, the resource can scale up to.

class azure.mgmt.cosmosdb.models.AutoscaleSettingsResource(*, max_throughput: int, auto_upgrade_policy: Optional[AutoUpgradePolicyResource] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB provisioned throughput settings object.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

max_throughput (int) – Required. Represents maximum throughput container can scale up to.
auto_upgrade_policy (AutoUpgradePolicyResource) – Cosmos DB resource auto-upgrade policy.

Variables

target_max_throughput (int) – Represents target maximum throughput container can scale up to once offer is no longer in pending state.

class azure.mgmt.cosmosdb.models.Capability(*, name: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB capability object.

Parameters: name (str) – Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”.

class azure.mgmt.cosmosdb.models.CassandraKeyspaceCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.CassandraKeyspaceResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB Cassandra keyspace.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (CassandraKeyspaceResource) – Required. The standard JSON format of a Cassandra keyspace.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.CassandraKeyspaceGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

CassandraKeyspaceGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.CassandraKeyspaceGetPropertiesResource(*, id: str, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.CassandraKeyspaceResource

CassandraKeyspaceGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB Cassandra keyspace.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.CassandraKeyspaceGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[CassandraKeyspaceGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB Cassandra keyspace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (CassandraKeyspaceGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.CassandraKeyspaceListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the Cassandra keyspaces and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[CassandraKeyspaceGetResults]) – List of Cassandra keyspaces and their properties.

class azure.mgmt.cosmosdb.models.CassandraKeyspaceResource(*, id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB Cassandra keyspace resource object.

All required parameters must be populated in order to send to Azure.

Parameters: id (str) – Required. Name of the Cosmos DB Cassandra keyspace.

class azure.mgmt.cosmosdb.models.CassandraPartitionKey(*, name: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB Cassandra table partition key.

Parameters: name (str) – Name of the Cosmos DB Cassandra table partition key.

class azure.mgmt.cosmosdb.models.CassandraSchema(*, columns: Optional[List[Column]] = None, partition_keys: Optional[List[CassandraPartitionKey]] = None, cluster_keys: Optional[List[ClusterKey]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB Cassandra table schema.

Parameters

columns (list[Column]) – List of Cassandra table columns.
partition_keys (list[CassandraPartitionKey]) – List of partition key.
cluster_keys (list[ClusterKey]) – List of cluster key.

class azure.mgmt.cosmosdb.models.CassandraTableCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.CassandraTableResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB Cassandra table.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (CassandraTableResource) – Required. The standard JSON format of a Cassandra table.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.CassandraTableGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

CassandraTableGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.CassandraTableGetPropertiesResource(*, id: str, default_ttl: Optional[int] = None, schema: Optional[CassandraSchema] = None, analytical_storage_ttl: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.CassandraTableResource

CassandraTableGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB Cassandra table.
default_ttl (int) – Time to live of the Cosmos DB Cassandra table.
schema (CassandraSchema) – Schema of the Cosmos DB Cassandra table.
analytical_storage_ttl (int) – Analytical TTL.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.CassandraTableGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[CassandraTableGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB Cassandra table.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (CassandraTableGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.CassandraTableListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the Cassandra tables and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[CassandraTableGetResults]) – List of Cassandra tables and their properties.

class azure.mgmt.cosmosdb.models.CassandraTableResource(*, id: str, default_ttl: Optional[int] = None, schema: Optional[CassandraSchema] = None, analytical_storage_ttl: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB Cassandra table resource object.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB Cassandra table.
default_ttl (int) – Time to live of the Cosmos DB Cassandra table.
schema (CassandraSchema) – Schema of the Cosmos DB Cassandra table.
analytical_storage_ttl (int) – Analytical TTL.

class azure.mgmt.cosmosdb.models.ClusterKey(*, name: Optional[str] = None, order_by: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB Cassandra table cluster key.

Parameters

name (str) – Name of the Cosmos DB Cassandra table cluster key.
order_by (str) – Order of the Cosmos DB Cassandra table cluster key, only support “Asc” and “Desc”.

class azure.mgmt.cosmosdb.models.Column(*, name: Optional[str] = None, type: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB Cassandra table column.

Parameters

name (str) – Name of the Cosmos DB Cassandra table column.
type (str) – Type of the Cosmos DB Cassandra table column.

class azure.mgmt.cosmosdb.models.CompositePath(*, path: Optional[str] = None, order: Union[str, CompositePathSortOrder, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

CompositePath.

Parameters

path (str) – The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).
order (str or CompositePathSortOrder) – Sort order for composite paths. Possible values include: “Ascending”, “Descending”.

class azure.mgmt.cosmosdb.models.ConflictResolutionPolicy(*, mode: Union[str, ConflictResolutionMode, None] = 'LastWriterWins', conflict_resolution_path: Optional[str] = None, conflict_resolution_procedure: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The conflict resolution policy for the container.

Parameters

mode (str or ConflictResolutionMode) – Indicates the conflict resolution mode. Possible values include: “LastWriterWins”, “Custom”. Default value: “LastWriterWins”.
conflict_resolution_path (str) – The conflict resolution path in the case of LastWriterWins mode.
conflict_resolution_procedure (str) – The procedure to resolve conflicts in the case of custom mode.

class azure.mgmt.cosmosdb.models.ConsistencyPolicy(*, default_consistency_level: Union[str, DefaultConsistencyLevel], max_staleness_prefix: Optional[int] = None, max_interval_in_seconds: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The consistency policy for the Cosmos DB database account.

All required parameters must be populated in order to send to Azure.

Parameters

default_consistency_level (str or DefaultConsistencyLevel) – Required. The default consistency level and configuration settings of the Cosmos DB account. Possible values include: “Eventual”, “Session”, “BoundedStaleness”, “Strong”, “ConsistentPrefix”.
max_staleness_prefix (long) – When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.
max_interval_in_seconds (int) – When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

class azure.mgmt.cosmosdb.models.ContainerPartitionKey(*, paths: Optional[List[str]] = None, kind: Union[str, PartitionKind, None] = 'Hash', version: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The configuration of the partition key to be used for partitioning data into multiple partitions.

Parameters

paths (list[str]) – List of paths using which data within the container can be partitioned.
kind (str or PartitionKind) – Indicates the kind of algorithm used for partitioning. Possible values include: “Hash”, “Range”. Default value: “Hash”.
version (int) – Indicates the version of the partition key definition.

class azure.mgmt.cosmosdb.models.CorsPolicy(*, allowed_origins: str, allowed_methods: Optional[str] = None, allowed_headers: Optional[str] = None, exposed_headers: Optional[str] = None, max_age_in_seconds: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The CORS policy for the Cosmos DB database account.

All required parameters must be populated in order to send to Azure.

Parameters

allowed_origins (str) – Required. The origin domains that are permitted to make a request against the service via CORS.
allowed_methods (str) – The methods (HTTP request verbs) that the origin domain may use for a CORS request.
allowed_headers (str) – The request headers that the origin domain may specify on the CORS request.
exposed_headers (str) – The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
max_age_in_seconds (long) – The maximum amount time that a browser should cache the preflight OPTIONS request.

class azure.mgmt.cosmosdb.models.CreateUpdateOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”.

Parameters

throughput (int) – Request Units per second. For example, “throughput”: 10000.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.DatabaseAccountConnectionString(**kwargs)[source]¶

Bases: msrest.serialization.Model

Connection string for the Cosmos DB account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

connection_string (str) – Value of the connection string.
description (str) – Description of the connection string.

class azure.mgmt.cosmosdb.models.DatabaseAccountCreateUpdateParameters(*, locations: List[Location], location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, kind: Union[str, DatabaseAccountKind, None] = None, consistency_policy: Optional[ConsistencyPolicy] = None, ip_rules: Optional[List[IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, capabilities: Optional[List[Capability]] = None, virtual_network_rules: Optional[List[VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Union[str, ConnectorOffer, None] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, cors: Optional[List[CorsPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB database accounts.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
database_account_offer_type (str) – Required. The offer type for the database. Default value: “Standard”.
public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Possible values include: “Enabled”, “Disabled”.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
kind (str or DatabaseAccountKind) – Indicates the type of database account. This can only be set at database account creation. Possible values include: “GlobalDocumentDB”, “MongoDB”, “Parse”.
consistency_policy (ConsistencyPolicy) – The consistency policy for the Cosmos DB account.
locations (list[Location]) – Required. An array that contains the georeplication locations enabled for the Cosmos DB account.
ip_rules (list[IpAddressOrRange]) – List of IpRules.
is_virtual_network_filter_enabled (bool) – Flag to indicate whether to enable/disable Virtual Network ACL rules.
enable_automatic_failover (bool) – Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
capabilities (list[Capability]) – List of Cosmos DB capabilities for the account.
virtual_network_rules (list[VirtualNetworkRule]) – List of Virtual Network ACL rules configured for the Cosmos DB account.
enable_multiple_write_locations (bool) – Enables the account to write in multiple locations.
enable_cassandra_connector (bool) – Enables the cassandra connector on the Cosmos DB C* account.
connector_offer (str or ConnectorOffer) – The cassandra connector offer type for the Cosmos DB database C* account. Possible values include: “Small”.
disable_key_based_metadata_write_access (bool) – Disable write operations on metadata resources (databases, containers, throughput) via account keys.
key_vault_key_uri (str) – The URI of the key vault.
enable_free_tier (bool) – Flag to indicate whether Free Tier is enabled.
api_properties (ApiProperties) – API specific properties. Currently, supported only for MongoDB API.
enable_analytical_storage (bool) – Flag to indicate whether to enable storage analytics.
cors (list[CorsPolicy]) – The CORS policy for the Cosmos DB database account.

database_account_offer_type = 'Standard'¶

class azure.mgmt.cosmosdb.models.DatabaseAccountGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, kind: Union[str, DatabaseAccountKind, None] = None, ip_rules: Optional[List[IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, consistency_policy: Optional[ConsistencyPolicy] = None, capabilities: Optional[List[Capability]] = None, virtual_network_rules: Optional[List[VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Union[str, ConnectorOffer, None] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, cors: Optional[List[CorsPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB database account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
provisioning_state (str) – The status of the Cosmos DB account at the time the operation was called. The status can be one of following. ‘Creating’ – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. ‘Succeeded’ – the Cosmos DB account is active for use. ‘Updating’ – the Cosmos DB account is being updated. ‘Deleting’ – the Cosmos DB account is being deleted. ‘Failed’ – the Cosmos DB account failed creation. ‘DeletionFailed’ – the Cosmos DB account deletion failed.
document_endpoint (str) – The connection endpoint for the Cosmos DB database account.
database_account_offer_type (str) – The offer type for the Cosmos DB database account. Default value: Standard. Default value: “Standard”.
write_locations (list[Location]) – An array that contains the write location for the Cosmos DB account.
read_locations (list[Location]) – An array that contains of the read locations enabled for the Cosmos DB account.
locations (list[Location]) – An array that contains all of the locations enabled for the Cosmos DB account.
failover_policies (list[FailoverPolicy]) – An array that contains the regions ordered by their failover priorities.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of Private Endpoint Connections configured for the Cosmos DB account.
public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Possible values include: “Enabled”, “Disabled”.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
kind (str or DatabaseAccountKind) – Indicates the type of database account. This can only be set at database account creation. Possible values include: “GlobalDocumentDB”, “MongoDB”, “Parse”.
ip_rules (list[IpAddressOrRange]) – List of IpRules.
is_virtual_network_filter_enabled (bool) – Flag to indicate whether to enable/disable Virtual Network ACL rules.
enable_automatic_failover (bool) – Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
consistency_policy (ConsistencyPolicy) – The consistency policy for the Cosmos DB database account.
capabilities (list[Capability]) – List of Cosmos DB capabilities for the account.
virtual_network_rules (list[VirtualNetworkRule]) – List of Virtual Network ACL rules configured for the Cosmos DB account.
enable_multiple_write_locations (bool) – Enables the account to write in multiple locations.
enable_cassandra_connector (bool) – Enables the cassandra connector on the Cosmos DB C* account.
connector_offer (str or ConnectorOffer) – The cassandra connector offer type for the Cosmos DB database C* account. Possible values include: “Small”.
disable_key_based_metadata_write_access (bool) – Disable write operations on metadata resources (databases, containers, throughput) via account keys.
key_vault_key_uri (str) – The URI of the key vault.
enable_free_tier (bool) – Flag to indicate whether Free Tier is enabled.
api_properties (ApiProperties) – API specific properties.
enable_analytical_storage (bool) – Flag to indicate whether to enable storage analytics.
cors (list[CorsPolicy]) – The CORS policy for the Cosmos DB database account.

database_account_offer_type = 'Standard'¶

class azure.mgmt.cosmosdb.models.DatabaseAccountListConnectionStringsResult(*, connection_strings: Optional[List[DatabaseAccountConnectionString]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The connection strings for the given database account.

Parameters: connection_strings (list[DatabaseAccountConnectionString]) – An array that contains the connection strings for the Cosmos DB account.

class azure.mgmt.cosmosdb.models.DatabaseAccountListKeysResult(**kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.DatabaseAccountListReadOnlyKeysResult

The access keys for the given database account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

primary_readonly_master_key (str) – Base 64 encoded value of the primary read-only key.
secondary_readonly_master_key (str) – Base 64 encoded value of the secondary read-only key.
primary_master_key (str) – Base 64 encoded value of the primary read-write key.
secondary_master_key (str) – Base 64 encoded value of the secondary read-write key.

class azure.mgmt.cosmosdb.models.DatabaseAccountListReadOnlyKeysResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The read-only access keys for the given database account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

primary_readonly_master_key (str) – Base 64 encoded value of the primary read-only key.
secondary_readonly_master_key (str) – Base 64 encoded value of the secondary read-only key.

class azure.mgmt.cosmosdb.models.DatabaseAccountRegenerateKeyParameters(*, key_kind: Union[str, KeyKind], **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters to regenerate the keys within the database account.

All required parameters must be populated in order to send to Azure.

Parameters: key_kind (str or KeyKind) – Required. The access key to regenerate. Possible values include: “primary”, “secondary”, “primaryReadonly”, “secondaryReadonly”.

class azure.mgmt.cosmosdb.models.DatabaseAccountUpdateParameters(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, consistency_policy: Optional[ConsistencyPolicy] = None, locations: Optional[List[Location]] = None, ip_rules: Optional[List[IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, capabilities: Optional[List[Capability]] = None, virtual_network_rules: Optional[List[VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Union[str, ConnectorOffer, None] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, cors: Optional[List[CorsPolicy]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters for patching Azure Cosmos DB database account properties.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
location (str) – The location of the resource group to which the resource belongs.
consistency_policy (ConsistencyPolicy) – The consistency policy for the Cosmos DB account.
locations (list[Location]) – An array that contains the georeplication locations enabled for the Cosmos DB account.
ip_rules (list[IpAddressOrRange]) – List of IpRules.
is_virtual_network_filter_enabled (bool) – Flag to indicate whether to enable/disable Virtual Network ACL rules.
enable_automatic_failover (bool) – Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
capabilities (list[Capability]) – List of Cosmos DB capabilities for the account.
virtual_network_rules (list[VirtualNetworkRule]) – List of Virtual Network ACL rules configured for the Cosmos DB account.
enable_multiple_write_locations (bool) – Enables the account to write in multiple locations.
enable_cassandra_connector (bool) – Enables the cassandra connector on the Cosmos DB C* account.
connector_offer (str or ConnectorOffer) – The cassandra connector offer type for the Cosmos DB database C* account. Possible values include: “Small”.
disable_key_based_metadata_write_access (bool) – Disable write operations on metadata resources (databases, containers, throughput) via account keys.
key_vault_key_uri (str) – The URI of the key vault.
enable_free_tier (bool) – Flag to indicate whether Free Tier is enabled.
api_properties (ApiProperties) – API specific properties. Currently, supported only for MongoDB API.
enable_analytical_storage (bool) – Flag to indicate whether to enable storage analytics.
cors (list[CorsPolicy]) – The CORS policy for the Cosmos DB database account.

Variables

public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.cosmosdb.models.DatabaseAccountsListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the database accounts and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[DatabaseAccountGetResults]) – List of database account and their properties.

class azure.mgmt.cosmosdb.models.ErrorResponse(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Error Response.

Parameters

code (str) – Error code.
message (str) – Error message indicating why the operation failed.

class azure.mgmt.cosmosdb.models.ExcludedPath(*, path: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ExcludedPath.

Parameters: path (str) – The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).

class azure.mgmt.cosmosdb.models.ExtendedResourceProperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.FailoverPolicies(*, failover_policies: List[FailoverPolicy], **kwargs)[source]¶

Bases: msrest.serialization.Model

The list of new failover policies for the failover priority change.

All required parameters must be populated in order to send to Azure.

Parameters: failover_policies (list[FailoverPolicy]) – Required. List of failover policies.

class azure.mgmt.cosmosdb.models.FailoverPolicy(*, location_name: Optional[str] = None, failover_priority: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The failover policy for a given region of a database account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

Parameters

location_name (str) – The name of the region in which the database account exists.
failover_priority (int) – The failover priority of the region. 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.

class azure.mgmt.cosmosdb.models.GremlinDatabaseCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB Gremlin database.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (GremlinDatabaseResource) – Required. The standard JSON format of a Gremlin database.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.GremlinDatabaseGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

GremlinDatabaseGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.GremlinDatabaseGetPropertiesResource(*, id: str, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseResource

GremlinDatabaseGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB Gremlin database.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.GremlinDatabaseGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[GremlinDatabaseGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB Gremlin database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (GremlinDatabaseGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.GremlinDatabaseListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the Gremlin databases and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[GremlinDatabaseGetResults]) – List of Gremlin databases and their properties.

class azure.mgmt.cosmosdb.models.GremlinDatabaseResource(*, id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB Gremlin database resource object.

All required parameters must be populated in order to send to Azure.

Parameters: id (str) – Required. Name of the Cosmos DB Gremlin database.

class azure.mgmt.cosmosdb.models.GremlinGraphCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.GremlinGraphResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB Gremlin graph.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (GremlinGraphResource) – Required. The standard JSON format of a Gremlin graph.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.GremlinGraphGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

GremlinGraphGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.GremlinGraphGetPropertiesResource(*, id: str, indexing_policy: Optional[IndexingPolicy] = None, partition_key: Optional[ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[ConflictResolutionPolicy] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.GremlinGraphResource

GremlinGraphGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB Gremlin graph.
indexing_policy (IndexingPolicy) – The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph.
partition_key (ContainerPartitionKey) – The configuration of the partition key to be used for partitioning data into multiple partitions.
default_ttl (int) – Default time to live.
unique_key_policy (UniqueKeyPolicy) – The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
conflict_resolution_policy (ConflictResolutionPolicy) – The conflict resolution policy for the graph.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.GremlinGraphGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[GremlinGraphGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB Gremlin graph.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (GremlinGraphGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.GremlinGraphListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the graphs and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[GremlinGraphGetResults]) – List of graphs and their properties.

class azure.mgmt.cosmosdb.models.GremlinGraphResource(*, id: str, indexing_policy: Optional[IndexingPolicy] = None, partition_key: Optional[ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[ConflictResolutionPolicy] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB Gremlin graph resource object.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB Gremlin graph.
indexing_policy (IndexingPolicy) – The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph.
partition_key (ContainerPartitionKey) – The configuration of the partition key to be used for partitioning data into multiple partitions.
default_ttl (int) – Default time to live.
unique_key_policy (UniqueKeyPolicy) – The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
conflict_resolution_policy (ConflictResolutionPolicy) – The conflict resolution policy for the graph.

class azure.mgmt.cosmosdb.models.IncludedPath(*, path: Optional[str] = None, indexes: Optional[List[Indexes]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The paths that are included in indexing.

Parameters

path (str) – The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).
indexes (list[Indexes]) – List of indexes for this path.

class azure.mgmt.cosmosdb.models.Indexes(*, data_type: Union[str, DataType, None] = 'String', precision: Optional[int] = None, kind: Union[str, IndexKind, None] = 'Hash', **kwargs)[source]¶

Bases: msrest.serialization.Model

The indexes for the path.

Parameters

data_type (str or DataType) – The datatype for which the indexing behavior is applied to. Possible values include: “String”, “Number”, “Point”, “Polygon”, “LineString”, “MultiPolygon”. Default value: “String”.
precision (int) – The precision of the index. -1 is maximum precision.
kind (str or IndexKind) – Indicates the type of index. Possible values include: “Hash”, “Range”, “Spatial”. Default value: “Hash”.

class azure.mgmt.cosmosdb.models.IndexingPolicy(*, automatic: Optional[bool] = None, indexing_mode: Union[str, IndexingMode, None] = 'Consistent', included_paths: Optional[List[IncludedPath]] = None, excluded_paths: Optional[List[ExcludedPath]] = None, composite_indexes: Optional[List[List[CompositePath]]] = None, spatial_indexes: Optional[List[SpatialSpec]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB indexing policy.

Parameters

automatic (bool) – Indicates if the indexing policy is automatic.
indexing_mode (str or IndexingMode) – Indicates the indexing mode. Possible values include: “Consistent”, “Lazy”, “None”. Default value: “Consistent”.
included_paths (list[IncludedPath]) – List of paths to include in the indexing.
excluded_paths (list[ExcludedPath]) – List of paths to exclude from indexing.
composite_indexes (list[list[CompositePath]]) – List of composite path list.
spatial_indexes (list[SpatialSpec]) – List of spatial specifics.

class azure.mgmt.cosmosdb.models.IpAddressOrRange(*, ip_address_or_range: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

IpAddressOrRange object.

Parameters: ip_address_or_range (str) – A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

class azure.mgmt.cosmosdb.models.Location(*, location_name: Optional[str] = None, failover_priority: Optional[int] = None, is_zone_redundant: Optional[bool] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A region in which the Azure Cosmos DB database account is deployed.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
document_endpoint (str) – The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/.
provisioning_state (str) – The status of the Cosmos DB account at the time the operation was called. The status can be one of following. ‘Creating’ – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. ‘Succeeded’ – the Cosmos DB account is active for use. ‘Updating’ – the Cosmos DB account is being updated. ‘Deleting’ – the Cosmos DB account is being deleted. ‘Failed’ – the Cosmos DB account failed creation. ‘DeletionFailed’ – the Cosmos DB account deletion failed.

Parameters

location_name (str) – The name of the region.
failover_priority (int) – The failover priority of the region. 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.
is_zone_redundant (bool) – Flag to indicate whether or not this region is an AvailabilityZone region.

class azure.mgmt.cosmosdb.models.Metric(**kwargs)[source]¶

Bases: msrest.serialization.Model

Metric data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

start_time (datetime) – The start time for the metric (ISO-8601 format).
end_time (datetime) – The end time for the metric (ISO-8601 format).
time_grain (str) – The time grain to be used to summarize the metric values.
unit (str or UnitType) – The unit of the metric. Possible values include: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, “Milliseconds”.
name (MetricName) – The name information for the metric.
metric_values (list[MetricValue]) – The metric values for the specified time window and timestep.

class azure.mgmt.cosmosdb.models.MetricAvailability(**kwargs)[source]¶

Bases: msrest.serialization.Model

The availability of the metric.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

time_grain (str) – The time grain to be used to summarize the metric values.
retention (str) – The retention for the metric values.

class azure.mgmt.cosmosdb.models.MetricDefinition(**kwargs)[source]¶

Bases: msrest.serialization.Model

The definition of a metric.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

metric_availabilities (list[MetricAvailability]) – The list of metric availabilities for the account.
primary_aggregation_type (str or PrimaryAggregationType) – The primary aggregation type of the metric. Possible values include: “None”, “Average”, “Total”, “Minimum”, “Maximum”, “Last”.
unit (str or UnitType) – The unit of the metric. Possible values include: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, “Milliseconds”.
resource_uri (str) – The resource uri of the database.
name (MetricName) – The name information for the metric.

class azure.mgmt.cosmosdb.models.MetricDefinitionsListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list metric definitions request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[MetricDefinition]) – The list of metric definitions for the account.

class azure.mgmt.cosmosdb.models.MetricListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list metrics request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[Metric]) – The list of metrics for the account.

class azure.mgmt.cosmosdb.models.MetricName(**kwargs)[source]¶

Bases: msrest.serialization.Model

A metric name.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (str) – The name of the metric.
localized_value (str) – The friendly name of the metric.

class azure.mgmt.cosmosdb.models.MetricValue(**kwargs)[source]¶

Bases: msrest.serialization.Model

Represents metrics values.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

count (int) – The number of values for the metric.
average (float) – The average value of the metric.
maximum (float) – The max value of the metric.
minimum (float) – The min value of the metric.
timestamp (datetime) – The metric timestamp (ISO-8601 format).
total (float) – The total value of the metric.

class azure.mgmt.cosmosdb.models.MongoDBCollectionCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.MongoDBCollectionResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB MongoDB collection.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (MongoDBCollectionResource) – Required. The standard JSON format of a MongoDB collection.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.MongoDBCollectionGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

MongoDBCollectionGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.MongoDBCollectionGetPropertiesResource(*, id: str, shard_key: Optional[Dict[str, str]] = None, indexes: Optional[List[MongoIndex]] = None, analytical_storage_ttl: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.MongoDBCollectionResource

MongoDBCollectionGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB MongoDB collection.
shard_key (dict[str, str]) – A key-value pair of shard keys to be applied for the request.
indexes (list[MongoIndex]) – List of index keys.
analytical_storage_ttl (int) – Analytical TTL.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.MongoDBCollectionGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[MongoDBCollectionGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB MongoDB collection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (MongoDBCollectionGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.MongoDBCollectionListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the MongoDB collections and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[MongoDBCollectionGetResults]) – List of MongoDB collections and their properties.

class azure.mgmt.cosmosdb.models.MongoDBCollectionResource(*, id: str, shard_key: Optional[Dict[str, str]] = None, indexes: Optional[List[MongoIndex]] = None, analytical_storage_ttl: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB MongoDB collection resource object.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB MongoDB collection.
shard_key (dict[str, str]) – A key-value pair of shard keys to be applied for the request.
indexes (list[MongoIndex]) – List of index keys.
analytical_storage_ttl (int) – Analytical TTL.

class azure.mgmt.cosmosdb.models.MongoDBDatabaseCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.MongoDBDatabaseResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB MongoDB database.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (MongoDBDatabaseResource) – Required. The standard JSON format of a MongoDB database.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.MongoDBDatabaseGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

MongoDBDatabaseGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.MongoDBDatabaseGetPropertiesResource(*, id: str, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.MongoDBDatabaseResource

MongoDBDatabaseGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB MongoDB database.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.MongoDBDatabaseGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[MongoDBDatabaseGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB MongoDB database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (MongoDBDatabaseGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.MongoDBDatabaseListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the MongoDB databases and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[MongoDBDatabaseGetResults]) – List of MongoDB databases and their properties.

class azure.mgmt.cosmosdb.models.MongoDBDatabaseResource(*, id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB MongoDB database resource object.

All required parameters must be populated in order to send to Azure.

Parameters: id (str) – Required. Name of the Cosmos DB MongoDB database.

class azure.mgmt.cosmosdb.models.MongoIndex(*, key: Optional[MongoIndexKeys] = None, options: Optional[MongoIndexOptions] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB MongoDB collection index key.

Parameters

key (MongoIndexKeys) – Cosmos DB MongoDB collection index keys.
options (MongoIndexOptions) – Cosmos DB MongoDB collection index key options.

class azure.mgmt.cosmosdb.models.MongoIndexKeys(*, keys: Optional[List[str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB MongoDB collection resource object.

Parameters: keys (list[str]) – List of keys for each MongoDB collection in the Azure Cosmos DB service.

class azure.mgmt.cosmosdb.models.MongoIndexOptions(*, expire_after_seconds: Optional[int] = None, unique: Optional[bool] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB MongoDB collection index options.

Parameters

expire_after_seconds (int) – Expire after seconds.
unique (bool) – Is unique or not.

class azure.mgmt.cosmosdb.models.NotebookWorkspace(**kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMProxyResource

A notebook workspace resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the database account.
name (str) – The name of the database account.
type (str) – The type of Azure resource.
notebook_server_endpoint (str) – Specifies the endpoint of Notebook server.
status (str) – Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.

class azure.mgmt.cosmosdb.models.NotebookWorkspaceConnectionInfoResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The connection info for the given notebook workspace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

auth_token (str) – Specifies auth token used for connecting to Notebook server (uses token-based auth).
notebook_server_endpoint (str) – Specifies the endpoint of Notebook server.

class azure.mgmt.cosmosdb.models.NotebookWorkspaceCreateUpdateParameters(**kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMProxyResource

Parameters to create a notebook workspace resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the database account.
name (str) – The name of the database account.
type (str) – The type of Azure resource.

class azure.mgmt.cosmosdb.models.NotebookWorkspaceListResult(*, value: Optional[List[NotebookWorkspace]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of notebook workspace resources.

Parameters: value (list[NotebookWorkspace]) – Array of notebook workspace resources.

class azure.mgmt.cosmosdb.models.Operation(*, name: Optional[str] = None, display: Optional[OperationDisplay] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

REST API operation.

Parameters

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.cosmosdb.models.OperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The object that represents the operation.

Parameters

provider (str) – Service provider: Microsoft.ResourceProvider.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.
description (str) – Description of operation.

class azure.mgmt.cosmosdb.models.OperationListResult(*, value: Optional[List[Operation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.

Parameters

value (list[Operation]) – List of operations supported by the Resource Provider.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.cosmosdb.models.OptionsResource(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB options resource object.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.PartitionMetric(**kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.Metric

The metric values for a single partition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

start_time (datetime) – The start time for the metric (ISO-8601 format).
end_time (datetime) – The end time for the metric (ISO-8601 format).
time_grain (str) – The time grain to be used to summarize the metric values.
unit (str or UnitType) – The unit of the metric. Possible values include: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, “Milliseconds”.
name (MetricName) – The name information for the metric.
metric_values (list[MetricValue]) – The metric values for the specified time window and timestep.
partition_id (str) – The partition id (GUID identifier) of the metric values.
partition_key_range_id (str) – The partition key range id (integer identifier) of the metric values.

class azure.mgmt.cosmosdb.models.PartitionMetricListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list partition metrics request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[PartitionMetric]) – The list of partition-level metrics for the account.

class azure.mgmt.cosmosdb.models.PartitionUsage(**kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.Usage

The partition level usage data for a usage request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

unit (str or UnitType) – The unit of the metric. Possible values include: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, “Milliseconds”.
name (MetricName) – The name information for the metric.
quota_period (str) – The quota period used to summarize the usage values.
limit (long) – Maximum value for this metric.
current_value (long) – Current value for this metric.
partition_id (str) – The partition id (GUID identifier) of the usages.
partition_key_range_id (str) – The partition key range id (integer identifier) of the usages.

class azure.mgmt.cosmosdb.models.PartitionUsagesResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list partition level usage request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[PartitionUsage]) – The list of partition-level usages for the database. A usage is a point in time metric.

class azure.mgmt.cosmosdb.models.PercentileMetric(**kwargs)[source]¶

Bases: msrest.serialization.Model

Percentile Metric data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

start_time (datetime) – The start time for the metric (ISO-8601 format).
end_time (datetime) – The end time for the metric (ISO-8601 format).
time_grain (str) – The time grain to be used to summarize the metric values.
unit (str or UnitType) – The unit of the metric. Possible values include: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, “Milliseconds”.
name (MetricName) – The name information for the metric.
metric_values (list[PercentileMetricValue]) – The percentile metric values for the specified time window and timestep.

class azure.mgmt.cosmosdb.models.PercentileMetricListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list percentile metrics request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[PercentileMetric]) – The list of percentile metrics for the account.

class azure.mgmt.cosmosdb.models.PercentileMetricValue(**kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.MetricValue

Represents percentile metrics values.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

count (int) – The number of values for the metric.
average (float) – The average value of the metric.
maximum (float) – The max value of the metric.
minimum (float) – The min value of the metric.
timestamp (datetime) – The metric timestamp (ISO-8601 format).
total (float) – The total value of the metric.
p10 (float) – The 10th percentile value for the metric.
p25 (float) – The 25th percentile value for the metric.
p50 (float) – The 50th percentile value for the metric.
p75 (float) – The 75th percentile value for the metric.
p90 (float) – The 90th percentile value for the metric.
p95 (float) – The 95th percentile value for the metric.
p99 (float) – The 99th percentile value for the metric.

class azure.mgmt.cosmosdb.models.PrivateEndpointConnection(*, private_endpoint: Optional[PrivateEndpointProperty] = None, private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateProperty] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.Resource

A private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

private_endpoint (PrivateEndpointProperty) – Private endpoint which the connection belongs to.
private_link_service_connection_state (PrivateLinkServiceConnectionStateProperty) – Connection State of the Private Endpoint Connection.

class azure.mgmt.cosmosdb.models.PrivateEndpointConnectionAutoGenerated(*, private_endpoint: Optional[PrivateEndpointProperty] = None, private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStatePropertyAutoGenerated] = None, group_id: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.Resource

A private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

private_endpoint (PrivateEndpointProperty) – Private endpoint which the connection belongs to.
private_link_service_connection_state (PrivateLinkServiceConnectionStatePropertyAutoGenerated) – Connection State of the Private Endpoint Connection.
group_id (str) – Group id of the private endpoint.
provisioning_state (str) – Provisioning state of the private endpoint.

class azure.mgmt.cosmosdb.models.PrivateEndpointConnectionListResult(*, value: Optional[List[PrivateEndpointConnectionAutoGenerated]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of private endpoint connections.

Parameters: value (list[PrivateEndpointConnectionAutoGenerated]) – Array of private endpoint connections.

class azure.mgmt.cosmosdb.models.PrivateEndpointProperty(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Private endpoint which the connection belongs to.

Parameters: id (str) – Resource id of the private endpoint.

class azure.mgmt.cosmosdb.models.PrivateLinkResource(**kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMProxyResource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the database account.
name (str) – The name of the database account.
type (str) – The type of Azure resource.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource required zone names.

class azure.mgmt.cosmosdb.models.PrivateLinkResourceListResult(*, value: Optional[List[PrivateLinkResource]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of private link resources.

Parameters: value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.cosmosdb.models.PrivateLinkServiceConnectionStateProperty(*, status: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Connection State of the Private Endpoint Connection.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters: status (str) – The private link service connection status.
Variables: actions_required (str) – Any action that is required beyond basic workflow (approve/ reject/ disconnect).

class azure.mgmt.cosmosdb.models.PrivateLinkServiceConnectionStatePropertyAutoGenerated(*, status: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Connection State of the Private Endpoint Connection.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

status (str) – The private link service connection status.
description (str) – The private link service connection description.

Variables

actions_required (str) – Any action that is required beyond basic workflow (approve/ reject/ disconnect).

class azure.mgmt.cosmosdb.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.Resource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.cosmosdb.models.RegionForOnlineOffline(*, region: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB region to online or offline.

All required parameters must be populated in order to send to Azure.

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

class azure.mgmt.cosmosdb.models.Resource(**kwargs)[source]¶

Bases: msrest.serialization.Model

Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.cosmosdb.models.SpatialSpec(*, path: Optional[str] = None, types: Optional[List[Union[str, SpatialType]]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SpatialSpec.

Parameters

path (str) – The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).
types (list[str or SpatialType]) – List of path’s spatial type.

class azure.mgmt.cosmosdb.models.SqlContainerCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.SqlContainerResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB container.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlContainerResource) – Required. The standard JSON format of a container.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.SqlContainerGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

SqlContainerGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.SqlContainerGetPropertiesResource(*, id: str, indexing_policy: Optional[IndexingPolicy] = None, partition_key: Optional[ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[ConflictResolutionPolicy] = None, analytical_storage_ttl: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.SqlContainerResource

SqlContainerGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB SQL container.
indexing_policy (IndexingPolicy) – The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container.
partition_key (ContainerPartitionKey) – The configuration of the partition key to be used for partitioning data into multiple partitions.
default_ttl (int) – Default time to live.
unique_key_policy (UniqueKeyPolicy) – The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
conflict_resolution_policy (ConflictResolutionPolicy) – The conflict resolution policy for the container.
analytical_storage_ttl (long) – Analytical TTL.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.SqlContainerGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[SqlContainerGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB container.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlContainerGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.SqlContainerListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the containers and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[SqlContainerGetResults]) – List of containers and their properties.

class azure.mgmt.cosmosdb.models.SqlContainerResource(*, id: str, indexing_policy: Optional[IndexingPolicy] = None, partition_key: Optional[ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[ConflictResolutionPolicy] = None, analytical_storage_ttl: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB SQL container resource object.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB SQL container.
indexing_policy (IndexingPolicy) – The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container.
partition_key (ContainerPartitionKey) – The configuration of the partition key to be used for partitioning data into multiple partitions.
default_ttl (int) – Default time to live.
unique_key_policy (UniqueKeyPolicy) – The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
conflict_resolution_policy (ConflictResolutionPolicy) – The conflict resolution policy for the container.
analytical_storage_ttl (long) – Analytical TTL.

class azure.mgmt.cosmosdb.models.SqlDatabaseCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB SQL database.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlDatabaseResource) – Required. The standard JSON format of a SQL database.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.SqlDatabaseGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

SqlDatabaseGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.SqlDatabaseGetPropertiesResource(*, id: str, colls: Optional[str] = None, users: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseResource, azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties

SqlDatabaseGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

Parameters

id (str) – Required. Name of the Cosmos DB SQL database.
colls (str) – A system generated property that specified the addressable path of the collections resource.
users (str) – A system generated property that specifies the addressable path of the users resource.

class azure.mgmt.cosmosdb.models.SqlDatabaseGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[SqlDatabaseGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB SQL database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlDatabaseGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.SqlDatabaseListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the SQL databases and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[SqlDatabaseGetResults]) – List of SQL databases and their properties.

class azure.mgmt.cosmosdb.models.SqlDatabaseResource(*, id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB SQL database resource object.

All required parameters must be populated in order to send to Azure.

Parameters: id (str) – Required. Name of the Cosmos DB SQL database.

class azure.mgmt.cosmosdb.models.SqlStoredProcedureCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB storedProcedure.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlStoredProcedureResource) – Required. The standard JSON format of a storedProcedure.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.SqlStoredProcedureGetPropertiesResource(*, id: str, body: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureResource

SqlStoredProcedureGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB SQL storedProcedure.
body (str) – Body of the Stored Procedure.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[SqlStoredProcedureGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB storedProcedure.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlStoredProcedureGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.SqlStoredProcedureListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the storedProcedures and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[SqlStoredProcedureGetResults]) – List of storedProcedures and their properties.

class azure.mgmt.cosmosdb.models.SqlStoredProcedureResource(*, id: str, body: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB SQL storedProcedure resource object.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB SQL storedProcedure.
body (str) – Body of the Stored Procedure.

class azure.mgmt.cosmosdb.models.SqlTriggerCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.SqlTriggerResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB trigger.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlTriggerResource) – Required. The standard JSON format of a trigger.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.SqlTriggerGetPropertiesResource(*, id: str, body: Optional[str] = None, trigger_type: Union[str, TriggerType, None] = None, trigger_operation: Union[str, TriggerOperation, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.SqlTriggerResource

SqlTriggerGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB SQL trigger.
body (str) – Body of the Trigger.
trigger_type (str or TriggerType) – Type of the Trigger. Possible values include: “Pre”, “Post”.
trigger_operation (str or TriggerOperation) – The operation the trigger is associated with. Possible values include: “All”, “Create”, “Update”, “Delete”, “Replace”.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.SqlTriggerGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[SqlTriggerGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB trigger.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlTriggerGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.SqlTriggerListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the triggers and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[SqlTriggerGetResults]) – List of triggers and their properties.

class azure.mgmt.cosmosdb.models.SqlTriggerResource(*, id: str, body: Optional[str] = None, trigger_type: Union[str, TriggerType, None] = None, trigger_operation: Union[str, TriggerOperation, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB SQL trigger resource object.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB SQL trigger.
body (str) – Body of the Trigger.
trigger_type (str or TriggerType) – Type of the Trigger. Possible values include: “Pre”, “Post”.
trigger_operation (str or TriggerOperation) – The operation the trigger is associated with. Possible values include: “All”, “Create”, “Update”, “Delete”, “Replace”.

class azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB userDefinedFunction.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlUserDefinedFunctionResource) – Required. The standard JSON format of a userDefinedFunction.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetPropertiesResource(*, id: str, body: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.SqlUserDefinedFunctionResource

SqlUserDefinedFunctionGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB SQL userDefinedFunction.
body (str) – Body of the User Defined Function.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[SqlUserDefinedFunctionGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB userDefinedFunction.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlUserDefinedFunctionGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the userDefinedFunctions and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[SqlUserDefinedFunctionGetResults]) – List of userDefinedFunctions and their properties.

class azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionResource(*, id: str, body: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB SQL userDefinedFunction resource object.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB SQL userDefinedFunction.
body (str) – Body of the User Defined Function.

class azure.mgmt.cosmosdb.models.TableCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.TableResource, options: azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to create and update Cosmos DB Table.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (TableResource) – Required. The standard JSON format of a Table.
options (CreateUpdateOptions) – Required. A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

class azure.mgmt.cosmosdb.models.TableGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettings] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.OptionsResource

TableGetPropertiesOptions.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings.

class azure.mgmt.cosmosdb.models.TableGetPropertiesResource(*, id: str, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.TableResource

TableGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Name of the Cosmos DB table.

Variables

rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.TableGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[TableGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB Table.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.
options (OptionsResource) – Cosmos DB options resource object.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (TableGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.TableListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The List operation response, that contains the Table and their properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[TableGetResults]) – List of Table and their properties.

class azure.mgmt.cosmosdb.models.TableResource(*, id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB table resource object.

All required parameters must be populated in order to send to Azure.

Parameters: id (str) – Required. Name of the Cosmos DB table.

class azure.mgmt.cosmosdb.models.ThroughputPolicyResource(*, is_enabled: Optional[bool] = None, increment_percent: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB resource throughput policy.

Parameters

is_enabled (bool) – Determines whether the ThroughputPolicy is active or not.
increment_percent (int) – Represents the percentage by which throughput can increase every time throughput policy kicks in.

class azure.mgmt.cosmosdb.models.ThroughputSettingsGetPropertiesResource(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettingsResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsResource

ThroughputSettingsGetPropertiesResource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.
autoscale_settings (AutoscaleSettingsResource) – Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.

Variables

minimum_throughput (str) – The minimum throughput of the resource.
offer_replace_pending (str) – The throughput replace is pending.
rid (str) – A system generated property. A unique identifier.
ts (object) – A system generated property that denotes the last updated timestamp of the resource.
etag (str) – A system generated property representing the resource etag required for optimistic concurrency control.

class azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resource: Optional[ThroughputSettingsGetPropertiesResource] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

An Azure Cosmos DB resource throughput.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (ThroughputSettingsGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.ThroughputSettingsResource(*, throughput: Optional[int] = None, autoscale_settings: Optional[AutoscaleSettingsResource] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

throughput (int) – Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.
autoscale_settings (AutoscaleSettingsResource) – Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.

Variables

minimum_throughput (str) – The minimum throughput of the resource.
offer_replace_pending (str) – The throughput replace is pending.

class azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsResource, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.cosmosdb.models._models_py3.ARMResourceProperties

Parameters to update Cosmos DB resource throughput.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The unique resource identifier of the ARM resource.
name (str) – The name of the ARM resource.
type (str) – The type of Azure resource.

Parameters

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – A set of tags. Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (ThroughputSettingsResource) – Required. The standard JSON format of a resource throughput.

class azure.mgmt.cosmosdb.models.UniqueKey(*, paths: Optional[List[str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

Parameters: paths (list[str]) – List of paths must be unique for each document in the Azure Cosmos DB service.

class azure.mgmt.cosmosdb.models.UniqueKeyPolicy(*, unique_keys: Optional[List[UniqueKey]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Parameters: unique_keys (list[UniqueKey]) – List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

class azure.mgmt.cosmosdb.models.Usage(**kwargs)[source]¶

Bases: msrest.serialization.Model

The usage data for a usage request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

unit (str or UnitType) – The unit of the metric. Possible values include: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, “Milliseconds”.
name (MetricName) – The name information for the metric.
quota_period (str) – The quota period used to summarize the usage values.
limit (long) – Maximum value for this metric.
current_value (long) – Current value for this metric.

class azure.mgmt.cosmosdb.models.UsagesResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list usage request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[Usage]) – The list of usages for the database. A usage is a point in time metric.

class azure.mgmt.cosmosdb.models.VirtualNetworkRule(*, id: Optional[str] = None, ignore_missing_v_net_service_endpoint: Optional[bool] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Virtual Network ACL Rule object.

Parameters

id (str) – Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignore_missing_v_net_service_endpoint (bool) – Create firewall rule before the virtual network has vnet service endpoint enabled.

class azure.mgmt.cosmosdb.models.CompositePathSortOrder[source]¶

Bases: str, enum.Enum

Sort order for composite paths.