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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.

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

Bases: msrest.serialization.Model

Analytical storage specific properties.

Parameters: schema_type (str or AnalyticalStorageSchemaType) – Describes the types of schema for analytical storage. Possible values include: “WellDefined”, “FullFidelity”.

class azure.mgmt.cosmosdb.models.AnalyticalStorageSchemaType(value)[source]¶

Bases: str, enum.Enum

Describes the types of schema for analytical storage.

FULL_FIDELITY = 'FullFidelity'¶

WELL_DEFINED = 'WellDefined'¶

class azure.mgmt.cosmosdb.models.ApiProperties(*, server_version: Optional[str] = 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”, “4.0”.

class azure.mgmt.cosmosdb.models.ApiType(value)[source]¶

Bases: str, enum.Enum

Enum to indicate the API type of the restorable database account.

CASSANDRA = 'Cassandra'¶

GREMLIN = 'Gremlin'¶

GREMLIN_V2 = 'GremlinV2'¶

MONGO_DB = 'MongoDB'¶

SQL = 'Sql'¶

TABLE = 'Table'¶

class azure.mgmt.cosmosdb.models.AuthenticationMethod(value)[source]¶

Bases: str, enum.Enum

Which authentication method Cassandra should use to authenticate clients. ‘None’ turns off authentication, so should not be used except in emergencies. ‘Cassandra’ is the default password based authentication. The default is ‘Cassandra’.

CASSANDRA = 'Cassandra'¶

NONE = 'None'¶

class azure.mgmt.cosmosdb.models.AutoUpgradePolicyResource(*, throughput_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.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[azure.mgmt.cosmosdb.models._models_py3.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.BackupInformation(**kwargs)[source]¶

Bases: msrest.serialization.Model

Backup information of a resource.

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

Variables: continuous_backup_information (ContinuousBackupInformation) – Information about the status of continuous backups.

class azure.mgmt.cosmosdb.models.BackupPolicy(*, migration_state: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupPolicyMigrationState] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The object representing the policy for taking backups on an account.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContinuousModeBackupPolicy, PeriodicModeBackupPolicy.

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

Parameters

type (str or BackupPolicyType) – Required. Describes the mode of backups.Constant filled by server. Possible values include: “Periodic”, “Continuous”.
migration_state (BackupPolicyMigrationState) – The object representing the state of the migration between the backup policies.

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

Bases: msrest.serialization.Model

The object representing the state of the migration between the backup policies.

Parameters

status (str or BackupPolicyMigrationStatus) – Describes the status of migration between backup policy types. Possible values include: “Invalid”, “InProgress”, “Completed”, “Failed”.
target_type (str or BackupPolicyType) – Describes the target backup policy type of the backup policy migration. Possible values include: “Periodic”, “Continuous”.
start_time (datetime) – Time at which the backup policy migration started (ISO-8601 format).

class azure.mgmt.cosmosdb.models.BackupPolicyMigrationStatus(value)[source]¶

Bases: str, enum.Enum

Describes the status of migration between backup policy types.

COMPLETED = 'Completed'¶

FAILED = 'Failed'¶

INVALID = 'Invalid'¶

IN_PROGRESS = 'InProgress'¶

class azure.mgmt.cosmosdb.models.BackupPolicyType(value)[source]¶

Bases: str, enum.Enum

Describes the mode of backups.

CONTINUOUS = 'Continuous'¶

PERIODIC = 'Periodic'¶

class azure.mgmt.cosmosdb.models.BackupResource(*, properties: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupResourceProperties] = None, **kwargs)[source]¶

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

A restorable backup of a Cassandra cluster.

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.

Parameters

properties (BackupResourceProperties) –

class azure.mgmt.cosmosdb.models.BackupResourceProperties(*, timestamp: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

BackupResourceProperties.

Parameters: timestamp (datetime) – The time this backup was taken, formatted like 2021-01-21T17:35:21.

class azure.mgmt.cosmosdb.models.BackupStorageRedundancy(value)[source]¶

Bases: str, enum.Enum

Enum to indicate type of backup storage redundancy.

GEO = 'Geo'¶

LOCAL = 'Local'¶

ZONE = 'Zone'¶

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, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (CassandraKeyspaceResource) – Required. The standard JSON format of a Cassandra keyspace.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.CassandraKeyspaceGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CassandraKeyspaceGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (CassandraKeyspaceGetPropertiesResource) –
options (CassandraKeyspaceGetPropertiesOptions) –

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[azure.mgmt.cosmosdb.models._models_py3.Column]] = None, partition_keys: Optional[List[azure.mgmt.cosmosdb.models._models_py3.CassandraPartitionKey]] = None, cluster_keys: Optional[List[azure.mgmt.cosmosdb.models._models_py3.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, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (CassandraTableResource) – Required. The standard JSON format of a Cassandra table.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.CassandraTableGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CassandraTableGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (CassandraTableGetPropertiesResource) –
options (CassandraTableGetPropertiesOptions) –

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[azure.mgmt.cosmosdb.models._models_py3.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.CassandraViewCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.CassandraViewResource, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = None, **kwargs)[source]¶

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

Parameters to create and update Cosmos DB Cassandra view.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (CassandraViewResource) – Required. The standard JSON format of a Cassandra view.
options (CreateUpdateOptions) – 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.CassandraViewGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.AutoscaleSettings] = None, **kwargs)[source]¶

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

CassandraViewGetPropertiesOptions.

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.CassandraViewGetPropertiesResource(*, id: str, view_definition: str, **kwargs)[source]¶

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

CassandraViewGetPropertiesResource.

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 view.
view_definition (str) – Required. View Definition of the Cosmos DB Cassandra view.

Variables

rid (str) – A system generated property. A unique identifier.
ts (float) – 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.CassandraViewGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.CassandraViewGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CassandraViewGetPropertiesOptions] = None, **kwargs)[source]¶

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

An Azure Cosmos DB Cassandra view.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (CassandraViewGetPropertiesResource) –
options (CassandraViewGetPropertiesOptions) –

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

Bases: msrest.serialization.Model

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

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

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

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

Bases: msrest.serialization.Model

Cosmos DB Cassandra view resource object.

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

Parameters

id (str) – Required. Name of the Cosmos DB Cassandra view.
view_definition (str) – Required. View Definition of the Cosmos DB Cassandra view.

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

Bases: msrest.serialization.Model

Certificate.

Parameters: pem (str) – PEM formatted public key.

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.ClusterNodeStatus(*, nodes: Optional[List[azure.mgmt.cosmosdb.models._models_py3.ClusterNodeStatusNodesItem]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The status of all nodes in the cluster (as returned by ‘nodetool status’).

Parameters: nodes (list[ClusterNodeStatusNodesItem]) – Information about nodes in the cluster (corresponds to what is returned from nodetool info).

class azure.mgmt.cosmosdb.models.ClusterNodeStatusNodesItem(*, datacenter: Optional[str] = None, status: Optional[str] = None, state: Optional[str] = None, address: Optional[str] = None, load: Optional[str] = None, tokens: Optional[List[str]] = None, owns: Optional[float] = None, host_id: Optional[str] = None, rack: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ClusterNodeStatusNodesItem.

Parameters

datacenter (str) – The Cassandra data center this node resides in.
status (str or NodeStatus) – Indicates whether the node is functioning or not. Possible values include: “Up”, “Down”.
state (str or NodeState) – The state of the node in relation to the cluster. Possible values include: “Normal”, “Leaving”, “Joining”, “Moving”, “Stopped”.
address (str) – The node’s URL.
load (str) – The amount of file system data in the data directory (e.g., 47.66 KB), excluding all content in the snapshots subdirectories. Because all SSTable data files are included, any data that is not cleaned up (such as TTL-expired cell or tombstoned data) is counted.
tokens (list[str]) – List of tokens.
owns (float) – The percentage of the data owned by the node per datacenter times the replication factor (e.g., 33.3, or null if the data is not available). For example, a node can own 33% of the ring, but shows 100% if the replication factor is 3. For non-system keyspaces, the endpoint percentage ownership information is shown.
host_id (str) – The network ID of the node.
rack (str) – The rack this node is part of.

class azure.mgmt.cosmosdb.models.ClusterResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, properties: Optional[azure.mgmt.cosmosdb.models._models_py3.ClusterResourceProperties] = None, **kwargs)[source]¶

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

Representation of a managed Cassandra cluster.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
properties (ClusterResourceProperties) – Properties of a managed Cassandra cluster.

class azure.mgmt.cosmosdb.models.ClusterResourceProperties(*, provisioning_state: Optional[str] = None, restore_from_backup_id: Optional[str] = None, delegated_management_subnet_id: Optional[str] = None, cassandra_version: Optional[str] = None, cluster_name_override: Optional[str] = None, authentication_method: Optional[str] = None, initial_cassandra_admin_password: Optional[str] = None, hours_between_backups: Optional[int] = None, prometheus_endpoint: Optional[azure.mgmt.cosmosdb.models._models_py3.SeedNode] = None, repair_enabled: Optional[bool] = None, client_certificates: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Certificate]] = None, external_gossip_certificates: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Certificate]] = None, external_seed_nodes: Optional[List[azure.mgmt.cosmosdb.models._models_py3.SeedNode]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of a managed Cassandra cluster.

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

Parameters

provisioning_state (str or ManagedCassandraProvisioningState) – The status of the resource at the time the operation was called. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”.
restore_from_backup_id (str) – To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
delegated_management_subnet_id (str) – Resource id of a subnet that this cluster’s management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form ‘/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>’.
cassandra_version (str) – Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
cluster_name_override (str) – If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
authentication_method (str or AuthenticationMethod) – Which authentication method Cassandra should use to authenticate clients. ‘None’ turns off authentication, so should not be used except in emergencies. ‘Cassandra’ is the default password based authentication. The default is ‘Cassandra’. Possible values include: “None”, “Cassandra”.
initial_cassandra_admin_password (str) – Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is ‘Cassandra’.
hours_between_backups (int) – Number of hours to wait between taking a backup of the cluster. To disable backups, set this property to 0.
prometheus_endpoint (SeedNode) – Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
repair_enabled (bool) – Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
client_certificates (list[Certificate]) – List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
external_gossip_certificates (list[Certificate]) – List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
external_seed_nodes (list[SeedNode]) – List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.

Variables

gossip_certificates (list[Certificate]) – List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
seed_nodes (list[SeedNode]) – List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.

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.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties.

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

Variables

principal_id (str) – The principal id of user assigned identity.
client_id (str) – The client id of user assigned identity.

class azure.mgmt.cosmosdb.models.CompositePath(*, path: Optional[str] = None, order: Optional[str] = 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.CompositePathSortOrder(value)[source]¶

Bases: str, enum.Enum

Sort order for composite paths.

ASCENDING = 'ascending'¶

DESCENDING = 'descending'¶

class azure.mgmt.cosmosdb.models.ConflictResolutionMode(value)[source]¶

Bases: str, enum.Enum

Indicates the conflict resolution mode.

CUSTOM = 'Custom'¶

LAST_WRITER_WINS = 'LastWriterWins'¶

class azure.mgmt.cosmosdb.models.ConflictResolutionPolicy(*, mode: Optional[str] = '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.ConnectorOffer(value)[source]¶

Bases: str, enum.Enum

The cassandra connector offer type for the Cosmos DB C* database account.

SMALL = 'Small'¶

class azure.mgmt.cosmosdb.models.ConsistencyPolicy(*, default_consistency_level: str, 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: Optional[str] = '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.

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

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. For MultiHash, multiple partition keys (upto three maximum) are supported for container create. Possible values include: “Hash”, “Range”, “MultiHash”. Default value: “Hash”.
version (int) – Indicates the version of the partition key definition.

Variables

system_key (bool) – Indicates if the container is using a system generated partition key.

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

Bases: msrest.serialization.Model

Information about the status of continuous backups.

Parameters: latest_restorable_timestamp (str) – The latest restorable timestamp for a resource.

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

Bases: msrest.serialization.Model

Properties of the regional restorable account.

Parameters: location (str) – The name of the continuous backup restore location.

class azure.mgmt.cosmosdb.models.ContinuousModeBackupPolicy(*, migration_state: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupPolicyMigrationState] = None, **kwargs)[source]¶

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

The object representing continuous mode backup policy.

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

Parameters

type (str or BackupPolicyType) – Required. Describes the mode of backups.Constant filled by server. Possible values include: “Periodic”, “Continuous”.
migration_state (BackupPolicyMigrationState) – The object representing the state of the migration between the backup policies.

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.CreateMode(value)[source]¶

Bases: str, enum.Enum

Enum to indicate the mode of account creation.

DEFAULT = 'Default'¶

RESTORE = 'Restore'¶

class azure.mgmt.cosmosdb.models.CreateUpdateOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.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.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.cosmosdb.models.DataCenterResource(*, properties: Optional[azure.mgmt.cosmosdb.models._models_py3.DataCenterResourceProperties] = None, **kwargs)[source]¶

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

A managed Cassandra data center.

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.

Parameters

properties (DataCenterResourceProperties) – Properties of a managed Cassandra data center.

class azure.mgmt.cosmosdb.models.DataCenterResourceProperties(*, provisioning_state: Optional[str] = None, data_center_location: Optional[str] = None, delegated_subnet_id: Optional[str] = None, node_count: Optional[int] = None, base64_encoded_cassandra_yaml_fragment: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of a managed Cassandra data center.

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

Parameters

provisioning_state (str or ManagedCassandraProvisioningState) – The status of the resource at the time the operation was called. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”.
data_center_location (str) – The region this data center should be created in.
delegated_subnet_id (str) – Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in ‘dataCenterLocation’ and must be able to route to the subnet specified in the cluster’s ‘delegatedManagementSubnetId’ property. This resource id will be of the form ‘/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>’.
node_count (int) – The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster.
base64_encoded_cassandra_yaml_fragment (str) – A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed.

Variables

seed_nodes (list[SeedNode]) – IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.

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

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

Resource for a regional service location.

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

Variables

name (str) – The regional service name.
location (str) – The location name.
status (str or ServiceStatus) – Describes the status of a service. Possible values include: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, “Stopped”.

class azure.mgmt.cosmosdb.models.DataTransferServiceResource(*, properties: Optional[azure.mgmt.cosmosdb.models._models_py3.DataTransferServiceResourceProperties] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Describes the service response property.

Parameters: properties (DataTransferServiceResourceProperties) – Properties for DataTransferServiceResource.

class azure.mgmt.cosmosdb.models.DataTransferServiceResourceProperties(*, additional_properties: Optional[Dict[str, Any]] = None, instance_size: Optional[str] = None, instance_count: Optional[int] = None, **kwargs)[source]¶

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

Properties for DataTransferServiceResource.

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

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
instance_size (str or ServiceSize) – Instance type for the service. Possible values include: “Cosmos.D4s”, “Cosmos.D8s”, “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – Required. ServiceType for the service.Constant filled by server. Possible values include: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”.

Variables

creation_time (datetime) – Time of the last state change (ISO-8601 format).
status (str or ServiceStatus) – Describes the status of a service. Possible values include: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, “Stopped”.
locations (list[DataTransferRegionalServiceResource]) – An array that contains all of the locations for the service.

class azure.mgmt.cosmosdb.models.DataType(value)[source]¶

Bases: str, enum.Enum

The datatype for which the indexing behavior is applied to.

LINE_STRING = 'LineString'¶

MULTI_POLYGON = 'MultiPolygon'¶

NUMBER = 'Number'¶

POINT = 'Point'¶

POLYGON = 'Polygon'¶

STRING = 'String'¶

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[azure.mgmt.cosmosdb.models._models_py3.Location], location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, kind: Optional[str] = None, consistency_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.ConsistencyPolicy] = None, ip_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, capabilities: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Capability]] = None, virtual_network_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Optional[str] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, default_identity: Optional[str] = None, public_network_access: Optional[str] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[azure.mgmt.cosmosdb.models._models_py3.ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, analytical_storage_configuration: Optional[azure.mgmt.cosmosdb.models._models_py3.AnalyticalStorageConfiguration] = None, backup_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupPolicy] = None, cors: Optional[List[azure.mgmt.cosmosdb.models._models_py3.CorsPolicy]] = None, network_acl_bypass: Optional[str] = None, network_acl_bypass_resource_ids: Optional[List[str]] = None, diagnostic_log_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.DiagnosticLogSettings] = None, disable_local_auth: Optional[bool] = None, restore_parameters: Optional[azure.mgmt.cosmosdb.models._models_py3.RestoreParameters] = 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) – The offer type for the database. Has constant value: “Standard”.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
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.
default_identity (str) – The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.
public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Possible values include: “Enabled”, “Disabled”.
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.
analytical_storage_configuration (AnalyticalStorageConfiguration) – Analytical storage specific properties.
create_mode (str or CreateMode) – Required. Enum to indicate the mode of account creation.Constant filled by server. Possible values include: “Default”, “Restore”. Default value: “Default”.
backup_policy (BackupPolicy) – The object representing the policy for taking backups on an account.
cors (list[CorsPolicy]) – The CORS policy for the Cosmos DB database account.
network_acl_bypass (str or NetworkAclBypass) – Indicates what services are allowed to bypass firewall checks. Possible values include: “None”, “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
diagnostic_log_settings (DiagnosticLogSettings) – The Object representing the different Diagnostic log settings for the Cosmos DB Account.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
restore_parameters (RestoreParameters) – Parameters to indicate the information about the restore.

database_account_offer_type = 'Standard'¶

class azure.mgmt.cosmosdb.models.DatabaseAccountCreateUpdateProperties(*, locations: List[azure.mgmt.cosmosdb.models._models_py3.Location], consistency_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.ConsistencyPolicy] = None, ip_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, capabilities: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Capability]] = None, virtual_network_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Optional[str] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, default_identity: Optional[str] = None, public_network_access: Optional[str] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[azure.mgmt.cosmosdb.models._models_py3.ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, analytical_storage_configuration: Optional[azure.mgmt.cosmosdb.models._models_py3.AnalyticalStorageConfiguration] = None, backup_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupPolicy] = None, cors: Optional[List[azure.mgmt.cosmosdb.models._models_py3.CorsPolicy]] = None, network_acl_bypass: Optional[str] = None, network_acl_bypass_resource_ids: Optional[List[str]] = None, diagnostic_log_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.DiagnosticLogSettings] = None, disable_local_auth: Optional[bool] = None, restore_parameters: Optional[azure.mgmt.cosmosdb.models._models_py3.RestoreParameters] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties to create and update Azure Cosmos DB database accounts.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DefaultRequestDatabaseAccountCreateUpdateProperties.

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

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.
default_identity (str) – The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.
public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Possible values include: “Enabled”, “Disabled”.
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.
analytical_storage_configuration (AnalyticalStorageConfiguration) – Analytical storage specific properties.
create_mode (str or CreateMode) – Required. Enum to indicate the mode of account creation.Constant filled by server. Possible values include: “Default”, “Restore”. Default value: “Default”.
backup_policy (BackupPolicy) – The object representing the policy for taking backups on an account.
cors (list[CorsPolicy]) – The CORS policy for the Cosmos DB database account.
network_acl_bypass (str or NetworkAclBypass) – Indicates what services are allowed to bypass firewall checks. Possible values include: “None”, “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
diagnostic_log_settings (DiagnosticLogSettings) – The Object representing the different Diagnostic log settings for the Cosmos DB Account.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
restore_parameters (RestoreParameters) – Parameters to indicate the information about the restore.

Variables

database_account_offer_type (str) – The offer type for the database. Has constant value: “Standard”.

database_account_offer_type = 'Standard'¶

class azure.mgmt.cosmosdb.models.DatabaseAccountGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, kind: Optional[str] = None, ip_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, consistency_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.ConsistencyPolicy] = None, capabilities: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Capability]] = None, virtual_network_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Optional[str] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, default_identity: Optional[str] = None, public_network_access: Optional[str] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[azure.mgmt.cosmosdb.models._models_py3.ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, analytical_storage_configuration: Optional[azure.mgmt.cosmosdb.models._models_py3.AnalyticalStorageConfiguration] = None, create_mode: Optional[str] = 'Default', restore_parameters: Optional[azure.mgmt.cosmosdb.models._models_py3.RestoreParameters] = None, backup_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupPolicy] = None, cors: Optional[List[azure.mgmt.cosmosdb.models._models_py3.CorsPolicy]] = None, network_acl_bypass: Optional[str] = None, network_acl_bypass_resource_ids: Optional[List[str]] = None, diagnostic_log_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.DiagnosticLogSettings] = None, disable_local_auth: Optional[bool] = 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.
system_data (SystemData) – The system meta data relating to this 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. The only acceptable values to pass in are None and “Standard”. The default value is None.
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.
instance_id (str) – A unique identifier assigned to the database account.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
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.
default_identity (str) – The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.
public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Possible values include: “Enabled”, “Disabled”.
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.
analytical_storage_configuration (AnalyticalStorageConfiguration) – Analytical storage specific properties.
create_mode (str or CreateMode) – Enum to indicate the mode of account creation. Possible values include: “Default”, “Restore”. Default value: “Default”.
restore_parameters (RestoreParameters) – Parameters to indicate the information about the restore.
backup_policy (BackupPolicy) – The object representing the policy for taking backups on an account.
cors (list[CorsPolicy]) – The CORS policy for the Cosmos DB database account.
network_acl_bypass (str or NetworkAclBypass) – Indicates what services are allowed to bypass firewall checks. Possible values include: “None”, “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
diagnostic_log_settings (DiagnosticLogSettings) – The Object representing the different Diagnostic log settings for the Cosmos DB Account.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

class azure.mgmt.cosmosdb.models.DatabaseAccountKind(value)[source]¶

Bases: str, enum.Enum

Indicates the type of database account. This can only be set at database account creation.

GLOBAL_DOCUMENT_DB = 'GlobalDocumentDB'¶

MONGO_DB = 'MongoDB'¶

PARSE = 'Parse'¶

class azure.mgmt.cosmosdb.models.DatabaseAccountListConnectionStringsResult(*, connection_strings: Optional[List[azure.mgmt.cosmosdb.models._models_py3.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: str, **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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, consistency_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.ConsistencyPolicy] = None, locations: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Location]] = None, ip_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, capabilities: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Capability]] = None, virtual_network_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Optional[str] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, default_identity: Optional[str] = None, public_network_access: Optional[str] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[azure.mgmt.cosmosdb.models._models_py3.ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, analytical_storage_configuration: Optional[azure.mgmt.cosmosdb.models._models_py3.AnalyticalStorageConfiguration] = None, backup_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupPolicy] = None, cors: Optional[List[azure.mgmt.cosmosdb.models._models_py3.CorsPolicy]] = None, network_acl_bypass: Optional[str] = None, network_acl_bypass_resource_ids: Optional[List[str]] = None, diagnostic_log_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.DiagnosticLogSettings] = None, disable_local_auth: Optional[bool] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters for patching Azure Cosmos DB database account properties.

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.
identity (ManagedServiceIdentity) – Identity for the resource.
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.
default_identity (str) – The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.
public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Possible values include: “Enabled”, “Disabled”.
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.
analytical_storage_configuration (AnalyticalStorageConfiguration) – Analytical storage specific properties.
backup_policy (BackupPolicy) – The object representing the policy for taking backups on an account.
cors (list[CorsPolicy]) – The CORS policy for the Cosmos DB database account.
network_acl_bypass (str or NetworkAclBypass) – Indicates what services are allowed to bypass firewall checks. Possible values include: “None”, “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
diagnostic_log_settings (DiagnosticLogSettings) – The Object representing the different Diagnostic log settings for the Cosmos DB Account.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

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.DatabaseRestoreResource(*, database_name: Optional[str] = None, collection_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Specific Databases to restore.

Parameters

database_name (str) – The name of the database available for restore.
collection_names (list[str]) – The names of the collections available for restore.

class azure.mgmt.cosmosdb.models.DefaultConsistencyLevel(value)[source]¶

Bases: str, enum.Enum

The default consistency level and configuration settings of the Cosmos DB account.

BOUNDED_STALENESS = 'BoundedStaleness'¶

CONSISTENT_PREFIX = 'ConsistentPrefix'¶

EVENTUAL = 'Eventual'¶

SESSION = 'Session'¶

STRONG = 'Strong'¶

class azure.mgmt.cosmosdb.models.DefaultRequestDatabaseAccountCreateUpdateProperties(*, locations: List[azure.mgmt.cosmosdb.models._models_py3.Location], consistency_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.ConsistencyPolicy] = None, ip_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, capabilities: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Capability]] = None, virtual_network_rules: Optional[List[azure.mgmt.cosmosdb.models._models_py3.VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Optional[str] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, default_identity: Optional[str] = None, public_network_access: Optional[str] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[azure.mgmt.cosmosdb.models._models_py3.ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, analytical_storage_configuration: Optional[azure.mgmt.cosmosdb.models._models_py3.AnalyticalStorageConfiguration] = None, backup_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupPolicy] = None, cors: Optional[List[azure.mgmt.cosmosdb.models._models_py3.CorsPolicy]] = None, network_acl_bypass: Optional[str] = None, network_acl_bypass_resource_ids: Optional[List[str]] = None, diagnostic_log_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.DiagnosticLogSettings] = None, disable_local_auth: Optional[bool] = None, restore_parameters: Optional[azure.mgmt.cosmosdb.models._models_py3.RestoreParameters] = None, **kwargs)[source]¶

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

Properties for non-restore Azure Cosmos DB database account requests.

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

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.
default_identity (str) – The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.
public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Possible values include: “Enabled”, “Disabled”.
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.
analytical_storage_configuration (AnalyticalStorageConfiguration) – Analytical storage specific properties.
create_mode (str or CreateMode) – Required. Enum to indicate the mode of account creation.Constant filled by server. Possible values include: “Default”, “Restore”. Default value: “Default”.
backup_policy (BackupPolicy) – The object representing the policy for taking backups on an account.
cors (list[CorsPolicy]) – The CORS policy for the Cosmos DB database account.
network_acl_bypass (str or NetworkAclBypass) – Indicates what services are allowed to bypass firewall checks. Possible values include: “None”, “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
diagnostic_log_settings (DiagnosticLogSettings) – The Object representing the different Diagnostic log settings for the Cosmos DB Account.
disable_local_auth (bool) – Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
restore_parameters (RestoreParameters) – Parameters to indicate the information about the restore.

Variables

database_account_offer_type (str) – The offer type for the database. Has constant value: “Standard”.

create_mode: Optional[str]¶

database_account_offer_type = 'Standard'¶

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

Bases: msrest.serialization.Model

Indicates what diagnostic log settings are to be enabled.

Parameters: enable_full_text_query (str or EnableFullTextQuery) – Describe the level of detail with which queries are to be logged. Possible values include: “None”, “True”, “False”.

class azure.mgmt.cosmosdb.models.EnableFullTextQuery(value)[source]¶

Bases: str, enum.Enum

Describe the level of detail with which queries are to be logged.

FALSE = 'False'¶

NONE = 'None'¶

TRUE = 'True'¶

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 (float) – 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[azure.mgmt.cosmosdb.models._models_py3.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.GraphAPIComputeRegionalServiceResource(**kwargs)[source]¶

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

Resource for a regional service location.

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

Variables

name (str) – The regional service name.
location (str) – The location name.
status (str or ServiceStatus) – Describes the status of a service. Possible values include: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, “Stopped”.
graph_api_compute_endpoint (str) – The regional endpoint for GraphAPICompute.

class azure.mgmt.cosmosdb.models.GraphAPIComputeServiceResource(*, properties: Optional[azure.mgmt.cosmosdb.models._models_py3.GraphAPIComputeServiceResourceProperties] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Describes the service response property for GraphAPICompute.

Parameters: properties (GraphAPIComputeServiceResourceProperties) – Properties for GraphAPIComputeServiceResource.

class azure.mgmt.cosmosdb.models.GraphAPIComputeServiceResourceProperties(*, additional_properties: Optional[Dict[str, Any]] = None, instance_size: Optional[str] = None, instance_count: Optional[int] = None, graph_api_compute_endpoint: Optional[str] = None, **kwargs)[source]¶

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

Properties for GraphAPIComputeServiceResource.

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

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
instance_size (str or ServiceSize) – Instance type for the service. Possible values include: “Cosmos.D4s”, “Cosmos.D8s”, “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – Required. ServiceType for the service.Constant filled by server. Possible values include: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”.
graph_api_compute_endpoint (str) – GraphAPICompute endpoint for the service.

Variables

creation_time (datetime) – Time of the last state change (ISO-8601 format).
status (str or ServiceStatus) – Describes the status of a service. Possible values include: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, “Stopped”.
locations (list[GraphAPIComputeRegionalServiceResource]) – An array that contains all of the locations for the service.

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

Bases: msrest.serialization.Model

Cosmos DB Graph resource object.

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

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

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

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

Parameters to create and update Cosmos DB Graph resource.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (GraphResource) – Required. The standard JSON format of a Graph resource.
options (CreateUpdateOptions) – 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.GraphResourceGetPropertiesOptions(*, throughput: Optional[int] = None, autoscale_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.AutoscaleSettings] = None, **kwargs)[source]¶

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

GraphResourceGetPropertiesOptions.

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.GraphResourceGetPropertiesResource(*, id: str, **kwargs)[source]¶

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

GraphResourceGetPropertiesResource.

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 (float) – 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 Graph.

class azure.mgmt.cosmosdb.models.GraphResourceGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.GraphResourceGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.GraphResourceGetPropertiesOptions] = None, **kwargs)[source]¶

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

An Azure Cosmos DB Graph 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 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (GraphResourceGetPropertiesResource) –
options (GraphResourceGetPropertiesOptions) –

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

Bases: msrest.serialization.Model

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

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

Variables: value (list[GraphResourceGetResults]) – List of Graph resource and their properties.

class azure.mgmt.cosmosdb.models.GremlinDatabaseCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseResource, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (GremlinDatabaseResource) – Required. The standard JSON format of a Gremlin database.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (GremlinDatabaseGetPropertiesResource) –
options (GremlinDatabaseGetPropertiesOptions) –

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, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (GremlinGraphResource) – Required. The standard JSON format of a Gremlin graph.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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[azure.mgmt.cosmosdb.models._models_py3.IndexingPolicy] = None, partition_key: Optional[azure.mgmt.cosmosdb.models._models_py3.ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.GremlinGraphGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.GremlinGraphGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (GremlinGraphGetPropertiesResource) –
options (GremlinGraphGetPropertiesOptions) –

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[azure.mgmt.cosmosdb.models._models_py3.IndexingPolicy] = None, partition_key: Optional[azure.mgmt.cosmosdb.models._models_py3.ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.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[azure.mgmt.cosmosdb.models._models_py3.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.IndexKind(value)[source]¶

Bases: str, enum.Enum

Indicates the type of index.

HASH = 'Hash'¶

RANGE = 'Range'¶

SPATIAL = 'Spatial'¶

class azure.mgmt.cosmosdb.models.Indexes(*, data_type: Optional[str] = 'String', precision: Optional[int] = None, kind: Optional[str] = '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.IndexingMode(value)[source]¶

Bases: str, enum.Enum

Indicates the indexing mode.

CONSISTENT = 'consistent'¶

LAZY = 'lazy'¶

NONE = 'none'¶

class azure.mgmt.cosmosdb.models.IndexingPolicy(*, automatic: Optional[bool] = None, indexing_mode: Optional[str] = 'consistent', included_paths: Optional[List[azure.mgmt.cosmosdb.models._models_py3.IncludedPath]] = None, excluded_paths: Optional[List[azure.mgmt.cosmosdb.models._models_py3.ExcludedPath]] = None, composite_indexes: Optional[List[List[azure.mgmt.cosmosdb.models._models_py3.CompositePath]]] = None, spatial_indexes: Optional[List[azure.mgmt.cosmosdb.models._models_py3.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.KeyKind(value)[source]¶

Bases: str, enum.Enum

The access key to regenerate.

PRIMARY = 'primary'¶

PRIMARY_READONLY = 'primaryReadonly'¶

SECONDARY = 'secondary'¶

SECONDARY_READONLY = 'secondaryReadonly'¶

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

Bases: msrest.serialization.Model

List of restorable backups for a Cassandra cluster.

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

Variables: value (list[BackupResource]) – Container for array of backups.

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

Bases: msrest.serialization.Model

List of managed Cassandra clusters.

Parameters: value (list[ClusterResource]) – Container for the array of clusters.

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

Bases: msrest.serialization.Model

List of managed Cassandra data centers and their properties.

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

Variables: value (list[DataCenterResource]) – Container for array of data centers.

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.LocationGetResult(*, properties: Optional[azure.mgmt.cosmosdb.models._models_py3.LocationProperties] = None, **kwargs)[source]¶

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

Cosmos DB location get result.

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.

Parameters

properties (LocationProperties) – Cosmos DB location metadata.

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

Bases: msrest.serialization.Model

The List operation response, that contains Cosmos DB locations and their properties.

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

Variables: value (list[LocationGetResult]) – List of Cosmos DB locations and their properties.

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

Bases: msrest.serialization.Model

Cosmos DB location metadata.

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

Variables

status (str) – The current status of location in Azure.
supports_availability_zone (bool) – Flag indicating whether the location supports availability zones or not.
is_residency_restricted (bool) – Flag indicating whether the location is residency sensitive.
backup_storage_redundancies (list[str or BackupStorageRedundancy]) – The properties of available backup storage redundancies.

class azure.mgmt.cosmosdb.models.ManagedCassandraProvisioningState(value)[source]¶

Bases: str, enum.Enum

The status of the resource at the time the operation was called.

CANCELED = 'Canceled'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.cosmosdb.models.ManagedServiceIdentity(*, type: Optional[str] = None, user_assigned_identities: Optional[Dict[str, azure.mgmt.cosmosdb.models._models_py3.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Identity for the resource.

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

Variables

principal_id (str) – The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

Parameters

type (str or ResourceIdentityType) – The type of identity used for the resource. The type ‘SystemAssigned,UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. Possible values include: “SystemAssigned”, “UserAssigned”, “SystemAssigned,UserAssigned”, “None”.
user_assigned_identities (dict[str, Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties]) – The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

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, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (MongoDBCollectionResource) – Required. The standard JSON format of a MongoDB collection.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.MongoDBCollectionGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.MongoDBCollectionGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (MongoDBCollectionGetPropertiesResource) –
options (MongoDBCollectionGetPropertiesOptions) –

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[azure.mgmt.cosmosdb.models._models_py3.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, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (MongoDBDatabaseResource) – Required. The standard JSON format of a MongoDB database.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.MongoDBDatabaseGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.MongoDBDatabaseGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (MongoDBDatabaseGetPropertiesResource) –
options (MongoDBDatabaseGetPropertiesOptions) –

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[azure.mgmt.cosmosdb.models._models_py3.MongoIndexKeys] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.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.NetworkAclBypass(value)[source]¶

Bases: str, enum.Enum

Indicates what services are allowed to bypass firewall checks.

AZURE_SERVICES = 'AzureServices'¶

NONE = 'None'¶

class azure.mgmt.cosmosdb.models.NodeState(value)[source]¶

Bases: str, enum.Enum

The state of the node in relation to the cluster.

JOINING = 'Joining'¶

LEAVING = 'Leaving'¶

MOVING = 'Moving'¶

NORMAL = 'Normal'¶

STOPPED = 'Stopped'¶

class azure.mgmt.cosmosdb.models.NodeStatus(value)[source]¶

Bases: str, enum.Enum

Indicates whether the node is functioning or not.

DOWN = 'Down'¶

UP = 'Up'¶

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[azure.mgmt.cosmosdb.models._models_py3.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.NotebookWorkspaceName(value)[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

class azure.mgmt.cosmosdb.models.Operation(*, name: Optional[str] = None, display: Optional[azure.mgmt.cosmosdb.models._models_py3.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[azure.mgmt.cosmosdb.models._models_py3.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.OperationType(value)[source]¶

Bases: str, enum.Enum

Enum to indicate the operation type of the event.

CREATE = 'Create'¶

DELETE = 'Delete'¶

REPLACE = 'Replace'¶

SYSTEM_OPERATION = 'SystemOperation'¶

class azure.mgmt.cosmosdb.models.OptionsResource(*, throughput: Optional[int] = None, autoscale_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.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.PartitionKind(value)[source]¶

Bases: str, enum.Enum

Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create

HASH = 'Hash'¶

MULTI_HASH = 'MultiHash'¶

RANGE = 'Range'¶

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.PeriodicModeBackupPolicy(*, migration_state: Optional[azure.mgmt.cosmosdb.models._models_py3.BackupPolicyMigrationState] = None, periodic_mode_properties: Optional[azure.mgmt.cosmosdb.models._models_py3.PeriodicModeProperties] = None, **kwargs)[source]¶

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

The object representing periodic mode backup policy.

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

Parameters

type (str or BackupPolicyType) – Required. Describes the mode of backups.Constant filled by server. Possible values include: “Periodic”, “Continuous”.
migration_state (BackupPolicyMigrationState) – The object representing the state of the migration between the backup policies.
periodic_mode_properties (PeriodicModeProperties) – Configuration values for periodic mode backup.

class azure.mgmt.cosmosdb.models.PeriodicModeProperties(*, backup_interval_in_minutes: Optional[int] = None, backup_retention_interval_in_hours: Optional[int] = None, backup_storage_redundancy: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Configuration values for periodic mode backup.

Parameters

backup_interval_in_minutes (int) – An integer representing the interval in minutes between two backups.
backup_retention_interval_in_hours (int) – An integer representing the time (in hours) that each backup is retained.
backup_storage_redundancy (str or BackupStorageRedundancy) – Enum to indicate type of backup residency. Possible values include: “Geo”, “Local”, “Zone”.

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

Bases: msrest.serialization.Model

The set of data plane operations permitted through this Role Definition.

Parameters

data_actions (list[str]) – An array of data actions that are allowed.
not_data_actions (list[str]) – An array of data actions that are denied.

class azure.mgmt.cosmosdb.models.PrimaryAggregationType(value)[source]¶

Bases: str, enum.Enum

The primary aggregation type of the metric.

AVERAGE = 'Average'¶

LAST = 'Last'¶

MAXIMUM = 'Maximum'¶

MINIMUM = 'Minimum'¶

NONE = 'None'¶

TOTAL = 'Total'¶

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

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

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. E.g. “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.
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[azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of private endpoint connections.

Parameters: value (list[PrivateEndpointConnection]) – 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[azure.mgmt.cosmosdb.models._models_py3.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, 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 Azure Resource Manager proxy resource. It will not have tags and a location.

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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.cosmosdb.models.PublicNetworkAccess(value)[source]¶

Bases: str, enum.Enum

Whether requests from Public Network are allowed

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

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.RegionalServiceResource(**kwargs)[source]¶

Bases: msrest.serialization.Model

Resource for a regional service location.

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

Variables

name (str) – The regional service name.
location (str) – The location name.
status (str or ServiceStatus) – Describes the status of a service. Possible values include: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, “Stopped”.

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

Bases: msrest.serialization.Model

Specification of the keyspaces and tables to run repair on.

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

Parameters

keyspace (str) – Required. The name of the keyspace that repair should be run on.
tables (list[str]) – List of tables in the keyspace to repair. If omitted, repair all tables in the keyspace.

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

Bases: msrest.serialization.Model

Common fields that are returned in the response for all Azure Resource Manager resources.

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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.cosmosdb.models.ResourceIdentityType(value)[source]¶

Bases: str, enum.Enum

The type of identity used for the resource. The type ‘SystemAssigned,UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

NONE = 'None'¶

SYSTEM_ASSIGNED = 'SystemAssigned'¶

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned'¶

USER_ASSIGNED = 'UserAssigned'¶

class azure.mgmt.cosmosdb.models.RestorableDatabaseAccountGetResult(*, location: Optional[str] = None, account_name: Optional[str] = None, creation_time: Optional[datetime.datetime] = None, deletion_time: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A Azure Cosmos DB restorable 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.
api_type (str or ApiType) – The API type of the restorable database account. Possible values include: “MongoDB”, “Gremlin”, “Cassandra”, “Table”, “Sql”, “GremlinV2”.
restorable_locations (list[RestorableLocationResource]) – List of regions where the of the database account can be restored from.

Parameters

location (str) – The location of the resource group to which the resource belongs.
account_name (str) – The name of the global database account.
creation_time (datetime) – The creation time of the restorable database account (ISO-8601 format).
deletion_time (datetime) – The time at which the restorable database account has been deleted (ISO-8601 format).

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

Bases: msrest.serialization.Model

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

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

Variables: value (list[RestorableDatabaseAccountGetResult]) – List of restorable database accounts and their properties.

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

Bases: msrest.serialization.Model

Properties of the regional restorable account.

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

Variables

location_name (str) – The location of the regional restorable account.
regional_database_account_instance_id (str) – The instance id of the regional restorable account.
creation_time (datetime) – The creation time of the regional restorable database account (ISO-8601 format).
deletion_time (datetime) – The time at which the regional restorable database account has been deleted (ISO-8601 format).

class azure.mgmt.cosmosdb.models.RestorableMongodbCollectionGetResult(*, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.RestorableMongodbCollectionPropertiesResource] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An Azure Cosmos DB MongoDB collection event.

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

resource (RestorableMongodbCollectionPropertiesResource) – The resource of an Azure Cosmos DB MongoDB collection event.

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

Bases: msrest.serialization.Model

The resource of an Azure Cosmos DB MongoDB collection event.

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.
operation_type (str or OperationType) – The operation type of this collection event. Possible values include: “Create”, “Replace”, “Delete”, “SystemOperation”.
event_timestamp (str) – The time when this collection event happened.
owner_id (str) – The name of this MongoDB collection.
owner_resource_id (str) – The resource ID of this MongoDB collection.

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

Bases: msrest.serialization.Model

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

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

Variables: value (list[RestorableMongodbCollectionGetResult]) – List of MongoDB collection events and their properties.

class azure.mgmt.cosmosdb.models.RestorableMongodbDatabaseGetResult(*, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.RestorableMongodbDatabasePropertiesResource] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An Azure Cosmos DB MongoDB database event.

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

resource (RestorableMongodbDatabasePropertiesResource) – The resource of an Azure Cosmos DB MongoDB database event.

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

Bases: msrest.serialization.Model

The resource of an Azure Cosmos DB MongoDB database event.

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.
operation_type (str or OperationType) – The operation type of this database event. Possible values include: “Create”, “Replace”, “Delete”, “SystemOperation”.
event_timestamp (str) – The time when this database event happened.
owner_id (str) – The name of this MongoDB database.
owner_resource_id (str) – The resource ID of this MongoDB database.

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

Bases: msrest.serialization.Model

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

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

Variables: value (list[RestorableMongodbDatabaseGetResult]) – List of MongoDB database events and their properties.

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

Bases: msrest.serialization.Model

The List operation response, that contains the restorable MongoDB resources.

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

Variables: value (list[DatabaseRestoreResource]) – List of restorable MongoDB resources, including the database and collection names.

class azure.mgmt.cosmosdb.models.RestorableSqlContainerGetResult(*, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlContainerPropertiesResource] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An Azure Cosmos DB SQL container event.

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

resource (RestorableSqlContainerPropertiesResource) – The resource of an Azure Cosmos DB SQL container event.

class azure.mgmt.cosmosdb.models.RestorableSqlContainerPropertiesResource(*, container: Optional[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlContainerPropertiesResourceContainer] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The resource of an Azure Cosmos DB SQL container event.

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.
operation_type (str or OperationType) – The operation type of this container event. Possible values include: “Create”, “Replace”, “Delete”, “SystemOperation”.
event_timestamp (str) – The when this container event happened.
owner_id (str) – The name of this SQL container.
owner_resource_id (str) – The resource ID of this SQL container.

Parameters

container (RestorableSqlContainerPropertiesResourceContainer) – Cosmos DB SQL container resource object.

class azure.mgmt.cosmosdb.models.RestorableSqlContainerPropertiesResourceContainer(*, id: str, indexing_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.IndexingPolicy] = None, partition_key: Optional[azure.mgmt.cosmosdb.models._models_py3.ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.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

Cosmos DB SQL container resource 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

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 (float) – 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.
self_property (str) – A system generated property that specifies the addressable path of the container resource.

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

Bases: msrest.serialization.Model

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

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

Variables: value (list[RestorableSqlContainerGetResult]) – List of SQL container events and their properties.

class azure.mgmt.cosmosdb.models.RestorableSqlDatabaseGetResult(*, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlDatabasePropertiesResource] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An Azure Cosmos DB SQL database event.

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

resource (RestorableSqlDatabasePropertiesResource) – The resource of an Azure Cosmos DB SQL database event.

class azure.mgmt.cosmosdb.models.RestorableSqlDatabasePropertiesResource(*, database: Optional[azure.mgmt.cosmosdb.models._models_py3.RestorableSqlDatabasePropertiesResourceDatabase] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The resource of an Azure Cosmos DB SQL database event.

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.
operation_type (str or OperationType) – The operation type of this database event. Possible values include: “Create”, “Replace”, “Delete”, “SystemOperation”.
event_timestamp (str) – The time when this database event happened.
owner_id (str) – The name of the SQL database.
owner_resource_id (str) – The resource ID of the SQL database.

Parameters

database (RestorableSqlDatabasePropertiesResourceDatabase) – Cosmos DB SQL database resource object.

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

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

Cosmos DB SQL database resource 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

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

Variables

rid (str) – A system generated property. A unique identifier.
ts (float) – 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.
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.
self_property (str) – A system generated property that specifies the addressable path of the database resource.

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

Bases: msrest.serialization.Model

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

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

Variables: value (list[RestorableSqlDatabaseGetResult]) – List of SQL database events and their properties.

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

Bases: msrest.serialization.Model

The List operation response, that contains the restorable SQL resources.

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

Variables: value (list[DatabaseRestoreResource]) – List of restorable SQL resources, including the database and collection names.

class azure.mgmt.cosmosdb.models.RestoreMode(value)[source]¶

Bases: str, enum.Enum

Describes the mode of the restore.

POINT_IN_TIME = 'PointInTime'¶

class azure.mgmt.cosmosdb.models.RestoreParameters(*, restore_mode: Optional[str] = None, restore_source: Optional[str] = None, restore_timestamp_in_utc: Optional[datetime.datetime] = None, databases_to_restore: Optional[List[azure.mgmt.cosmosdb.models._models_py3.DatabaseRestoreResource]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters to indicate the information about the restore.

Parameters

restore_mode (str or RestoreMode) – Describes the mode of the restore. Possible values include: “PointInTime”.
restore_source (str) – The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}.
restore_timestamp_in_utc (datetime) – Time to which the account has to be restored (ISO-8601 format).
databases_to_restore (list[DatabaseRestoreResource]) – List of specific databases available for restore.

class azure.mgmt.cosmosdb.models.RoleDefinitionType(value)[source]¶

Bases: str, enum.Enum

Indicates whether the Role Definition was built-in or user created.

BUILT_IN_ROLE = 'BuiltInRole'¶

CUSTOM_ROLE = 'CustomRole'¶

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

Bases: msrest.serialization.Model

SeedNode.

Parameters: ip_address (str) – IP address of this seed node.

class azure.mgmt.cosmosdb.models.ServerVersion(value)[source]¶

Bases: str, enum.Enum

Describes the ServerVersion of an a MongoDB account.

FOUR0 = '4.0'¶

THREE2 = '3.2'¶

THREE6 = '3.6'¶

class azure.mgmt.cosmosdb.models.ServiceResource(*, properties: Optional[azure.mgmt.cosmosdb.models._models_py3.ServiceResourceProperties] = None, **kwargs)[source]¶

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

Properties for the 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 database account.
name (str) – The name of the database account.
type (str) – The type of Azure resource.

Parameters

properties (ServiceResourceProperties) – Services response resource.

class azure.mgmt.cosmosdb.models.ServiceResourceCreateUpdateParameters(*, instance_size: Optional[str] = None, instance_count: Optional[int] = None, service_type: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters for Create or Update Request for ServiceResource.

Parameters

instance_size (str or ServiceSize) – Instance type for the service. Possible values include: “Cosmos.D4s”, “Cosmos.D8s”, “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – ServiceType for the service. Possible values include: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”.

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

Bases: msrest.serialization.Model

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

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

Variables: value (list[ServiceResource]) – List of Service Resource and their properties.

class azure.mgmt.cosmosdb.models.ServiceResourceProperties(*, additional_properties: Optional[Dict[str, Any]] = None, instance_size: Optional[str] = None, instance_count: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Services response resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DataTransferServiceResourceProperties, GraphAPIComputeServiceResourceProperties, SqlDedicatedGatewayServiceResourceProperties.

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

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
instance_size (str or ServiceSize) – Instance type for the service. Possible values include: “Cosmos.D4s”, “Cosmos.D8s”, “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – Required. ServiceType for the service.Constant filled by server. Possible values include: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”.

Variables

creation_time (datetime) – Time of the last state change (ISO-8601 format).
status (str or ServiceStatus) – Describes the status of a service. Possible values include: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, “Stopped”.

class azure.mgmt.cosmosdb.models.ServiceSize(value)[source]¶

Bases: str, enum.Enum

Instance type for the service.

COSMOS_D16_S = 'Cosmos.D16s'¶

COSMOS_D4_S = 'Cosmos.D4s'¶

COSMOS_D8_S = 'Cosmos.D8s'¶

class azure.mgmt.cosmosdb.models.ServiceStatus(value)[source]¶

Bases: str, enum.Enum

Describes the status of a service.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

ERROR = 'Error'¶

RUNNING = 'Running'¶

STOPPED = 'Stopped'¶

UPDATING = 'Updating'¶

class azure.mgmt.cosmosdb.models.ServiceType(value)[source]¶

Bases: str, enum.Enum

ServiceType for the service.

DATA_TRANSFER = 'DataTransfer'¶

GRAPH_API_COMPUTE = 'GraphAPICompute'¶

SQL_DEDICATED_GATEWAY = 'SqlDedicatedGateway'¶

class azure.mgmt.cosmosdb.models.SpatialSpec(*, path: Optional[str] = None, types: Optional[List[str]] = 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.SpatialType(value)[source]¶

Bases: str, enum.Enum

Indicates the spatial type of index.

LINE_STRING = 'LineString'¶

MULTI_POLYGON = 'MultiPolygon'¶

POINT = 'Point'¶

POLYGON = 'Polygon'¶

class azure.mgmt.cosmosdb.models.SqlContainerCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.SqlContainerResource, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (SqlContainerResource) – Required. The standard JSON format of a container.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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[azure.mgmt.cosmosdb.models._models_py3.IndexingPolicy] = None, partition_key: Optional[azure.mgmt.cosmosdb.models._models_py3.ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.SqlContainerGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.SqlContainerGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (SqlContainerGetPropertiesResource) –
options (SqlContainerGetPropertiesOptions) –

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[azure.mgmt.cosmosdb.models._models_py3.IndexingPolicy] = None, partition_key: Optional[azure.mgmt.cosmosdb.models._models_py3.ContainerPartitionKey] = None, default_ttl: Optional[int] = None, unique_key_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.UniqueKeyPolicy] = None, conflict_resolution_policy: Optional[azure.mgmt.cosmosdb.models._models_py3.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, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (SqlDatabaseResource) – Required. The standard JSON format of a SQL database.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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.ExtendedResourceProperties, azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseResource

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.

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.

Variables

rid (str) – A system generated property. A unique identifier.
ts (float) – 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.SqlDatabaseGetResults(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.SqlDatabaseGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (SqlDatabaseGetPropertiesResource) –
options (SqlDatabaseGetPropertiesOptions) –

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.SqlDedicatedGatewayRegionalServiceResource(**kwargs)[source]¶

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

Resource for a regional service location.

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

Variables

name (str) – The regional service name.
location (str) – The location name.
status (str or ServiceStatus) – Describes the status of a service. Possible values include: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, “Stopped”.
sql_dedicated_gateway_endpoint (str) – The regional endpoint for SqlDedicatedGateway.

class azure.mgmt.cosmosdb.models.SqlDedicatedGatewayServiceResource(*, properties: Optional[azure.mgmt.cosmosdb.models._models_py3.SqlDedicatedGatewayServiceResourceProperties] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Describes the service response property for SqlDedicatedGateway.

Parameters: properties (SqlDedicatedGatewayServiceResourceProperties) – Properties for SqlDedicatedGatewayServiceResource.

class azure.mgmt.cosmosdb.models.SqlDedicatedGatewayServiceResourceProperties(*, additional_properties: Optional[Dict[str, Any]] = None, instance_size: Optional[str] = None, instance_count: Optional[int] = None, sql_dedicated_gateway_endpoint: Optional[str] = None, **kwargs)[source]¶

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

Properties for SqlDedicatedGatewayServiceResource.

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

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
instance_size (str or ServiceSize) – Instance type for the service. Possible values include: “Cosmos.D4s”, “Cosmos.D8s”, “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – Required. ServiceType for the service.Constant filled by server. Possible values include: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”.
sql_dedicated_gateway_endpoint (str) – SqlDedicatedGateway endpoint for the service.

Variables

creation_time (datetime) – Time of the last state change (ISO-8601 format).
status (str or ServiceStatus) – Describes the status of a service. Possible values include: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, “Stopped”.
locations (list[SqlDedicatedGatewayRegionalServiceResource]) – An array that contains all of the locations for the service.

class azure.mgmt.cosmosdb.models.SqlRoleAssignmentCreateUpdateParameters(*, role_definition_id: Optional[str] = None, scope: Optional[str] = None, principal_id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters to create and update an Azure Cosmos DB SQL Role Assignment.

Parameters

role_definition_id (str) – The unique identifier for the associated Role Definition.
scope (str) – The data plane resource path for which access is being granted through this Role Assignment.
principal_id (str) – The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

class azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults(*, role_definition_id: Optional[str] = None, scope: Optional[str] = None, principal_id: Optional[str] = None, **kwargs)[source]¶

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

An Azure Cosmos DB Role Assignment.

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.

Parameters

role_definition_id (str) – The unique identifier for the associated Role Definition.
scope (str) – The data plane resource path for which access is being granted through this Role Assignment.
principal_id (str) – The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

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

Bases: msrest.serialization.Model

The relevant Role Assignments.

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

Variables: value (list[SqlRoleAssignmentGetResults]) – List of Role Assignments and their properties.

class azure.mgmt.cosmosdb.models.SqlRoleDefinitionCreateUpdateParameters(*, role_name: Optional[str] = None, type: Optional[str] = None, assignable_scopes: Optional[List[str]] = None, permissions: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Permission]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters to create and update an Azure Cosmos DB SQL Role Definition.

Parameters

role_name (str) – A user-friendly name for the Role Definition. Must be unique for the database account.
type (str or RoleDefinitionType) – Indicates whether the Role Definition was built-in or user created. Possible values include: “BuiltInRole”, “CustomRole”.
assignable_scopes (list[str]) – A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions (list[Permission]) – The set of operations allowed through this Role Definition.

class azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults(*, role_name: Optional[str] = None, type_properties_type: Optional[str] = None, assignable_scopes: Optional[List[str]] = None, permissions: Optional[List[azure.mgmt.cosmosdb.models._models_py3.Permission]] = None, **kwargs)[source]¶

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

An Azure Cosmos DB SQL Role Definition.

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.

Parameters

role_name (str) – A user-friendly name for the Role Definition. Must be unique for the database account.
type_properties_type (str or RoleDefinitionType) – Indicates whether the Role Definition was built-in or user created. Possible values include: “BuiltInRole”, “CustomRole”.
assignable_scopes (list[str]) – A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions (list[Permission]) – The set of operations allowed through this Role Definition.

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

Bases: msrest.serialization.Model

The relevant Role Definitions.

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

Variables: value (list[SqlRoleDefinitionGetResults]) – List of Role Definitions and their properties.

class azure.mgmt.cosmosdb.models.SqlStoredProcedureCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.SqlStoredProcedureResource, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (SqlStoredProcedureResource) – Required. The standard JSON format of a storedProcedure.
options (CreateUpdateOptions) – 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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.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”.
identity (ManagedServiceIdentity) – Identity for the resource.
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, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (SqlTriggerResource) – Required. The standard JSON format of a trigger.
options (CreateUpdateOptions) – 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: Optional[str] = None, trigger_operation: Optional[str] = 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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.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”.
identity (ManagedServiceIdentity) – Identity for the resource.
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: Optional[str] = None, trigger_operation: Optional[str] = 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, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (SqlUserDefinedFunctionResource) – Required. The standard JSON format of a userDefinedFunction.
options (CreateUpdateOptions) – 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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.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”.
identity (ManagedServiceIdentity) – Identity for the resource.
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.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[str] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[str] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Metadata pertaining to creation and last modification of the resource.

Parameters

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.cosmosdb.models.TableCreateUpdateParameters(*, resource: azure.mgmt.cosmosdb.models._models_py3.TableResource, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.CreateUpdateOptions] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (TableResource) – Required. The standard JSON format of a Table.
options (CreateUpdateOptions) – 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[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.TableGetPropertiesResource] = None, options: Optional[azure.mgmt.cosmosdb.models._models_py3.TableGetPropertiesOptions] = 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.

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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (TableGetPropertiesResource) –
options (TableGetPropertiesOptions) –

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[azure.mgmt.cosmosdb.models._models_py3.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 (float) – 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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = None, resource: Optional[azure.mgmt.cosmosdb.models._models_py3.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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (ThroughputSettingsGetPropertiesResource) –

class azure.mgmt.cosmosdb.models.ThroughputSettingsResource(*, throughput: Optional[int] = None, autoscale_settings: Optional[azure.mgmt.cosmosdb.models._models_py3.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, identity: Optional[azure.mgmt.cosmosdb.models._models_py3.ManagedServiceIdentity] = 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”.
identity (ManagedServiceIdentity) – Identity for the resource.
resource (ThroughputSettingsResource) – Required. The standard JSON format of a resource throughput.

class azure.mgmt.cosmosdb.models.TriggerOperation(value)[source]¶

Bases: str, enum.Enum

The operation the trigger is associated with

ALL = 'All'¶

CREATE = 'Create'¶

DELETE = 'Delete'¶

REPLACE = 'Replace'¶

UPDATE = 'Update'¶

class azure.mgmt.cosmosdb.models.TriggerType(value)[source]¶

Bases: str, enum.Enum

Type of the Trigger

POST = 'Post'¶

PRE = 'Pre'¶

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[azure.mgmt.cosmosdb.models._models_py3.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.UnitType(value)[source]¶

Bases: str, enum.Enum

The unit of the metric.

BYTES = 'Bytes'¶

BYTES_PER_SECOND = 'BytesPerSecond'¶

COUNT = 'Count'¶

COUNT_PER_SECOND = 'CountPerSecond'¶

MILLISECONDS = 'Milliseconds'¶

PERCENT = 'Percent'¶

SECONDS = 'Seconds'¶

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.