azure.mgmt.cosmosdb.models module

class azure.mgmt.cosmosdb.models.ARMProxyResource(**kwargs: Any)[source]

Bases: 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: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: 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.
location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – 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”.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.AccountKeyMetadata(**kwargs: Any)[source]

Bases: Model

The metadata related to an access key for a given database account.

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

Variables:: generation_time (datetime) – Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.

class azure.mgmt.cosmosdb.models.AnalyticalStorageConfiguration(*, schema_type: str | _models.AnalyticalStorageSchemaType | None = None, **kwargs: Any)[source]

Bases: Model

Analytical storage specific properties.

Variables:: schema_type (str or AnalyticalStorageSchemaType) – Describes the types of schema for analytical storage. Known values are: “WellDefined” and “FullFidelity”.
Keyword Arguments:: schema_type (str or AnalyticalStorageSchemaType) – Describes the types of schema for analytical storage. Known values are: “WellDefined” and “FullFidelity”.

class azure.mgmt.cosmosdb.models.AnalyticalStorageSchemaType(*values)[source]

Bases: str, Enum

Describes the types of schema for analytical storage.

FULL_FIDELITY = 'FullFidelity'

WELL_DEFINED = 'WellDefined'

class azure.mgmt.cosmosdb.models.ApiProperties(*, server_version: str | _models.ServerVersion | None = None, **kwargs: Any)[source]

Bases: Model

ApiProperties.

Variables:: server_version (str or ServerVersion) – Describes the version of the MongoDB account. Known values are: “3.2”, “3.6”, “4.0”, “4.2”, “5.0”, “6.0”, and “7.0”.
Keyword Arguments:: server_version (str or ServerVersion) – Describes the version of the MongoDB account. Known values are: “3.2”, “3.6”, “4.0”, “4.2”, “5.0”, “6.0”, and “7.0”.

class azure.mgmt.cosmosdb.models.ApiType(*values)[source]

Bases: str, 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(*values)[source]

Bases: str, 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'

LDAP = 'Ldap'

NONE = 'None'

class azure.mgmt.cosmosdb.models.AuthenticationMethodLdapProperties(*, server_hostname: str | None = None, server_port: int | None = None, service_user_distinguished_name: str | None = None, service_user_password: str | None = None, search_base_distinguished_name: str | None = None, search_filter_template: str | None = None, server_certificates: List[_models.Certificate] | None = None, connection_timeout_in_ms: int | None = None, **kwargs: Any)[source]

Bases: Model

Ldap authentication method properties. This feature is in preview.

Variables:

server_hostname (str) – Hostname of the LDAP server.
server_port (int) – Port of the LDAP server.
service_user_distinguished_name (str) – Distinguished name of the look up user account, who can look up user details on authentication.
service_user_password (str) – Password of the look up user.
search_base_distinguished_name (str) – Distinguished name of the object to start the recursive search of users from.
search_filter_template (str) – Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
server_certificates (list[Certificate])
connection_timeout_in_ms (int) – Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.

Keyword Arguments:

server_hostname (str) – Hostname of the LDAP server.
server_port (int) – Port of the LDAP server.
service_user_distinguished_name (str) – Distinguished name of the look up user account, who can look up user details on authentication.
service_user_password (str) – Password of the look up user.
search_base_distinguished_name (str) – Distinguished name of the object to start the recursive search of users from.
search_filter_template (str) – Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
server_certificates (list[Certificate])
connection_timeout_in_ms (int) – Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.

class azure.mgmt.cosmosdb.models.AutoUpgradePolicyResource(*, throughput_policy: _models.ThroughputPolicyResource | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB resource auto-upgrade policy.

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

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

Bases: Model

AutoscaleSettings.

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

class azure.mgmt.cosmosdb.models.AutoscaleSettingsResource(*, max_throughput: int, auto_upgrade_policy: _models.AutoUpgradePolicyResource | None = None, **kwargs: Any)[source]

Bases: 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 server.

Variables:

max_throughput (int) – Represents maximum throughput container can scale up to. Required.
auto_upgrade_policy (AutoUpgradePolicyResource) – Cosmos DB resource auto-upgrade policy.
target_max_throughput (int) – Represents target maximum throughput container can scale up to once offer is no longer in pending state.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.AzureConnectionType(*values)[source]

Bases: str, Enum

How to connect to the azure services needed for running the cluster.

NONE = 'None'

VPN = 'VPN'

class azure.mgmt.cosmosdb.models.BackupInformation(**kwargs: Any)[source]

Bases: 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: _models.BackupPolicyMigrationState | None = None, **kwargs: Any)[source]

Bases: 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 server.

Variables:

type (str or BackupPolicyType) – Describes the mode of backups. Required. Known values are: “Periodic” and “Continuous”.
migration_state (BackupPolicyMigrationState) – The object representing the state of the migration between the backup policies.

Keyword Arguments:

migration_state (BackupPolicyMigrationState) – The object representing the state of the migration between the backup policies.

Bases: Model

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.BackupPolicyMigrationStatus(*values)[source]

Bases: str, 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(*values)[source]

Bases: str, Enum

Describes the mode of backups.

CONTINUOUS = 'Continuous'

PERIODIC = 'Periodic'

class azure.mgmt.cosmosdb.models.BackupStorageRedundancy(*values)[source]

Bases: str, Enum

Enum to indicate type of backup storage redundancy.

GEO = 'Geo'

LOCAL = 'Local'

ZONE = 'Zone'

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

Bases: Model

Cosmos DB capability object.

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

class azure.mgmt.cosmosdb.models.Capacity(*, total_throughput_limit: int | None = None, **kwargs: Any)[source]

Bases: Model

The object that represents all properties related to capacity enforcement on an account.

Variables:: total_throughput_limit (int) – The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
Keyword Arguments:: total_throughput_limit (int) – The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.

Bases: Model

CassandraClusterDataCenterNodeItem.

Variables:

address (str) – The node’s IP address.
state (str or NodeState) – The state of the node in Cassandra ring. Known values are: “Normal”, “Leaving”, “Joining”, “Moving”, and “Stopped”.
status (str)
cassandra_process_status (str) – Cassandra service status on this node.
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 cells or tombstones) is counted.
tokens (list[str]) – List of tokens this node covers.
size (int)
host_id (str) – The network ID of the node.
rack (str) – The rack this node is part of.
timestamp (str) – The timestamp when these statistics were captured.
disk_used_kb (int) – The amount of disk used, in kB, of the directory /var/lib/cassandra.
disk_free_kb (int) – The amount of disk free, in kB, of the directory /var/lib/cassandra.
memory_used_kb (int) – Used memory (calculated as total - free - buffers - cache), in kB.
memory_buffers_and_cached_kb (int) – Memory used by kernel buffers (Buffers in /proc/meminfo) and page cache and slabs (Cached and SReclaimable in /proc/meminfo), in kB.
memory_free_kb (int) – Unused memory (MemFree and SwapFree in /proc/meminfo), in kB.
memory_total_kb (int) – Total installed memory (MemTotal and SwapTotal in /proc/meminfo), in kB.
cpu_usage (float) – A float representing the current system-wide CPU utilization as a percentage.

Keyword Arguments:

address (str) – The node’s IP address.
state (str or NodeState) – The state of the node in Cassandra ring. Known values are: “Normal”, “Leaving”, “Joining”, “Moving”, and “Stopped”.
status (str)
cassandra_process_status (str) – Cassandra service status on this node.
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 cells or tombstones) is counted.
tokens (list[str]) – List of tokens this node covers.
size (int)
host_id (str) – The network ID of the node.
rack (str) – The rack this node is part of.
timestamp (str) – The timestamp when these statistics were captured.
disk_used_kb (int) – The amount of disk used, in kB, of the directory /var/lib/cassandra.
disk_free_kb (int) – The amount of disk free, in kB, of the directory /var/lib/cassandra.
memory_used_kb (int) – Used memory (calculated as total - free - buffers - cache), in kB.
memory_buffers_and_cached_kb (int) – Memory used by kernel buffers (Buffers in /proc/meminfo) and page cache and slabs (Cached and SReclaimable in /proc/meminfo), in kB.
memory_free_kb (int) – Unused memory (MemFree and SwapFree in /proc/meminfo), in kB.
memory_total_kb (int) – Total installed memory (MemTotal and SwapTotal in /proc/meminfo), in kB.
cpu_usage (float) – A float representing the current system-wide CPU utilization as a percentage.

class azure.mgmt.cosmosdb.models.CassandraClusterPublicStatus(*, e_tag: str | None = None, reaper_status: _models.ManagedCassandraReaperStatus | None = None, connection_errors: List[_models.ConnectionError] | None = None, errors: List[_models.CassandraError] | None = None, data_centers: List[_models.CassandraClusterPublicStatusDataCentersItem] | None = None, **kwargs: Any)[source]

Bases: Model

Properties of a managed Cassandra cluster public status.

Variables:

e_tag (str)
reaper_status (ManagedCassandraReaperStatus)
connection_errors (list[ConnectionError]) – List relevant information about any connection errors to the Datacenters.
errors (list[CassandraError]) – List relevant information about any errors about cluster, data center and connection error.
data_centers (list[CassandraClusterPublicStatusDataCentersItem]) – List of the status of each datacenter in this cluster.

Keyword Arguments:

e_tag (str)
reaper_status (ManagedCassandraReaperStatus)
connection_errors (list[ConnectionError]) – List relevant information about any connection errors to the Datacenters.
errors (list[CassandraError]) – List relevant information about any errors about cluster, data center and connection error.
data_centers (list[CassandraClusterPublicStatusDataCentersItem]) – List of the status of each datacenter in this cluster.

class azure.mgmt.cosmosdb.models.CassandraClusterPublicStatusDataCentersItem(*, name: str | None = None, seed_nodes: List[str] | None = None, nodes: List[_models.CassandraClusterDataCenterNodeItem] | None = None, **kwargs: Any)[source]

Bases: Model

CassandraClusterPublicStatusDataCentersItem.

Variables:

name (str) – The name of this Datacenter.
seed_nodes (list[str]) – A list of all seed nodes in the cluster, managed and unmanaged.
nodes (list[CassandraClusterDataCenterNodeItem])

Keyword Arguments:

name (str) – The name of this Datacenter.
seed_nodes (list[str]) – A list of all seed nodes in the cluster, managed and unmanaged.
nodes (list[CassandraClusterDataCenterNodeItem])

class azure.mgmt.cosmosdb.models.CassandraError(*, code: str | None = None, message: str | None = None, target: str | None = None, additional_error_info: str | None = None, **kwargs: Any)[source]

Bases: Model

CassandraError.

Variables:

code (str) – The code of error that occurred.
message (str) – The message of the error.
target (str) – The target resource of the error.
additional_error_info (str) – Additional information about the error.

Keyword Arguments:

code (str) – The code of error that occurred.
message (str) – The message of the error.
target (str) – The target resource of the error.
additional_error_info (str) – Additional information about the error.

class azure.mgmt.cosmosdb.models.CassandraKeyspaceCreateUpdateParameters(*, resource: _models.CassandraKeyspaceResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (CassandraKeyspaceResource) – The standard JSON format of a Cassandra keyspace. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

CassandraKeyspaceGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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: Any)[source]

Bases: CassandraKeyspaceResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB Cassandra keyspace. Required.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.CassandraKeyspaceGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.CassandraKeyspaceGetPropertiesResource | None = None, options: _models.CassandraKeyspaceGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.CassandraKeyspaceListResult(**kwargs: Any)[source]

Bases: 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: Any)[source]

Bases: Model

Cosmos DB Cassandra keyspace resource object.

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

Variables:: id (str) – Name of the Cosmos DB Cassandra keyspace. Required.
Keyword Arguments:: id (str) – Name of the Cosmos DB Cassandra keyspace. Required.

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

Bases: Model

Cosmos DB Cassandra table partition key.

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

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

Bases: Model

Cosmos DB Cassandra table schema.

Variables:

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

Keyword Arguments:

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: _models.CassandraTableResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (CassandraTableResource) – The standard JSON format of a Cassandra table. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

CassandraTableGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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: int | None = None, schema: _models.CassandraSchema | None = None, analytical_storage_ttl: int | None = None, **kwargs: Any)[source]

Bases: CassandraTableResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB Cassandra table. Required.
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.

Keyword Arguments:

id (str) – Name of the Cosmos DB Cassandra table. Required.
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.CassandraTableGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.CassandraTableGetPropertiesResource | None = None, options: _models.CassandraTableGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.CassandraTableListResult(**kwargs: Any)[source]

Bases: 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: int | None = None, schema: _models.CassandraSchema | None = None, analytical_storage_ttl: int | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB Cassandra table resource object.

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

Variables:

id (str) – Name of the Cosmos DB Cassandra table. Required.
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.

Keyword Arguments:

id (str) – Name of the Cosmos DB Cassandra table. Required.
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.Certificate(*, pem: str | None = None, **kwargs: Any)[source]

Bases: Model

Certificate.

Variables:: pem (str) – PEM formatted public key.
Keyword Arguments:: pem (str) – PEM formatted public key.

class azure.mgmt.cosmosdb.models.ClientEncryptionIncludedPath(*, path: str, client_encryption_key_id: str, encryption_type: str, encryption_algorithm: str, **kwargs: Any)[source]

Bases: Model

.

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

Variables:

path (str) – Path that needs to be encrypted. Required.
client_encryption_key_id (str) – The identifier of the Client Encryption Key to be used to encrypt the path. Required.
encryption_type (str) – The type of encryption to be performed. Eg - Deterministic, Randomized. Required.
encryption_algorithm (str) – The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256. Required.

Keyword Arguments:

path (str) – Path that needs to be encrypted. Required.
client_encryption_key_id (str) – The identifier of the Client Encryption Key to be used to encrypt the path. Required.
encryption_type (str) – The type of encryption to be performed. Eg - Deterministic, Randomized. Required.
encryption_algorithm (str) – The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256. Required.

class azure.mgmt.cosmosdb.models.ClientEncryptionKeyCreateUpdateParameters(*, resource: _models.ClientEncryptionKeyResource, **kwargs: Any)[source]

Bases: Model

Parameters to create and update ClientEncryptionKey.

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

Variables:: resource (ClientEncryptionKeyResource) – The standard JSON format of a ClientEncryptionKey. Required.
Keyword Arguments:: resource (ClientEncryptionKeyResource) – The standard JSON format of a ClientEncryptionKey. Required.

class azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetPropertiesResource(*, id: str | None = None, encryption_algorithm: str | None = None, wrapped_data_encryption_key: bytes | None = None, key_wrap_metadata: _models.KeyWrapMetadata | None = None, **kwargs: Any)[source]

Bases: ClientEncryptionKeyResource, ExtendedResourceProperties

ClientEncryptionKeyGetPropertiesResource.

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.
id (str) – Name of the ClientEncryptionKey.
encryption_algorithm (str) – Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
wrapped_data_encryption_key (bytes) – Wrapped (encrypted) form of the key represented as a byte array.
key_wrap_metadata (KeyWrapMetadata) – Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

Keyword Arguments:

id (str) – Name of the ClientEncryptionKey.
encryption_algorithm (str) – Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
wrapped_data_encryption_key (bytes) – Wrapped (encrypted) form of the key represented as a byte array.
key_wrap_metadata (KeyWrapMetadata) – Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

class azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults(*, resource: _models.ClientEncryptionKeyGetPropertiesResource | None = None, **kwargs: Any)[source]

Bases: ARMProxyResource

Client Encryption Key.

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.
resource (ClientEncryptionKeyGetPropertiesResource)

Keyword Arguments:

resource (ClientEncryptionKeyGetPropertiesResource)

class azure.mgmt.cosmosdb.models.ClientEncryptionKeyResource(*, id: str | None = None, encryption_algorithm: str | None = None, wrapped_data_encryption_key: bytes | None = None, key_wrap_metadata: _models.KeyWrapMetadata | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB client encryption key resource object.

Variables:

id (str) – Name of the ClientEncryptionKey.
encryption_algorithm (str) – Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
wrapped_data_encryption_key (bytes) – Wrapped (encrypted) form of the key represented as a byte array.
key_wrap_metadata (KeyWrapMetadata) – Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

Keyword Arguments:

id (str) – Name of the ClientEncryptionKey.
encryption_algorithm (str) – Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
wrapped_data_encryption_key (bytes) – Wrapped (encrypted) form of the key represented as a byte array.
key_wrap_metadata (KeyWrapMetadata) – Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

class azure.mgmt.cosmosdb.models.ClientEncryptionKeysListResult(**kwargs: Any)[source]

Bases: Model

The List operation response, that contains the client encryption keys and their properties.

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

Variables:: value (list[ClientEncryptionKeyGetResults]) – List of client encryption keys and their properties.

class azure.mgmt.cosmosdb.models.ClientEncryptionPolicy(*, included_paths: List[_models.ClientEncryptionIncludedPath], policy_format_version: int, **kwargs: Any)[source]

Bases: Model

Cosmos DB client encryption policy.

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

Variables:

included_paths (list[ClientEncryptionIncludedPath]) – Paths of the item that need encryption along with path-specific settings. Required.
policy_format_version (int) – Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption. Required.

Keyword Arguments:

included_paths (list[ClientEncryptionIncludedPath]) – Paths of the item that need encryption along with path-specific settings. Required.
policy_format_version (int) – Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption. Required.

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

Bases: Model

Cosmos DB Cassandra table cluster key.

Variables:

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

Keyword Arguments:

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.ClusterResource(*, location: str | None = None, tags: Dict[str, str] | None = None, identity: _models.ManagedCassandraManagedServiceIdentity | None = None, properties: _models.ClusterResourceProperties | None = None, **kwargs: Any)[source]

Bases: ManagedCassandraARMResourceProperties

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.
location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – 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 (ManagedCassandraManagedServiceIdentity) – Identity for the resource.
properties (ClusterResourceProperties) – Properties of a managed Cassandra cluster.

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – 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 (ManagedCassandraManagedServiceIdentity) – Identity for the resource.
properties (ClusterResourceProperties) – Properties of a managed Cassandra cluster.

class azure.mgmt.cosmosdb.models.ClusterResourceProperties(*, provisioning_state: str | _models.ManagedCassandraProvisioningState | None = None, restore_from_backup_id: str | None = None, delegated_management_subnet_id: str | None = None, cassandra_version: str | None = None, cluster_name_override: str | None = None, authentication_method: str | _models.AuthenticationMethod | None = None, initial_cassandra_admin_password: str | None = None, prometheus_endpoint: _models.SeedNode | None = None, repair_enabled: bool | None = None, client_certificates: List[_models.Certificate] | None = None, external_gossip_certificates: List[_models.Certificate] | None = None, external_seed_nodes: List[_models.SeedNode] | None = None, hours_between_backups: int | None = None, deallocated: bool | None = None, cassandra_audit_logging_enabled: bool | None = None, provision_error: _models.CassandraError | None = None, azure_connection_method: str | _models.AzureConnectionType | None = None, **kwargs: Any)[source]

Bases: Model

Properties of a managed Cassandra cluster.

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

Variables:

provisioning_state (str or ManagedCassandraProvisioningState) – The status of the resource at the time the operation was called. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, and “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’. Known values are: “None”, “Cassandra”, and “Ldap”.
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’.
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.
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.
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.
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.
hours_between_backups (int) – (Deprecated) Number of hours to wait between taking a backup of the cluster.
deallocated (bool) – Whether the cluster and associated data centers has been deallocated.
cassandra_audit_logging_enabled (bool) – Whether Cassandra audit logging is enabled.
provision_error (CassandraError) – Error related to resource provisioning.
azure_connection_method (str or AzureConnectionType) – How to connect to the azure services needed for running the cluster. Known values are: “None” and “VPN”.
private_link_resource_id (str) – If the Connection Method is VPN, this is the Id of the private link resource that the datacenters need to connect to.

Keyword Arguments:

provisioning_state (str or ManagedCassandraProvisioningState) – The status of the resource at the time the operation was called. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, and “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’. Known values are: “None”, “Cassandra”, and “Ldap”.
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’.
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.
hours_between_backups (int) – (Deprecated) Number of hours to wait between taking a backup of the cluster.
deallocated (bool) – Whether the cluster and associated data centers has been deallocated.
cassandra_audit_logging_enabled (bool) – Whether Cassandra audit logging is enabled.
provision_error (CassandraError) – Error related to resource provisioning.
azure_connection_method (str or AzureConnectionType) – How to connect to the azure services needed for running the cluster. Known values are: “None” and “VPN”.

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

Bases: Model

Cosmos DB Cassandra table column.

Variables:

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

Keyword Arguments:

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.CommandOutput(*, command_output: str | None = None, **kwargs: Any)[source]

Bases: Model

Response of /command api.

Variables:: command_output (str) – Output of the command.
Keyword Arguments:: command_output (str) – Output of the command.

class azure.mgmt.cosmosdb.models.CommandPostBody(*, command: str, host: str, arguments: Dict[str, str] | None = None, cassandra_stop_start: bool | None = None, readwrite: bool | None = None, **kwargs: Any)[source]

Bases: Model

Specification of which command to run where.

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

Variables:

command (str) – The command which should be run. Required.
arguments (dict[str, str]) – The arguments for the command to be run.
host (str) – IP address of the cassandra host to run the command on. Required.
cassandra_stop_start (bool) – If true, stops cassandra before executing the command and then start it again.
readwrite (bool) – If true, allows the command to write to the cassandra directory, otherwise read-only.

Keyword Arguments:

command (str) – The command which should be run. Required.
arguments (dict[str, str]) – The arguments for the command to be run.
host (str) – IP address of the cassandra host to run the command on. Required.
cassandra_stop_start (bool) – If true, stops cassandra before executing the command and then start it again.
readwrite (bool) – If true, allows the command to write to the cassandra directory, otherwise read-only.

class azure.mgmt.cosmosdb.models.CompositePath(*, path: str | None = None, order: str | _models.CompositePathSortOrder | None = None, **kwargs: Any)[source]

Bases: Model

CompositePath.

Variables:

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. Known values are: “ascending” and “descending”.

Keyword Arguments:

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. Known values are: “ascending” and “descending”.

class azure.mgmt.cosmosdb.models.CompositePathSortOrder(*values)[source]

Bases: str, Enum

Sort order for composite paths.

ASCENDING = 'ascending'

DESCENDING = 'descending'

class azure.mgmt.cosmosdb.models.ComputedProperty(*, name: str | None = None, query: str | None = None, **kwargs: Any)[source]

Bases: Model

The definition of a computed property.

Variables:

name (str) – The name of a computed property, for example - “cp_lowerName”.
query (str) – The query that evaluates the value for computed property, for example - “SELECT VALUE LOWER(c.name) FROM c”.

Keyword Arguments:

name (str) – The name of a computed property, for example - “cp_lowerName”.
query (str) – The query that evaluates the value for computed property, for example - “SELECT VALUE LOWER(c.name) FROM c”.

class azure.mgmt.cosmosdb.models.ConflictResolutionMode(*values)[source]

Bases: str, Enum

Indicates the conflict resolution mode.

CUSTOM = 'Custom'

LAST_WRITER_WINS = 'LastWriterWins'

class azure.mgmt.cosmosdb.models.ConflictResolutionPolicy(*, mode: str | _models.ConflictResolutionMode = 'LastWriterWins', conflict_resolution_path: str | None = None, conflict_resolution_procedure: str | None = None, **kwargs: Any)[source]

Bases: Model

The conflict resolution policy for the container.

Variables:

mode (str or ConflictResolutionMode) – Indicates the conflict resolution mode. Known values are: “LastWriterWins” and “Custom”.
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.

Keyword Arguments:

mode (str or ConflictResolutionMode) – Indicates the conflict resolution mode. Known values are: “LastWriterWins” and “Custom”.
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.

Bases: Model

ConnectionError.

Variables:

connection_state (str or ConnectionState) – The kind of connection error that occurred. Known values are: “Unknown”, “OK”, “OperatorToDataCenterNetworkError”, “DatacenterToDatacenterNetworkError”, “InternalOperatorToDataCenterCertificateError”, and “InternalError”.
i_p_from (str) – The IP of host that originated the failed connection.
i_p_to (str) – The IP that the connection attempted to reach.
port (int) – The TCP port the connection was attempted on.
exception (str) – Detailed error message about the failed connection.

Keyword Arguments:

connection_state (str or ConnectionState) – The kind of connection error that occurred. Known values are: “Unknown”, “OK”, “OperatorToDataCenterNetworkError”, “DatacenterToDatacenterNetworkError”, “InternalOperatorToDataCenterCertificateError”, and “InternalError”.
i_p_from (str) – The IP of host that originated the failed connection.
i_p_to (str) – The IP that the connection attempted to reach.
port (int) – The TCP port the connection was attempted on.
exception (str) – Detailed error message about the failed connection.

class azure.mgmt.cosmosdb.models.ConnectionState(*values)[source]

Bases: str, Enum

The kind of connection error that occurred.

DATACENTER_TO_DATACENTER_NETWORK_ERROR = 'DatacenterToDatacenterNetworkError'

INTERNAL_ERROR = 'InternalError'

INTERNAL_OPERATOR_TO_DATA_CENTER_CERTIFICATE_ERROR = 'InternalOperatorToDataCenterCertificateError'

OK = 'OK'

OPERATOR_TO_DATA_CENTER_NETWORK_ERROR = 'OperatorToDataCenterNetworkError'

UNKNOWN = 'Unknown'

class azure.mgmt.cosmosdb.models.ConnectorOffer(*values)[source]

Bases: str, 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 | _models.DefaultConsistencyLevel, max_staleness_prefix: int | None = None, max_interval_in_seconds: int | None = None, **kwargs: Any)[source]

Bases: Model

The consistency policy for the Cosmos DB database account.

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

Variables:

default_consistency_level (str or DefaultConsistencyLevel) – The default consistency level and configuration settings of the Cosmos DB account. Required. Known values are: “Eventual”, “Session”, “BoundedStaleness”, “Strong”, and “ConsistentPrefix”.
max_staleness_prefix (int) – 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’.

Keyword Arguments:

default_consistency_level (str or DefaultConsistencyLevel) – The default consistency level and configuration settings of the Cosmos DB account. Required. Known values are: “Eventual”, “Session”, “BoundedStaleness”, “Strong”, and “ConsistentPrefix”.
max_staleness_prefix (int) – 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: List[str] | None = None, kind: str | _models.PartitionKind = 'Hash', version: int | None = None, **kwargs: Any)[source]

Bases: 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.

Variables:

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. Known values are: “Hash”, “Range”, and “MultiHash”.
version (int) – Indicates the version of the partition key definition.
system_key (bool) – Indicates if the container is using a system generated partition key.

Keyword Arguments:

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. Known values are: “Hash”, “Range”, and “MultiHash”.
version (int) – Indicates the version of the partition key definition.

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

Bases: Model

Information about the status of continuous backups.

Variables:: latest_restorable_timestamp (str) – The latest restorable timestamp for a resource.
Keyword Arguments:: latest_restorable_timestamp (str) – The latest restorable timestamp for a resource.

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

Bases: Model

Properties of the regional restorable account.

Variables:: location (str) – The name of the continuous backup restore location.
Keyword Arguments:: location (str) – The name of the continuous backup restore location.

class azure.mgmt.cosmosdb.models.ContinuousModeBackupPolicy(*, migration_state: _models.BackupPolicyMigrationState | None = None, continuous_mode_properties: _models.ContinuousModeProperties | None = None, **kwargs: Any)[source]

Bases: BackupPolicy

The object representing continuous mode backup policy.

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

Variables:

type (str or BackupPolicyType) – Describes the mode of backups. Required. Known values are: “Periodic” and “Continuous”.
migration_state (BackupPolicyMigrationState) – The object representing the state of the migration between the backup policies.
continuous_mode_properties (ContinuousModeProperties) – Configuration values for continuous mode backup.

Keyword Arguments:

migration_state (BackupPolicyMigrationState) – The object representing the state of the migration between the backup policies.
continuous_mode_properties (ContinuousModeProperties) – Configuration values for continuous mode backup.

class azure.mgmt.cosmosdb.models.ContinuousModeProperties(*, tier: str | _models.ContinuousTier | None = None, **kwargs: Any)[source]

Bases: Model

Configuration values for periodic mode backup.

Variables:: tier (str or ContinuousTier) – Enum to indicate type of Continuous backup mode. Known values are: “Continuous7Days” and “Continuous30Days”.
Keyword Arguments:: tier (str or ContinuousTier) – Enum to indicate type of Continuous backup mode. Known values are: “Continuous7Days” and “Continuous30Days”.

class azure.mgmt.cosmosdb.models.ContinuousTier(*values)[source]

Bases: str, Enum

Enum to indicate type of Continuous backup tier.

CONTINUOUS30_DAYS = 'Continuous30Days'

CONTINUOUS7_DAYS = 'Continuous7Days'

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

Bases: Model

The CORS policy for the Cosmos DB database account.

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

Variables:

allowed_origins (str) – The origin domains that are permitted to make a request against the service via CORS. Required.
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 (int) – The maximum amount time that a browser should cache the preflight OPTIONS request.

Keyword Arguments:

allowed_origins (str) – The origin domains that are permitted to make a request against the service via CORS. Required.
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 (int) – The maximum amount time that a browser should cache the preflight OPTIONS request.

class azure.mgmt.cosmosdb.models.CreateMode(*values)[source]

Bases: str, Enum

Enum to indicate the mode of account creation.

DEFAULT = 'Default'

RESTORE = 'Restore'

class azure.mgmt.cosmosdb.models.CreateUpdateOptions(*, throughput: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: 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”.

Variables:

throughput (int) – Request Units per second. For example, “throughput”: 10000.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.

Keyword Arguments:

throughput (int) – Request Units per second. For example, “throughput”: 10000.
autoscale_settings (AutoscaleSettings) – Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.

class azure.mgmt.cosmosdb.models.CreatedByType(*values)[source]

Bases: str, 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: _models.DataCenterResourceProperties | None = None, **kwargs: Any)[source]

Bases: 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.
properties (DataCenterResourceProperties) – Properties of a managed Cassandra data center.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.DataCenterResourceProperties(*, provisioning_state: str | _models.ManagedCassandraProvisioningState | None = None, data_center_location: str | None = None, delegated_subnet_id: str | None = None, node_count: int | None = None, base64_encoded_cassandra_yaml_fragment: str | None = None, managed_disk_customer_key_uri: str | None = None, backup_storage_customer_key_uri: str | None = None, sku: str | None = None, disk_sku: str | None = None, disk_capacity: int | None = None, availability_zone: bool | None = None, authentication_method_ldap_properties: _models.AuthenticationMethodLdapProperties | None = None, deallocated: bool | None = None, provision_error: _models.CassandraError | None = None, private_endpoint_ip_address: str | None = None, **kwargs: Any)[source]

Bases: Model

Properties of a managed Cassandra data center.

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

Variables:

provisioning_state (str or ManagedCassandraProvisioningState) – The status of the resource at the time the operation was called. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, and “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.
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.
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.
managed_disk_customer_key_uri (str) – Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
backup_storage_customer_key_uri (str) – Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
sku (str) – Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.
disk_sku (str) – Disk SKU used for data centers. Default value is P30.
disk_capacity (int) – Number of disks attached to each node. Default is 4.
availability_zone (bool) – If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
authentication_method_ldap_properties (AuthenticationMethodLdapProperties) – Ldap authentication method properties. This feature is in preview.
deallocated (bool) – Whether the data center has been deallocated.
provision_error (CassandraError) – Error related to resource provisioning.
private_endpoint_ip_address (str) – Ip of the VPN Endpoint for this data center.

Keyword Arguments:

provisioning_state (str or ManagedCassandraProvisioningState) – The status of the resource at the time the operation was called. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, and “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.
managed_disk_customer_key_uri (str) – Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
backup_storage_customer_key_uri (str) – Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
sku (str) – Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.
disk_sku (str) – Disk SKU used for data centers. Default value is P30.
disk_capacity (int) – Number of disks attached to each node. Default is 4.
availability_zone (bool) – If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
authentication_method_ldap_properties (AuthenticationMethodLdapProperties) – Ldap authentication method properties. This feature is in preview.
deallocated (bool) – Whether the data center has been deallocated.
provision_error (CassandraError) – Error related to resource provisioning.
private_endpoint_ip_address (str) – Ip of the VPN Endpoint for this data center.

class azure.mgmt.cosmosdb.models.DataTransferRegionalServiceResource(**kwargs: Any)[source]

Bases: 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. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.

class azure.mgmt.cosmosdb.models.DataTransferServiceResource(*, properties: _models.DataTransferServiceResourceProperties | None = None, **kwargs: Any)[source]

Bases: Model

Describes the service response property.

Variables:: properties (DataTransferServiceResourceProperties) – Properties for DataTransferServiceResource.
Keyword Arguments:: properties (DataTransferServiceResourceProperties) – Properties for DataTransferServiceResource.

class azure.mgmt.cosmosdb.models.DataTransferServiceResourceCreateUpdateProperties(*, instance_size: str | _models.ServiceSize | None = None, instance_count: int | None = None, **kwargs: Any)[source]

Bases: ServiceResourceCreateUpdateProperties

Properties for Create or Update request for DataTransferServiceResource.

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

Variables:

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

Keyword Arguments:

instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.

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

Bases: 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 server.

Variables:

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
creation_time (datetime) – Time of the last state change (ISO-8601 format).
instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – ServiceType for the service. Required. Known values are: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”, and “MaterializedViewsBuilder”.
status (str or ServiceStatus) – Describes the status of a service. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.
locations (list[DataTransferRegionalServiceResource]) – An array that contains all of the locations for the service.

Keyword Arguments:

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. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.

class azure.mgmt.cosmosdb.models.DataType(*values)[source]

Bases: str, 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: Any)[source]

Bases: 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.
key_kind (str or Kind) – Kind of the connection string key. Known values are: “Primary”, “Secondary”, “PrimaryReadonly”, and “SecondaryReadonly”.
type (str or Type) – Type of the connection string. Known values are: “Sql”, “Table”, “MongoDB”, “Cassandra”, “CassandraConnectorMetadata”, “Gremlin”, “SqlDedicatedGateway”, “GremlinV2”, and “Undefined”.

class azure.mgmt.cosmosdb.models.DatabaseAccountCreateUpdateParameters(*, locations: List[_models.Location], location: str | None = None, tags: Dict[str, str] | None = None, kind: str | _models.DatabaseAccountKind | None = None, identity: _models.ManagedServiceIdentity | None = None, consistency_policy: _models.ConsistencyPolicy | None = None, ip_rules: List[_models.IpAddressOrRange] | None = None, is_virtual_network_filter_enabled: bool | None = None, enable_automatic_failover: bool | None = None, capabilities: List[_models.Capability] | None = None, virtual_network_rules: List[_models.VirtualNetworkRule] | None = None, enable_multiple_write_locations: bool | None = None, enable_cassandra_connector: bool | None = None, connector_offer: str | _models.ConnectorOffer | None = None, disable_key_based_metadata_write_access: bool | None = None, key_vault_key_uri: str | None = None, default_identity: str | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, enable_free_tier: bool | None = None, api_properties: _models.ApiProperties | None = None, enable_analytical_storage: bool | None = None, analytical_storage_configuration: _models.AnalyticalStorageConfiguration | None = None, create_mode: str | _models.CreateMode = 'Default', backup_policy: _models.BackupPolicy | None = None, cors: List[_models.CorsPolicy] | None = None, network_acl_bypass: str | _models.NetworkAclBypass | None = None, network_acl_bypass_resource_ids: List[str] | None = None, disable_local_auth: bool | None = None, restore_parameters: _models.RestoreParameters | None = None, capacity: _models.Capacity | None = None, enable_partition_merge: bool | None = None, minimal_tls_version: str | _models.MinimalTlsVersion | None = None, enable_burst_capacity: bool | None = None, customer_managed_key_status: str | None = None, enable_per_region_per_partition_autoscale: bool | None = None, **kwargs: Any)[source]

Bases: 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 server.

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.
location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
kind (str or DatabaseAccountKind) – Indicates the type of database account. This can only be set at database account creation. Known values are: “GlobalDocumentDB”, “MongoDB”, and “Parse”.
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. Required.
database_account_offer_type (str) – The offer type for the database. Required. Default value is “Standard”.
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. “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. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.
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) – Enum to indicate the mode of account creation. Known values are: “Default” and “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. Known values are: “None” and “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass 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.
capacity (Capacity) – The object that represents all properties related to capacity enforcement on an account.
keys_metadata (DatabaseAccountKeysMetadata) – This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.
enable_partition_merge (bool) – Flag to indicate enabling/disabling of Partition Merge feature on the account.
minimal_tls_version (str or MinimalTlsVersion) – Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. Known values are: “Tls”, “Tls11”, and “Tls12”.
enable_burst_capacity (bool) – Flag to indicate enabling/disabling of Burst Capacity feature on the account.
customer_managed_key_status (str) – Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
enable_per_region_per_partition_autoscale (bool) – Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
kind (str or DatabaseAccountKind) – Indicates the type of database account. This can only be set at database account creation. Known values are: “GlobalDocumentDB”, “MongoDB”, and “Parse”.
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. Required.
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. “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. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.
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) – Enum to indicate the mode of account creation. Known values are: “Default” and “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. Known values are: “None” and “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass 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.
capacity (Capacity) – The object that represents all properties related to capacity enforcement on an account.
enable_partition_merge (bool) – Flag to indicate enabling/disabling of Partition Merge feature on the account.
minimal_tls_version (str or MinimalTlsVersion) – Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. Known values are: “Tls”, “Tls11”, and “Tls12”.
enable_burst_capacity (bool) – Flag to indicate enabling/disabling of Burst Capacity feature on the account.
customer_managed_key_status (str) – Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
enable_per_region_per_partition_autoscale (bool) – Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.

database_account_offer_type = 'Standard'

class azure.mgmt.cosmosdb.models.DatabaseAccountGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, kind: str | _models.DatabaseAccountKind | None = None, identity: _models.ManagedServiceIdentity | None = None, ip_rules: List[_models.IpAddressOrRange] | None = None, is_virtual_network_filter_enabled: bool | None = None, enable_automatic_failover: bool | None = None, consistency_policy: _models.ConsistencyPolicy | None = None, capabilities: List[_models.Capability] | None = None, virtual_network_rules: List[_models.VirtualNetworkRule] | None = None, enable_multiple_write_locations: bool | None = None, enable_cassandra_connector: bool | None = None, connector_offer: str | _models.ConnectorOffer | None = None, disable_key_based_metadata_write_access: bool | None = None, key_vault_key_uri: str | None = None, default_identity: str | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, enable_free_tier: bool | None = None, api_properties: _models.ApiProperties | None = None, enable_analytical_storage: bool | None = None, analytical_storage_configuration: _models.AnalyticalStorageConfiguration | None = None, create_mode: str | _models.CreateMode = 'Default', restore_parameters: _models.RestoreParameters | None = None, backup_policy: _models.BackupPolicy | None = None, cors: List[_models.CorsPolicy] | None = None, network_acl_bypass: str | _models.NetworkAclBypass | None = None, network_acl_bypass_resource_ids: List[str] | None = None, disable_local_auth: bool | None = None, capacity: _models.Capacity | None = None, enable_partition_merge: bool | None = None, minimal_tls_version: str | _models.MinimalTlsVersion | None = None, enable_burst_capacity: bool | None = None, customer_managed_key_status: str | None = None, enable_per_region_per_partition_autoscale: bool | None = None, **kwargs: Any)[source]

Bases: 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.
location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
kind (str or DatabaseAccountKind) – Indicates the type of database account. This can only be set at database account creation. Known values are: “GlobalDocumentDB”, “MongoDB”, and “Parse”.
identity (ManagedServiceIdentity) – Identity for the 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. Default value is “Standard”.
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.
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.
virtual_network_rules (list[VirtualNetworkRule]) – List of Virtual Network ACL rules configured for the Cosmos DB account.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of Private Endpoint Connections 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. “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. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.
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.
instance_id (str) – A unique identifier assigned to the database account.
create_mode (str or CreateMode) – Enum to indicate the mode of account creation. Known values are: “Default” and “Restore”.
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. Known values are: “None” and “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass 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.
capacity (Capacity) – The object that represents all properties related to capacity enforcement on an account.
keys_metadata (DatabaseAccountKeysMetadata) – The object that represents the metadata for the Account Keys of the Cosmos DB account.
enable_partition_merge (bool) – Flag to indicate enabling/disabling of Partition Merge feature on the account.
minimal_tls_version (str or MinimalTlsVersion) – Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. Known values are: “Tls”, “Tls11”, and “Tls12”.
enable_burst_capacity (bool) – Flag to indicate enabling/disabling of Burst Capacity feature on the account.
customer_managed_key_status (str) – Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
enable_per_region_per_partition_autoscale (bool) – Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
kind (str or DatabaseAccountKind) – Indicates the type of database account. This can only be set at database account creation. Known values are: “GlobalDocumentDB”, “MongoDB”, and “Parse”.
identity (ManagedServiceIdentity) – Identity for the resource.
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. “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. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.
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. Known values are: “Default” and “Restore”.
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. Known values are: “None” and “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass 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.
capacity (Capacity) – The object that represents all properties related to capacity enforcement on an account.
enable_partition_merge (bool) – Flag to indicate enabling/disabling of Partition Merge feature on the account.
minimal_tls_version (str or MinimalTlsVersion) – Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. Known values are: “Tls”, “Tls11”, and “Tls12”.
enable_burst_capacity (bool) – Flag to indicate enabling/disabling of Burst Capacity feature on the account.
customer_managed_key_status (str) – Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
enable_per_region_per_partition_autoscale (bool) – Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.

class azure.mgmt.cosmosdb.models.DatabaseAccountKeysMetadata(**kwargs: Any)[source]

Bases: Model

The metadata related to each access key for the given Cosmos DB database account.

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

Variables:

primary_master_key (AccountKeyMetadata) – The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
secondary_master_key (AccountKeyMetadata) – The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
primary_readonly_master_key (AccountKeyMetadata) – The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
secondary_readonly_master_key (AccountKeyMetadata) – The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.

class azure.mgmt.cosmosdb.models.DatabaseAccountKind(*values)[source]

Bases: str, 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: List[_models.DatabaseAccountConnectionString] | None = None, **kwargs: Any)[source]

Bases: Model

The connection strings for the given database account.

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

class azure.mgmt.cosmosdb.models.DatabaseAccountListKeysResult(**kwargs: Any)[source]

Bases: 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: Any)[source]

Bases: 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 | _models.KeyKind, **kwargs: Any)[source]

Bases: Model

Parameters to regenerate the keys within the database account.

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

Variables:: key_kind (str or KeyKind) – The access key to regenerate. Required. Known values are: “primary”, “secondary”, “primaryReadonly”, and “secondaryReadonly”.
Keyword Arguments:: key_kind (str or KeyKind) – The access key to regenerate. Required. Known values are: “primary”, “secondary”, “primaryReadonly”, and “secondaryReadonly”.

class azure.mgmt.cosmosdb.models.DatabaseAccountUpdateParameters(*, tags: Dict[str, str] | None = None, location: str | None = None, identity: _models.ManagedServiceIdentity | None = None, consistency_policy: _models.ConsistencyPolicy | None = None, locations: List[_models.Location] | None = None, ip_rules: List[_models.IpAddressOrRange] | None = None, is_virtual_network_filter_enabled: bool | None = None, enable_automatic_failover: bool | None = None, capabilities: List[_models.Capability] | None = None, virtual_network_rules: List[_models.VirtualNetworkRule] | None = None, enable_multiple_write_locations: bool | None = None, enable_cassandra_connector: bool | None = None, connector_offer: str | _models.ConnectorOffer | None = None, disable_key_based_metadata_write_access: bool | None = None, key_vault_key_uri: str | None = None, default_identity: str | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, enable_free_tier: bool | None = None, api_properties: _models.ApiProperties | None = None, enable_analytical_storage: bool | None = None, analytical_storage_configuration: _models.AnalyticalStorageConfiguration | None = None, backup_policy: _models.BackupPolicy | None = None, cors: List[_models.CorsPolicy] | None = None, network_acl_bypass: str | _models.NetworkAclBypass | None = None, network_acl_bypass_resource_ids: List[str] | None = None, disable_local_auth: bool | None = None, capacity: _models.Capacity | None = None, enable_partition_merge: bool | None = None, minimal_tls_version: str | _models.MinimalTlsVersion | None = None, enable_burst_capacity: bool | None = None, customer_managed_key_status: str | None = None, enable_per_region_per_partition_autoscale: bool | None = None, **kwargs: Any)[source]

Bases: Model

Parameters for patching Azure Cosmos DB database account properties.

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

Variables:

tags (dict[str, str]) – 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. “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. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.
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. Known values are: “None” and “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass 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.
capacity (Capacity) – The object that represents all properties related to capacity enforcement on an account.
keys_metadata (DatabaseAccountKeysMetadata) – This property is ignored during the update operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.
enable_partition_merge (bool) – Flag to indicate enabling/disabling of Partition Merge feature on the account.
minimal_tls_version (str or MinimalTlsVersion) – Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. Known values are: “Tls”, “Tls11”, and “Tls12”.
enable_burst_capacity (bool) – Flag to indicate enabling/disabling of Burst Capacity feature on the account.
customer_managed_key_status (str) – Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
enable_per_region_per_partition_autoscale (bool) – Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.

Keyword Arguments:

tags (dict[str, str]) – 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. “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. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.
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. Known values are: “None” and “AzureServices”.
network_acl_bypass_resource_ids (list[str]) – An array that contains the Resource Ids for Network Acl Bypass 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.
capacity (Capacity) – The object that represents all properties related to capacity enforcement on an account.
enable_partition_merge (bool) – Flag to indicate enabling/disabling of Partition Merge feature on the account.
minimal_tls_version (str or MinimalTlsVersion) – Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. Known values are: “Tls”, “Tls11”, and “Tls12”.
enable_burst_capacity (bool) – Flag to indicate enabling/disabling of Burst Capacity feature on the account.
customer_managed_key_status (str) – Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
enable_per_region_per_partition_autoscale (bool) – Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.

class azure.mgmt.cosmosdb.models.DatabaseAccountsListResult(**kwargs: Any)[source]

Bases: 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: str | None = None, collection_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Specific Databases to restore.

Variables:

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

Keyword Arguments:

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.DedicatedGatewayType(*values)[source]

Bases: str, Enum

DedicatedGatewayType for the service.

DISTRIBUTED_QUERY = 'DistributedQuery'

INTEGRATED_CACHE = 'IntegratedCache'

class azure.mgmt.cosmosdb.models.DefaultConsistencyLevel(*values)[source]

Bases: str, 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.DistanceFunction(*values)[source]

Bases: str, Enum

The distance function to use for distance calculation in between vectors.

COSINE = 'cosine'

DOTPRODUCT = 'dotproduct'

EUCLIDEAN = 'euclidean'

class azure.mgmt.cosmosdb.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

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

Variables:

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.cosmosdb.models.ErrorDetail(**kwargs: Any)[source]

Bases: Model

The error detail.

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

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

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

Bases: Model

Error Response.

Variables:

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.ErrorResponseAutoGenerated(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:: error (ErrorDetail) – The error object.
Keyword Arguments:: error (ErrorDetail) – The error object.

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

Bases: Model

ExcludedPath.

Variables:: path (str) – The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*).
Keyword Arguments:: 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: Any)[source]

Bases: 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[_models.FailoverPolicy], **kwargs: Any)[source]

Bases: Model

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

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

Variables:: failover_policies (list[FailoverPolicy]) – List of failover policies. Required.
Keyword Arguments:: failover_policies (list[FailoverPolicy]) – List of failover policies. Required.

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

Bases: 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>.
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.

Keyword Arguments:

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.FullTextPath(*, path: str, language: str | None = None, **kwargs: Any)[source]

Bases: Model

Represents the full text path specification.

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

Variables:

path (str) – The path to the full text field in the document. Required.
language (str) – The language of the full text field in the document.

Keyword Arguments:

path (str) – The path to the full text field in the document. Required.
language (str) – The language of the full text field in the document.

class azure.mgmt.cosmosdb.models.FullTextPolicy(*, default_language: str | None = None, full_text_paths: List[_models.FullTextPath] | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB FullText Policy.

Variables:

default_language (str) – The default language for a full text paths.
full_text_paths (list[FullTextPath]) – List of FullText Paths.

Keyword Arguments:

default_language (str) – The default language for a full text paths.
full_text_paths (list[FullTextPath]) – List of FullText Paths.

class azure.mgmt.cosmosdb.models.GraphAPIComputeRegionalServiceResource(**kwargs: Any)[source]

Bases: 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. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.
graph_api_compute_endpoint (str) – The regional endpoint for GraphAPICompute.

class azure.mgmt.cosmosdb.models.GraphAPIComputeServiceResource(*, properties: _models.GraphAPIComputeServiceResourceProperties | None = None, **kwargs: Any)[source]

Bases: Model

Describes the service response property for GraphAPICompute.

Variables:: properties (GraphAPIComputeServiceResourceProperties) – Properties for GraphAPIComputeServiceResource.
Keyword Arguments:: properties (GraphAPIComputeServiceResourceProperties) – Properties for GraphAPIComputeServiceResource.

class azure.mgmt.cosmosdb.models.GraphAPIComputeServiceResourceCreateUpdateProperties(*, instance_size: str | _models.ServiceSize | None = None, instance_count: int | None = None, **kwargs: Any)[source]

Bases: ServiceResourceCreateUpdateProperties

Properties for Create or Update request for GraphAPIComputeServiceResource.

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

Variables:

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

Keyword Arguments:

instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.

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

Bases: 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 server.

Variables:

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
creation_time (datetime) – Time of the last state change (ISO-8601 format).
instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – ServiceType for the service. Required. Known values are: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”, and “MaterializedViewsBuilder”.
status (str or ServiceStatus) – Describes the status of a service. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.
graph_api_compute_endpoint (str) – GraphAPICompute endpoint for the service.
locations (list[GraphAPIComputeRegionalServiceResource]) – An array that contains all of the locations for the service.

Keyword Arguments:

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. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
graph_api_compute_endpoint (str) – GraphAPICompute endpoint for the service.

class azure.mgmt.cosmosdb.models.GremlinDatabaseCreateUpdateParameters(*, resource: _models.GremlinDatabaseResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (GremlinDatabaseResource) – The standard JSON format of a Gremlin database. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

GremlinDatabaseGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: GremlinDatabaseResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB Gremlin database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB Gremlin database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.GremlinDatabaseGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.GremlinDatabaseGetPropertiesResource | None = None, options: _models.GremlinDatabaseGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.GremlinDatabaseListResult(**kwargs: Any)[source]

Bases: 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, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: Model

Cosmos DB Gremlin database resource object.

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

Variables:

id (str) – Name of the Cosmos DB Gremlin database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB Gremlin database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.GremlinDatabaseRestoreResource(*, database_name: str | None = None, graph_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Specific Gremlin Databases to restore.

Variables:

database_name (str) – The name of the gremlin database available for restore.
graph_names (list[str]) – The names of the graphs available for restore.

Keyword Arguments:

database_name (str) – The name of the gremlin database available for restore.
graph_names (list[str]) – The names of the graphs available for restore.

class azure.mgmt.cosmosdb.models.GremlinGraphCreateUpdateParameters(*, resource: _models.GremlinGraphResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (GremlinGraphResource) – The standard JSON format of a Gremlin graph. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

GremlinGraphGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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: _models.IndexingPolicy | None = None, partition_key: _models.ContainerPartitionKey | None = None, default_ttl: int | None = None, unique_key_policy: _models.UniqueKeyPolicy | None = None, conflict_resolution_policy: _models.ConflictResolutionPolicy | None = None, analytical_storage_ttl: int | None = None, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: GremlinGraphResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB Gremlin graph. Required.
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.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB Gremlin graph. Required.
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.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.GremlinGraphGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.GremlinGraphGetPropertiesResource | None = None, options: _models.GremlinGraphGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.GremlinGraphListResult(**kwargs: Any)[source]

Bases: 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: _models.IndexingPolicy | None = None, partition_key: _models.ContainerPartitionKey | None = None, default_ttl: int | None = None, unique_key_policy: _models.UniqueKeyPolicy | None = None, conflict_resolution_policy: _models.ConflictResolutionPolicy | None = None, analytical_storage_ttl: int | None = None, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: Model

Cosmos DB Gremlin graph resource object.

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

Variables:

id (str) – Name of the Cosmos DB Gremlin graph. Required.
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.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB Gremlin graph. Required.
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.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.IncludedPath(*, path: str | None = None, indexes: List[_models.Indexes] | None = None, **kwargs: Any)[source]

Bases: Model

The paths that are included in indexing.

Variables:

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.

Keyword Arguments:

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(*values)[source]

Bases: str, Enum

Indicates the type of index.

HASH = 'Hash'

RANGE = 'Range'

SPATIAL = 'Spatial'

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

Bases: Model

The indexes for the path.

Variables:

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.IndexingMode(*values)[source]

Bases: str, Enum

Indicates the indexing mode.

CONSISTENT = 'consistent'

LAZY = 'lazy'

NONE = 'none'

class azure.mgmt.cosmosdb.models.IndexingPolicy(*, automatic: bool | None = None, indexing_mode: str | _models.IndexingMode = 'consistent', included_paths: List[_models.IncludedPath] | None = None, excluded_paths: List[_models.ExcludedPath] | None = None, composite_indexes: List[List[_models.CompositePath]] | None = None, spatial_indexes: List[_models.SpatialSpec] | None = None, vector_indexes: List[_models.VectorIndex] | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB indexing policy.

Variables:

automatic (bool) – Indicates if the indexing policy is automatic.
indexing_mode (str or IndexingMode) – Indicates the indexing mode. Known values are: “consistent”, “lazy”, and “none”.
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.
vector_indexes (list[VectorIndex]) – List of paths to include in the vector indexing.

Keyword Arguments:

automatic (bool) – Indicates if the indexing policy is automatic.
indexing_mode (str or IndexingMode) – Indicates the indexing mode. Known values are: “consistent”, “lazy”, and “none”.
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.
vector_indexes (list[VectorIndex]) – List of paths to include in the vector indexing.

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

Bases: Model

IpAddressOrRange object.

Variables:: 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”.
Keyword Arguments:: 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(*values)[source]

Bases: str, Enum

The access key to regenerate.

PRIMARY = 'primary'

PRIMARY_READONLY = 'primaryReadonly'

SECONDARY = 'secondary'

SECONDARY_READONLY = 'secondaryReadonly'

class azure.mgmt.cosmosdb.models.KeyWrapMetadata(*, name: str | None = None, type: str | None = None, value: str | None = None, algorithm: str | None = None, **kwargs: Any)[source]

Bases: Model

Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key.

Variables:

name (str) – The name of associated KeyEncryptionKey (aka CustomerManagedKey).
type (str) – ProviderName of KeyStoreProvider.
value (str) – Reference / link to the KeyEncryptionKey.
algorithm (str) – Algorithm used in wrapping and unwrapping of the data encryption key.

Keyword Arguments:

name (str) – The name of associated KeyEncryptionKey (aka CustomerManagedKey).
type (str) – ProviderName of KeyStoreProvider.
value (str) – Reference / link to the KeyEncryptionKey.
algorithm (str) – Algorithm used in wrapping and unwrapping of the data encryption key.

class azure.mgmt.cosmosdb.models.Kind(*values)[source]

Bases: str, Enum

Kind of the connection string key.

PRIMARY = 'Primary'

PRIMARY_READONLY = 'PrimaryReadonly'

SECONDARY = 'Secondary'

SECONDARY_READONLY = 'SecondaryReadonly'

class azure.mgmt.cosmosdb.models.ListClusters(*, value: List[_models.ClusterResource] | None = None, **kwargs: Any)[source]

Bases: Model

List of managed Cassandra clusters.

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

class azure.mgmt.cosmosdb.models.ListDataCenters(**kwargs: Any)[source]

Bases: 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: str | None = None, failover_priority: int | None = None, is_zone_redundant: bool | None = None, **kwargs: Any)[source]

Bases: 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>.
location_name (str) – The name of the region.
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.
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.

Keyword Arguments:

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: _models.LocationProperties | None = None, **kwargs: Any)[source]

Bases: 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.
properties (LocationProperties) – Cosmos DB location metadata.

Keyword Arguments:

properties (LocationProperties) – Cosmos DB location metadata.

class azure.mgmt.cosmosdb.models.LocationListResult(**kwargs: Any)[source]

Bases: 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: Any)[source]

Bases: Model

Cosmos DB location metadata.

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

Variables:

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.
is_subscription_region_access_allowed_for_regular (bool) – Flag indicating whether the subscription have access in region for Non-Availability Zones.
is_subscription_region_access_allowed_for_az (bool) – Flag indicating whether the subscription have access in region for Availability Zones(Az).
status (str or Status) – Enum to indicate current buildout status of the region. Known values are: “Uninitialized”, “Initializing”, “InternallyReady”, “Online”, and “Deleting”.

class azure.mgmt.cosmosdb.models.ManagedCassandraARMResourceProperties(*, location: str | None = None, tags: Dict[str, str] | None = None, identity: _models.ManagedCassandraManagedServiceIdentity | None = None, **kwargs: Any)[source]

Bases: 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.
location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – 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 (ManagedCassandraManagedServiceIdentity) – Identity for the resource.

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – 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 (ManagedCassandraManagedServiceIdentity) – Identity for the resource.

class azure.mgmt.cosmosdb.models.ManagedCassandraManagedServiceIdentity(*, type: str | _models.ManagedCassandraResourceIdentityType | None = None, **kwargs: Any)[source]

Bases: 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 object id of the identity resource.
tenant_id (str) – The tenant id of the resource.
type (str or ManagedCassandraResourceIdentityType) – The type of the resource. Known values are: “SystemAssigned” and “None”.

Keyword Arguments:

type (str or ManagedCassandraResourceIdentityType) – The type of the resource. Known values are: “SystemAssigned” and “None”.

class azure.mgmt.cosmosdb.models.ManagedCassandraProvisioningState(*values)[source]

Bases: str, 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.ManagedCassandraReaperStatus(*, healthy: bool | None = None, repair_run_ids: Dict[str, str] | None = None, repair_schedules: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

ManagedCassandraReaperStatus.

Variables:

healthy (bool)
repair_run_ids (dict[str, str]) – Dictionary of <string>.
repair_schedules (dict[str, str]) – Dictionary of <string>.

Keyword Arguments:

healthy (bool)
repair_run_ids (dict[str, str]) – Dictionary of <string>.
repair_schedules (dict[str, str]) – Dictionary of <string>.

class azure.mgmt.cosmosdb.models.ManagedCassandraResourceIdentityType(*values)[source]

Bases: str, Enum

The type of the resource.

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

class azure.mgmt.cosmosdb.models.ManagedServiceIdentity(*, type: str | _models.ResourceIdentityType | None = None, user_assigned_identities: Dict[str, _models.ManagedServiceIdentityUserAssignedIdentity] | None = None, **kwargs: Any)[source]

Bases: 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.
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. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned,UserAssigned”, and “None”.
user_assigned_identities (dict[str, ManagedServiceIdentityUserAssignedIdentity]) – 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}’.

Keyword Arguments:

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. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned,UserAssigned”, and “None”.
user_assigned_identities (dict[str, ManagedServiceIdentityUserAssignedIdentity]) – 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.ManagedServiceIdentityUserAssignedIdentity(**kwargs: Any)[source]

Bases: Model

ManagedServiceIdentityUserAssignedIdentity.

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.MaterializedViewsBuilderRegionalServiceResource(**kwargs: Any)[source]

Bases: 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. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.

class azure.mgmt.cosmosdb.models.MaterializedViewsBuilderServiceResource(*, properties: _models.MaterializedViewsBuilderServiceResourceProperties | None = None, **kwargs: Any)[source]

Bases: Model

Describes the service response property for MaterializedViewsBuilder.

Variables:: properties (MaterializedViewsBuilderServiceResourceProperties) – Properties for MaterializedViewsBuilderServiceResource.
Keyword Arguments:: properties (MaterializedViewsBuilderServiceResourceProperties) – Properties for MaterializedViewsBuilderServiceResource.

class azure.mgmt.cosmosdb.models.MaterializedViewsBuilderServiceResourceCreateUpdateProperties(*, instance_size: str | _models.ServiceSize | None = None, instance_count: int | None = None, **kwargs: Any)[source]

Bases: ServiceResourceCreateUpdateProperties

Properties for Create or Update request for MaterializedViewsBuilderServiceResource.

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

Variables:

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

Keyword Arguments:

instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.

class azure.mgmt.cosmosdb.models.MaterializedViewsBuilderServiceResourceProperties(*, additional_properties: Dict[str, Any] | None = None, instance_size: str | _models.ServiceSize | None = None, instance_count: int | None = None, **kwargs: Any)[source]

Bases: ServiceResourceProperties

Properties for MaterializedViewsBuilderServiceResource.

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

Variables:

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
creation_time (datetime) – Time of the last state change (ISO-8601 format).
instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – ServiceType for the service. Required. Known values are: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”, and “MaterializedViewsBuilder”.
status (str or ServiceStatus) – Describes the status of a service. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.
locations (list[MaterializedViewsBuilderRegionalServiceResource]) – An array that contains all of the locations for the service.

Keyword Arguments:

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. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.

class azure.mgmt.cosmosdb.models.Metric(**kwargs: Any)[source]

Bases: 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. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, and “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: Any)[source]

Bases: 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: Any)[source]

Bases: 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. Known values are: “None”, “Average”, “Total”, “Minimum”, “Maximum”, and “Last”.
unit (str or UnitType) – The unit of the metric. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, and “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: Any)[source]

Bases: 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: Any)[source]

Bases: 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: Any)[source]

Bases: 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: Any)[source]

Bases: 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.MinimalTlsVersion(*values)[source]

Bases: str, Enum

Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.

TLS = 'Tls'

TLS11 = 'Tls11'

TLS12 = 'Tls12'

class azure.mgmt.cosmosdb.models.MongoDBCollectionCreateUpdateParameters(*, resource: _models.MongoDBCollectionResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (MongoDBCollectionResource) – The standard JSON format of a MongoDB collection. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

MongoDBCollectionGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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: Dict[str, str] | None = None, indexes: List[_models.MongoIndex] | None = None, analytical_storage_ttl: int | None = None, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: MongoDBCollectionResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB MongoDB collection. Required.
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.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB MongoDB collection. Required.
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.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.MongoDBCollectionGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.MongoDBCollectionGetPropertiesResource | None = None, options: _models.MongoDBCollectionGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.MongoDBCollectionListResult(**kwargs: Any)[source]

Bases: 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: Dict[str, str] | None = None, indexes: List[_models.MongoIndex] | None = None, analytical_storage_ttl: int | None = None, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: Model

Cosmos DB MongoDB collection resource object.

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

Variables:

id (str) – Name of the Cosmos DB MongoDB collection. Required.
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.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB MongoDB collection. Required.
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.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.MongoDBDatabaseCreateUpdateParameters(*, resource: _models.MongoDBDatabaseResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (MongoDBDatabaseResource) – The standard JSON format of a MongoDB database. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

MongoDBDatabaseGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: MongoDBDatabaseResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB MongoDB database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB MongoDB database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.MongoDBDatabaseGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.MongoDBDatabaseGetPropertiesResource | None = None, options: _models.MongoDBDatabaseGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.MongoDBDatabaseListResult(**kwargs: Any)[source]

Bases: 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, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: Model

Cosmos DB MongoDB database resource object.

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

Variables:

id (str) – Name of the Cosmos DB MongoDB database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB MongoDB database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.MongoIndex(*, key: _models.MongoIndexKeys | None = None, options: _models.MongoIndexOptions | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB MongoDB collection index key.

Variables:

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

Keyword Arguments:

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

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

Bases: Model

Cosmos DB MongoDB collection resource object.

Variables:: keys (list[str]) – List of keys for each MongoDB collection in the Azure Cosmos DB service.
Keyword Arguments:: 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: int | None = None, unique: bool | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB MongoDB collection index options.

Variables:

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.MongoRoleDefinitionCreateUpdateParameters(*, role_name: str | None = None, type: str | _models.MongoRoleDefinitionType | None = None, database_name: str | None = None, privileges: List[_models.Privilege] | None = None, roles: List[_models.Role] | None = None, **kwargs: Any)[source]

Bases: Model

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

Variables:

role_name (str) – A user-friendly name for the Role Definition. Must be unique for the database account.
type (str or MongoRoleDefinitionType) – Indicates whether the Role Definition was built-in or user created. Known values are: “BuiltInRole” and “CustomRole”.
database_name (str) – The database name for which access is being granted for this Role Definition.
privileges (list[Privilege]) – A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
roles (list[Role]) – The set of roles inherited by this Role Definition.

Keyword Arguments:

role_name (str) – A user-friendly name for the Role Definition. Must be unique for the database account.
type (str or MongoRoleDefinitionType) – Indicates whether the Role Definition was built-in or user created. Known values are: “BuiltInRole” and “CustomRole”.
database_name (str) – The database name for which access is being granted for this Role Definition.
privileges (list[Privilege]) – A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
roles (list[Role]) – The set of roles inherited by this Role Definition.

class azure.mgmt.cosmosdb.models.MongoRoleDefinitionGetResults(*, role_name: str | None = None, type_properties_type: str | _models.MongoRoleDefinitionType | None = None, database_name: str | None = None, privileges: List[_models.Privilege] | None = None, roles: List[_models.Role] | None = None, **kwargs: Any)[source]

Bases: ARMProxyResource

An Azure Cosmos DB Mongo 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.
role_name (str) – A user-friendly name for the Role Definition. Must be unique for the database account.
type_properties_type (str or MongoRoleDefinitionType) – Indicates whether the Role Definition was built-in or user created. Known values are: “BuiltInRole” and “CustomRole”.
database_name (str) – The database name for which access is being granted for this Role Definition.
privileges (list[Privilege]) – A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
roles (list[Role]) – The set of roles inherited by this Role Definition.

Keyword Arguments:

role_name (str) – A user-friendly name for the Role Definition. Must be unique for the database account.
type_properties_type (str or MongoRoleDefinitionType) – Indicates whether the Role Definition was built-in or user created. Known values are: “BuiltInRole” and “CustomRole”.
database_name (str) – The database name for which access is being granted for this Role Definition.
privileges (list[Privilege]) – A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
roles (list[Role]) – The set of roles inherited by this Role Definition.

class azure.mgmt.cosmosdb.models.MongoRoleDefinitionListResult(**kwargs: Any)[source]

Bases: Model

The relevant Mongo Role Definitions.

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

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

class azure.mgmt.cosmosdb.models.MongoRoleDefinitionType(*values)[source]

Bases: str, Enum

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

BUILT_IN_ROLE = 'BuiltInRole'

CUSTOM_ROLE = 'CustomRole'

class azure.mgmt.cosmosdb.models.MongoUserDefinitionCreateUpdateParameters(*, user_name: str | None = None, password: str | None = None, database_name: str | None = None, custom_data: str | None = None, roles: List[_models.Role] | None = None, mechanisms: str | None = None, **kwargs: Any)[source]

Bases: Model

Parameters to create and update an Azure Cosmos DB Mongo User Definition.

Variables:

user_name (str) – The user name for User Definition.
password (str) – The password for User Definition. Response does not contain user password.
database_name (str) – The database name for which access is being granted for this User Definition.
custom_data (str) – A custom definition for the USer Definition.
roles (list[Role]) – The set of roles inherited by the User Definition.
mechanisms (str) – The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.

Keyword Arguments:

user_name (str) – The user name for User Definition.
password (str) – The password for User Definition. Response does not contain user password.
database_name (str) – The database name for which access is being granted for this User Definition.
custom_data (str) – A custom definition for the USer Definition.
roles (list[Role]) – The set of roles inherited by the User Definition.
mechanisms (str) – The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.

Bases: ARMProxyResource

An Azure Cosmos DB User 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.
user_name (str) – The user name for User Definition.
password (str) – The password for User Definition. Response does not contain user password.
database_name (str) – The database name for which access is being granted for this User Definition.
custom_data (str) – A custom definition for the USer Definition.
roles (list[Role]) – The set of roles inherited by the User Definition.
mechanisms (str) – The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.

Keyword Arguments:

user_name (str) – The user name for User Definition.
password (str) – The password for User Definition. Response does not contain user password.
database_name (str) – The database name for which access is being granted for this User Definition.
custom_data (str) – A custom definition for the USer Definition.
roles (list[Role]) – The set of roles inherited by the User Definition.
mechanisms (str) – The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.

class azure.mgmt.cosmosdb.models.MongoUserDefinitionListResult(**kwargs: Any)[source]

Bases: Model

The relevant User Definition.

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

Variables:: value (list[MongoUserDefinitionGetResults]) – List of User Definition and their properties.

class azure.mgmt.cosmosdb.models.NetworkAclBypass(*values)[source]

Bases: str, Enum

Indicates what services are allowed to bypass firewall checks.

AZURE_SERVICES = 'AzureServices'

NONE = 'None'

class azure.mgmt.cosmosdb.models.NodeState(*values)[source]

Bases: str, Enum

The state of the node in Cassandra ring.

JOINING = 'Joining'

LEAVING = 'Leaving'

MOVING = 'Moving'

NORMAL = 'Normal'

STOPPED = 'Stopped'

class azure.mgmt.cosmosdb.models.NodeStatus(*values)[source]

Bases: str, Enum

Indicates whether the node is functioning or not.

DOWN = 'Down'

UP = 'Up'

class azure.mgmt.cosmosdb.models.NotebookWorkspace(**kwargs: Any)[source]

Bases: 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: Any)[source]

Bases: 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: Any)[source]

Bases: 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: List[_models.NotebookWorkspace] | None = None, **kwargs: Any)[source]

Bases: Model

A list of notebook workspace resources.

Variables:: value (list[NotebookWorkspace]) – Array of notebook workspace resources.
Keyword Arguments:: value (list[NotebookWorkspace]) – Array of notebook workspace resources.

class azure.mgmt.cosmosdb.models.NotebookWorkspaceName(*values)[source]

Bases: str, Enum

NotebookWorkspaceName.

DEFAULT = 'default'

class azure.mgmt.cosmosdb.models.Operation(*, name: str | None = None, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

Bases: Model

REST API operation.

Variables:

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

Keyword Arguments:

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

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

Bases: Model

The object that represents the operation.

Variables:

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.

Keyword Arguments:

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: List[_models.Operation] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: 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.

Variables:

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.

Keyword Arguments:

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(*values)[source]

Bases: str, Enum

Enum to indicate the operation type of the event.

CREATE = 'Create'

DELETE = 'Delete'

RECREATE = 'Recreate'

REPLACE = 'Replace'

SYSTEM_OPERATION = 'SystemOperation'

class azure.mgmt.cosmosdb.models.OptionsResource(*, throughput: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB options resource object.

Variables:

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.

Keyword Arguments:

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(*values)[source]

Bases: str, 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: Any)[source]

Bases: 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. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, and “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: Any)[source]

Bases: 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: Any)[source]

Bases: 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. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, and “Milliseconds”.
name (MetricName) – The name information for the metric.
quota_period (str) – The quota period used to summarize the usage values.
limit (int) – Maximum value for this metric.
current_value (int) – 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: Any)[source]

Bases: 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: Any)[source]

Bases: 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. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, and “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: Any)[source]

Bases: 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: Any)[source]

Bases: 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: _models.BackupPolicyMigrationState | None = None, periodic_mode_properties: _models.PeriodicModeProperties | None = None, **kwargs: Any)[source]

Bases: BackupPolicy

The object representing periodic mode backup policy.

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

Variables:

type (str or BackupPolicyType) – Describes the mode of backups. Required. Known values are: “Periodic” and “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.

Keyword Arguments:

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: int | None = None, backup_retention_interval_in_hours: int | None = None, backup_storage_redundancy: str | _models.BackupStorageRedundancy | None = None, **kwargs: Any)[source]

Bases: Model

Configuration values for periodic mode backup.

Variables:

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. Known values are: “Geo”, “Local”, and “Zone”.

Keyword Arguments:

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. Known values are: “Geo”, “Local”, and “Zone”.

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

Bases: Model

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

Variables:

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.

Keyword Arguments:

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(*values)[source]

Bases: str, 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: _models.PrivateEndpointProperty | None = None, private_link_service_connection_state: _models.PrivateLinkServiceConnectionStateProperty | None = None, group_id: str | None = None, provisioning_state: str | None = None, **kwargs: Any)[source]

Bases: 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”.
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.

Keyword Arguments:

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: List[_models.PrivateEndpointConnection] | None = None, **kwargs: Any)[source]

Bases: Model

A list of private endpoint connections.

Variables:: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
Keyword Arguments:: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

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

Bases: Model

Private endpoint which the connection belongs to.

Variables:: id (str) – Resource id of the private endpoint.
Keyword Arguments:: id (str) – Resource id of the private endpoint.

class azure.mgmt.cosmosdb.models.PrivateLinkResource(**kwargs: Any)[source]

Bases: 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: List[_models.PrivateLinkResource] | None = None, **kwargs: Any)[source]

Bases: Model

A list of private link resources.

Variables:: value (list[PrivateLinkResource]) – Array of private link resources.
Keyword Arguments:: value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.cosmosdb.models.PrivateLinkServiceConnectionStateProperty(*, status: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: Model

Connection State of the Private Endpoint Connection.

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.Privilege(*, resource: _models.PrivilegeResource | None = None, actions: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

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

Variables:

resource (PrivilegeResource) – An Azure Cosmos DB Mongo DB Resource.
actions (list[str]) – An array of actions that are allowed.

Keyword Arguments:

resource (PrivilegeResource) – An Azure Cosmos DB Mongo DB Resource.
actions (list[str]) – An array of actions that are allowed.

class azure.mgmt.cosmosdb.models.PrivilegeResource(*, db: str | None = None, collection: str | None = None, **kwargs: Any)[source]

Bases: Model

An Azure Cosmos DB Mongo DB Resource.

Variables:

db (str) – The database name the role is applied.
collection (str) – The collection name the role is applied.

Keyword Arguments:

db (str) – The database name the role is applied.
collection (str) – The collection name the role is applied.

class azure.mgmt.cosmosdb.models.ProxyResource(**kwargs: Any)[source]

Bases: 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(*values)[source]

Bases: str, Enum

Whether requests from Public Network are allowed.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

SECURED_BY_PERIMETER = 'SecuredByPerimeter'

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

Bases: Model

Cosmos DB region to online or offline.

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

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

class azure.mgmt.cosmosdb.models.RegionalServiceResource(**kwargs: Any)[source]

Bases: 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. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.

class azure.mgmt.cosmosdb.models.Resource(**kwargs: Any)[source]

Bases: 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(*values)[source]

Bases: str, 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.ResourceRestoreParameters(*, restore_source: str | None = None, restore_timestamp_in_utc: datetime | None = None, restore_with_ttl_disabled: bool | None = None, **kwargs: Any)[source]

Bases: RestoreParametersBase

Parameters to indicate the information about the restore.

Variables:

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).
restore_with_ttl_disabled (bool) – Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

Keyword Arguments:

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).
restore_with_ttl_disabled (bool) – Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

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

Bases: 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.
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).
oldest_restorable_time (datetime) – The least recent time at which the database account can be restored to (ISO-8601 format).
api_type (str or ApiType) – The API type of the restorable database account. Known values are: “MongoDB”, “Gremlin”, “Cassandra”, “Table”, “Sql”, and “GremlinV2”.
restorable_locations (list[RestorableLocationResource]) – List of regions where the of the database account can be restored from.

Keyword Arguments:

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).
oldest_restorable_time (datetime) – The least recent time at which the database account can be restored to (ISO-8601 format).

class azure.mgmt.cosmosdb.models.RestorableDatabaseAccountsListResult(**kwargs: Any)[source]

Bases: 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.RestorableGremlinDatabaseGetResult(*, resource: _models.RestorableGremlinDatabasePropertiesResource | None = None, **kwargs: Any)[source]

Bases: Model

An Azure Cosmos DB Gremlin 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.
resource (RestorableGremlinDatabasePropertiesResource) – The resource of an Azure Cosmos DB Gremlin database event.

Keyword Arguments:

resource (RestorableGremlinDatabasePropertiesResource) – The resource of an Azure Cosmos DB Gremlin database event.

class azure.mgmt.cosmosdb.models.RestorableGremlinDatabasePropertiesResource(**kwargs: Any)[source]

Bases: Model

The resource of an Azure Cosmos DB Gremlin 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. Known values are: “Create”, “Replace”, “Delete”, “Recreate”, and “SystemOperation”.
can_undelete (str) – A state of this database to identify if this database is restorable in same account.
can_undelete_reason (str) – The reason why this database can not be restored in same account.
event_timestamp (str) – The time when this database event happened.
owner_id (str) – The name of this Gremlin database.
owner_resource_id (str) – The resource ID of this Gremlin database.

class azure.mgmt.cosmosdb.models.RestorableGremlinDatabasesListResult(**kwargs: Any)[source]

Bases: Model

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

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

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

class azure.mgmt.cosmosdb.models.RestorableGremlinGraphGetResult(*, resource: _models.RestorableGremlinGraphPropertiesResource | None = None, **kwargs: Any)[source]

Bases: Model

An Azure Cosmos DB Gremlin graph 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.
resource (RestorableGremlinGraphPropertiesResource) – The resource of an Azure Cosmos DB Gremlin graph event.

Keyword Arguments:

resource (RestorableGremlinGraphPropertiesResource) – The resource of an Azure Cosmos DB Gremlin graph event.

class azure.mgmt.cosmosdb.models.RestorableGremlinGraphPropertiesResource(**kwargs: Any)[source]

Bases: Model

The resource of an Azure Cosmos DB Gremlin graph 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 graph event. Known values are: “Create”, “Replace”, “Delete”, “Recreate”, and “SystemOperation”.
can_undelete (str) – A state of this graph to identify if this graph is restorable in same account.
can_undelete_reason (str) – The reason why this graph can not be restored in same account.
event_timestamp (str) – The time when this graph event happened.
owner_id (str) – The name of this Gremlin graph.
owner_resource_id (str) – The resource ID of this Gremlin graph.

class azure.mgmt.cosmosdb.models.RestorableGremlinGraphsListResult(**kwargs: Any)[source]

Bases: Model

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

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

Variables:: value (list[RestorableGremlinGraphGetResult]) – List of Gremlin graph events and their properties.

class azure.mgmt.cosmosdb.models.RestorableGremlinResourcesGetResult(*, database_name: str | None = None, graph_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Specific Databases to restore.

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.
database_name (str) – The name of the gremlin database available for restore.
graph_names (list[str]) – The names of the graphs available for restore.

Keyword Arguments:

database_name (str) – The name of the gremlin database available for restore.
graph_names (list[str]) – The names of the graphs available for restore.

class azure.mgmt.cosmosdb.models.RestorableGremlinResourcesListResult(**kwargs: Any)[source]

Bases: Model

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

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

Variables:: value (list[RestorableGremlinResourcesGetResult]) – List of restorable Gremlin resources, including the gremlin database and graph names.

class azure.mgmt.cosmosdb.models.RestorableLocationResource(**kwargs: Any)[source]

Bases: 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: _models.RestorableMongodbCollectionPropertiesResource | None = None, **kwargs: Any)[source]

Bases: 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.
resource (RestorableMongodbCollectionPropertiesResource) – The resource of an Azure Cosmos DB MongoDB collection event.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.RestorableMongodbCollectionPropertiesResource(**kwargs: Any)[source]

Bases: 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. Known values are: “Create”, “Replace”, “Delete”, “Recreate”, and “SystemOperation”.
can_undelete (str) – A state of this collection to identify if this container is restorable in same account.
can_undelete_reason (str) – The reason why this collection can not be restored in same account.
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: Any)[source]

Bases: 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: _models.RestorableMongodbDatabasePropertiesResource | None = None, **kwargs: Any)[source]

Bases: 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.
resource (RestorableMongodbDatabasePropertiesResource) – The resource of an Azure Cosmos DB MongoDB database event.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.RestorableMongodbDatabasePropertiesResource(**kwargs: Any)[source]

Bases: 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. Known values are: “Create”, “Replace”, “Delete”, “Recreate”, and “SystemOperation”.
can_undelete (str) – A state of this database to identify if this database is restorable in same account.
can_undelete_reason (str) – The reason why this database can not be restored in same account.
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: Any)[source]

Bases: 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.RestorableMongodbResourcesGetResult(*, database_name: str | None = None, collection_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Specific Databases to restore.

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.
database_name (str) – The name of the database available for restore.
collection_names (list[str]) – The names of the collections available for restore.

Keyword Arguments:

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.RestorableMongodbResourcesListResult(**kwargs: Any)[source]

Bases: 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[RestorableMongodbResourcesGetResult]) – List of restorable MongoDB resources, including the database and collection names.

class azure.mgmt.cosmosdb.models.RestorableSqlContainerGetResult(*, resource: _models.RestorableSqlContainerPropertiesResource | None = None, **kwargs: Any)[source]

Bases: 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.
resource (RestorableSqlContainerPropertiesResource) – The resource of an Azure Cosmos DB SQL container event.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.RestorableSqlContainerPropertiesResource(*, container: _models.RestorableSqlContainerPropertiesResourceContainer | None = None, **kwargs: Any)[source]

Bases: 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. Known values are: “Create”, “Replace”, “Delete”, “Recreate”, and “SystemOperation”.
can_undelete (str) – A state of this container to identify if this container is restorable in same account.
can_undelete_reason (str) – The reason why this container can not be restored in same account.
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.
container (RestorableSqlContainerPropertiesResourceContainer) – Cosmos DB SQL container resource object.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.RestorableSqlContainerPropertiesResourceContainer(*, id: str, indexing_policy: _models.IndexingPolicy | None = None, partition_key: _models.ContainerPartitionKey | None = None, default_ttl: int | None = None, unique_key_policy: _models.UniqueKeyPolicy | None = None, conflict_resolution_policy: _models.ConflictResolutionPolicy | None = None, client_encryption_policy: _models.ClientEncryptionPolicy | None = None, analytical_storage_ttl: int | None = None, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', computed_properties: List[_models.ComputedProperty] | None = None, vector_embedding_policy: _models.VectorEmbeddingPolicy | None = None, full_text_policy: _models.FullTextPolicy | None = None, **kwargs: Any)[source]

Bases: SqlContainerResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB SQL container. Required.
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.
client_encryption_policy (ClientEncryptionPolicy) – The client encryption policy for the container.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
computed_properties (list[ComputedProperty]) – List of computed properties.
vector_embedding_policy (VectorEmbeddingPolicy) – The vector embedding policy for the container.
full_text_policy (FullTextPolicy) – The FullText policy for the container.
self_property (str) – A system generated property that specifies the addressable path of the container resource.

Keyword Arguments:

id (str) – Name of the Cosmos DB SQL container. Required.
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.
client_encryption_policy (ClientEncryptionPolicy) – The client encryption policy for the container.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
computed_properties (list[ComputedProperty]) – List of computed properties.
vector_embedding_policy (VectorEmbeddingPolicy) – The vector embedding policy for the container.
full_text_policy (FullTextPolicy) – The FullText policy for the container.

class azure.mgmt.cosmosdb.models.RestorableSqlContainersListResult(**kwargs: Any)[source]

Bases: 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: _models.RestorableSqlDatabasePropertiesResource | None = None, **kwargs: Any)[source]

Bases: 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.
resource (RestorableSqlDatabasePropertiesResource) – The resource of an Azure Cosmos DB SQL database event.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.RestorableSqlDatabasePropertiesResource(*, database: _models.RestorableSqlDatabasePropertiesResourceDatabase | None = None, **kwargs: Any)[source]

Bases: 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. Known values are: “Create”, “Replace”, “Delete”, “Recreate”, and “SystemOperation”.
can_undelete (str) – A state of this database to identify if this database is restorable in same account.
can_undelete_reason (str) – The reason why this database can not be restored in same account.
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.
database (RestorableSqlDatabasePropertiesResourceDatabase) – Cosmos DB SQL database resource object.

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.RestorableSqlDatabasePropertiesResourceDatabase(*, id: str, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: SqlDatabaseResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB SQL database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
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.

Keyword Arguments:

id (str) – Name of the Cosmos DB SQL database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.RestorableSqlDatabasesListResult(**kwargs: Any)[source]

Bases: 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.RestorableSqlResourcesGetResult(*, database_name: str | None = None, collection_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Specific Databases to restore.

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.
database_name (str) – The name of the database available for restore.
collection_names (list[str]) – The names of the collections available for restore.

Keyword Arguments:

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.RestorableSqlResourcesListResult(**kwargs: Any)[source]

Bases: 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[RestorableSqlResourcesGetResult]) – List of restorable SQL resources, including the database and collection names.

class azure.mgmt.cosmosdb.models.RestorableTableGetResult(*, resource: _models.RestorableTablePropertiesResource | None = None, **kwargs: Any)[source]

Bases: Model

An Azure Cosmos DB Table 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.
resource (RestorableTablePropertiesResource) – The resource of an Azure Cosmos DB Table event.

Keyword Arguments:

resource (RestorableTablePropertiesResource) – The resource of an Azure Cosmos DB Table event.

class azure.mgmt.cosmosdb.models.RestorableTablePropertiesResource(**kwargs: Any)[source]

Bases: Model

The resource of an Azure Cosmos DB Table 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 table event. Known values are: “Create”, “Replace”, “Delete”, “Recreate”, and “SystemOperation”.
can_undelete (str) – A state of this table to identify if this table is restorable in same account.
can_undelete_reason (str) – The reason why this table can not be restored in same account.
event_timestamp (str) – The time when this table event happened.
owner_id (str) – The name of this Table.
owner_resource_id (str) – The resource ID of this Table.

class azure.mgmt.cosmosdb.models.RestorableTableResourcesGetResult(**kwargs: Any)[source]

Bases: Model

Specific Databases to restore.

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 Table.
type (str) – The type of Azure resource.

class azure.mgmt.cosmosdb.models.RestorableTableResourcesListResult(**kwargs: Any)[source]

Bases: Model

List of restorable table names.

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

Variables:: value (list[RestorableTableResourcesGetResult]) – List of restorable table names.

class azure.mgmt.cosmosdb.models.RestorableTablesListResult(**kwargs: Any)[source]

Bases: Model

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

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

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

class azure.mgmt.cosmosdb.models.RestoreMode(*values)[source]

Bases: str, Enum

Describes the mode of the restore.

POINT_IN_TIME = 'PointInTime'

class azure.mgmt.cosmosdb.models.RestoreParameters(*, restore_source: str | None = None, restore_timestamp_in_utc: datetime | None = None, restore_with_ttl_disabled: bool | None = None, restore_mode: str | _models.RestoreMode | None = None, databases_to_restore: List[_models.DatabaseRestoreResource] | None = None, gremlin_databases_to_restore: List[_models.GremlinDatabaseRestoreResource] | None = None, tables_to_restore: List[str] | None = None, **kwargs: Any)[source]

Bases: RestoreParametersBase

Parameters to indicate the information about the restore.

Variables:

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).
restore_with_ttl_disabled (bool) – Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restore_mode (str or RestoreMode) – Describes the mode of the restore. “PointInTime”
databases_to_restore (list[DatabaseRestoreResource]) – List of specific databases available for restore.
gremlin_databases_to_restore (list[GremlinDatabaseRestoreResource]) – List of specific gremlin databases available for restore.
tables_to_restore (list[str]) – List of specific tables available for restore.

Keyword Arguments:

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).
restore_with_ttl_disabled (bool) – Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restore_mode (str or RestoreMode) – Describes the mode of the restore. “PointInTime”
databases_to_restore (list[DatabaseRestoreResource]) – List of specific databases available for restore.
gremlin_databases_to_restore (list[GremlinDatabaseRestoreResource]) – List of specific gremlin databases available for restore.
tables_to_restore (list[str]) – List of specific tables available for restore.

class azure.mgmt.cosmosdb.models.RestoreParametersBase(*, restore_source: str | None = None, restore_timestamp_in_utc: datetime | None = None, restore_with_ttl_disabled: bool | None = None, **kwargs: Any)[source]

Bases: Model

Parameters to indicate the information about the restore.

Variables:

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).
restore_with_ttl_disabled (bool) – Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

Keyword Arguments:

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).
restore_with_ttl_disabled (bool) – Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

class azure.mgmt.cosmosdb.models.Role(*, db: str | None = None, role: str | None = None, **kwargs: Any)[source]

Bases: Model

The set of roles permitted through this Role Definition.

Variables:

db (str) – The database name the role is applied.
role (str) – The role name.

Keyword Arguments:

db (str) – The database name the role is applied.
role (str) – The role name.

class azure.mgmt.cosmosdb.models.RoleDefinitionType(*values)[source]

Bases: str, 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: str | None = None, **kwargs: Any)[source]

Bases: Model

SeedNode.

Variables:: ip_address (str) – IP address of this seed node.
Keyword Arguments:: ip_address (str) – IP address of this seed node.

class azure.mgmt.cosmosdb.models.ServerVersion(*values)[source]

Bases: str, Enum

Describes the version of the MongoDB account.

FIVE0 = '5.0'

FOUR0 = '4.0'

FOUR2 = '4.2'

SEVEN0 = '7.0'

SIX0 = '6.0'

THREE2 = '3.2'

THREE6 = '3.6'

class azure.mgmt.cosmosdb.models.ServiceResource(*, properties: _models.ServiceResourceProperties | None = None, **kwargs: Any)[source]

Bases: 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.
properties (ServiceResourceProperties) – Services response resource.

Keyword Arguments:

properties (ServiceResourceProperties) – Services response resource.

class azure.mgmt.cosmosdb.models.ServiceResourceCreateUpdateParameters(*, properties: _models.ServiceResourceCreateUpdateProperties | None = None, **kwargs: Any)[source]

Bases: Model

Parameters for Create or Update request for ServiceResource.

Variables:: properties (ServiceResourceCreateUpdateProperties) – Properties in ServiceResourceCreateUpdateParameters.
Keyword Arguments:: properties (ServiceResourceCreateUpdateProperties) – Properties in ServiceResourceCreateUpdateParameters.

class azure.mgmt.cosmosdb.models.ServiceResourceCreateUpdateProperties(*, instance_size: str | _models.ServiceSize | None = None, instance_count: int | None = None, **kwargs: Any)[source]

Bases: Model

Properties in ServiceResourceCreateUpdateParameters.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DataTransferServiceResourceCreateUpdateProperties, GraphAPIComputeServiceResourceCreateUpdateProperties, MaterializedViewsBuilderServiceResourceCreateUpdateProperties, SqlDedicatedGatewayServiceResourceCreateUpdateProperties

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

Variables:

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

Keyword Arguments:

instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.

class azure.mgmt.cosmosdb.models.ServiceResourceListResult(**kwargs: Any)[source]

Bases: 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: Dict[str, Any] | None = None, instance_size: str | _models.ServiceSize | None = None, instance_count: int | None = None, **kwargs: Any)[source]

Bases: Model

Services response resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DataTransferServiceResourceProperties, GraphAPIComputeServiceResourceProperties, MaterializedViewsBuilderServiceResourceProperties, 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 server.

Variables:

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
creation_time (datetime) – Time of the last state change (ISO-8601 format).
instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – ServiceType for the service. Required. Known values are: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”, and “MaterializedViewsBuilder”.
status (str or ServiceStatus) – Describes the status of a service. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.

Keyword Arguments:

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. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.

class azure.mgmt.cosmosdb.models.ServiceSize(*values)[source]

Bases: str, 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(*values)[source]

Bases: str, 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(*values)[source]

Bases: str, Enum

ServiceType for the service.

DATA_TRANSFER = 'DataTransfer'

GRAPH_API_COMPUTE = 'GraphAPICompute'

MATERIALIZED_VIEWS_BUILDER = 'MaterializedViewsBuilder'

SQL_DEDICATED_GATEWAY = 'SqlDedicatedGateway'

class azure.mgmt.cosmosdb.models.SpatialSpec(*, path: str | None = None, types: List[str | _models.SpatialType] | None = None, **kwargs: Any)[source]

Bases: Model

SpatialSpec.

Variables:

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.

Keyword Arguments:

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(*values)[source]

Bases: str, Enum

Indicates the spatial type of index.

LINE_STRING = 'LineString'

MULTI_POLYGON = 'MultiPolygon'

POINT = 'Point'

POLYGON = 'Polygon'

class azure.mgmt.cosmosdb.models.SqlContainerCreateUpdateParameters(*, resource: _models.SqlContainerResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlContainerResource) – The standard JSON format of a container. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

SqlContainerGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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: _models.IndexingPolicy | None = None, partition_key: _models.ContainerPartitionKey | None = None, default_ttl: int | None = None, unique_key_policy: _models.UniqueKeyPolicy | None = None, conflict_resolution_policy: _models.ConflictResolutionPolicy | None = None, client_encryption_policy: _models.ClientEncryptionPolicy | None = None, analytical_storage_ttl: int | None = None, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', computed_properties: List[_models.ComputedProperty] | None = None, vector_embedding_policy: _models.VectorEmbeddingPolicy | None = None, full_text_policy: _models.FullTextPolicy | None = None, **kwargs: Any)[source]

Bases: SqlContainerResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB SQL container. Required.
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.
client_encryption_policy (ClientEncryptionPolicy) – The client encryption policy for the container.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
computed_properties (list[ComputedProperty]) – List of computed properties.
vector_embedding_policy (VectorEmbeddingPolicy) – The vector embedding policy for the container.
full_text_policy (FullTextPolicy) – The FullText policy for the container.

Keyword Arguments:

id (str) – Name of the Cosmos DB SQL container. Required.
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.
client_encryption_policy (ClientEncryptionPolicy) – The client encryption policy for the container.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
computed_properties (list[ComputedProperty]) – List of computed properties.
vector_embedding_policy (VectorEmbeddingPolicy) – The vector embedding policy for the container.
full_text_policy (FullTextPolicy) – The FullText policy for the container.

class azure.mgmt.cosmosdb.models.SqlContainerGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.SqlContainerGetPropertiesResource | None = None, options: _models.SqlContainerGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.SqlContainerListResult(**kwargs: Any)[source]

Bases: 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: _models.IndexingPolicy | None = None, partition_key: _models.ContainerPartitionKey | None = None, default_ttl: int | None = None, unique_key_policy: _models.UniqueKeyPolicy | None = None, conflict_resolution_policy: _models.ConflictResolutionPolicy | None = None, client_encryption_policy: _models.ClientEncryptionPolicy | None = None, analytical_storage_ttl: int | None = None, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', computed_properties: List[_models.ComputedProperty] | None = None, vector_embedding_policy: _models.VectorEmbeddingPolicy | None = None, full_text_policy: _models.FullTextPolicy | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB SQL container resource object.

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

Variables:

id (str) – Name of the Cosmos DB SQL container. Required.
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.
client_encryption_policy (ClientEncryptionPolicy) – The client encryption policy for the container.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
computed_properties (list[ComputedProperty]) – List of computed properties.
vector_embedding_policy (VectorEmbeddingPolicy) – The vector embedding policy for the container.
full_text_policy (FullTextPolicy) – The FullText policy for the container.

Keyword Arguments:

id (str) – Name of the Cosmos DB SQL container. Required.
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.
client_encryption_policy (ClientEncryptionPolicy) – The client encryption policy for the container.
analytical_storage_ttl (int) – Analytical TTL.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
computed_properties (list[ComputedProperty]) – List of computed properties.
vector_embedding_policy (VectorEmbeddingPolicy) – The vector embedding policy for the container.
full_text_policy (FullTextPolicy) – The FullText policy for the container.

class azure.mgmt.cosmosdb.models.SqlDatabaseCreateUpdateParameters(*, resource: _models.SqlDatabaseResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (SqlDatabaseResource) – The standard JSON format of a SQL database. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

SqlDatabaseGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', colls: str | None = None, users: str | None = None, **kwargs: Any)[source]

Bases: SqlDatabaseResource, ExtendedResourceProperties

SqlDatabaseGetPropertiesResource.

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

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

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.
id (str) – Name of the Cosmos DB SQL database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
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.

Keyword Arguments:

id (str) – Name of the Cosmos DB SQL database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.
colls (str) – A system generated property that specified the addressable path of the collections resource.
users (str) – A system generated property that specifies the addressable path of the users resource.

class azure.mgmt.cosmosdb.models.SqlDatabaseGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.SqlDatabaseGetPropertiesResource | None = None, options: _models.SqlDatabaseGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.SqlDatabaseListResult(**kwargs: Any)[source]

Bases: 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, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: Model

Cosmos DB SQL database resource object.

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

Variables:

id (str) – Name of the Cosmos DB SQL database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB SQL database. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.SqlDedicatedGatewayRegionalServiceResource(**kwargs: Any)[source]

Bases: 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. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.
sql_dedicated_gateway_endpoint (str) – The regional endpoint for SqlDedicatedGateway.

class azure.mgmt.cosmosdb.models.SqlDedicatedGatewayServiceResource(*, properties: _models.SqlDedicatedGatewayServiceResourceProperties | None = None, **kwargs: Any)[source]

Bases: Model

Describes the service response property for SqlDedicatedGateway.

Variables:: properties (SqlDedicatedGatewayServiceResourceProperties) – Properties for SqlDedicatedGatewayServiceResource.
Keyword Arguments:: properties (SqlDedicatedGatewayServiceResourceProperties) – Properties for SqlDedicatedGatewayServiceResource.

class azure.mgmt.cosmosdb.models.SqlDedicatedGatewayServiceResourceCreateUpdateProperties(*, instance_size: str | _models.ServiceSize | None = None, instance_count: int | None = None, dedicated_gateway_type: str | _models.DedicatedGatewayType | None = None, **kwargs: Any)[source]

Bases: ServiceResourceCreateUpdateProperties

Properties for Create or Update request for SqlDedicatedGatewayServiceResource.

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

Variables:

instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – ServiceType for the service. Required. Known values are: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”, and “MaterializedViewsBuilder”.
dedicated_gateway_type (str or DedicatedGatewayType) – DedicatedGatewayType for the service. Known values are: “IntegratedCache” and “DistributedQuery”.

Keyword Arguments:

instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
dedicated_gateway_type (str or DedicatedGatewayType) – DedicatedGatewayType for the service. Known values are: “IntegratedCache” and “DistributedQuery”.

class azure.mgmt.cosmosdb.models.SqlDedicatedGatewayServiceResourceProperties(*, additional_properties: Dict[str, Any] | None = None, instance_size: str | _models.ServiceSize | None = None, instance_count: int | None = None, sql_dedicated_gateway_endpoint: str | None = None, dedicated_gateway_type: str | _models.DedicatedGatewayType | None = None, **kwargs: Any)[source]

Bases: 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 server.

Variables:

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
creation_time (datetime) – Time of the last state change (ISO-8601 format).
instance_size (str or ServiceSize) – Instance type for the service. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
service_type (str or ServiceType) – ServiceType for the service. Required. Known values are: “SqlDedicatedGateway”, “DataTransfer”, “GraphAPICompute”, and “MaterializedViewsBuilder”.
status (str or ServiceStatus) – Describes the status of a service. Known values are: “Creating”, “Running”, “Updating”, “Deleting”, “Error”, and “Stopped”.
sql_dedicated_gateway_endpoint (str) – SqlDedicatedGateway endpoint for the service.
dedicated_gateway_type (str or DedicatedGatewayType) – DedicatedGatewayType for the service. Known values are: “IntegratedCache” and “DistributedQuery”.
locations (list[SqlDedicatedGatewayRegionalServiceResource]) – An array that contains all of the locations for the service.

Keyword Arguments:

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. Known values are: “Cosmos.D4s”, “Cosmos.D8s”, and “Cosmos.D16s”.
instance_count (int) – Instance count for the service.
sql_dedicated_gateway_endpoint (str) – SqlDedicatedGateway endpoint for the service.
dedicated_gateway_type (str or DedicatedGatewayType) – DedicatedGatewayType for the service. Known values are: “IntegratedCache” and “DistributedQuery”.

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

Bases: Model

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

Variables:

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.

Keyword Arguments:

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: str | None = None, scope: str | None = None, principal_id: str | None = None, **kwargs: Any)[source]

Bases: 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.
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.

Keyword Arguments:

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: Any)[source]

Bases: 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: str | None = None, type: str | _models.RoleDefinitionType | None = None, assignable_scopes: List[str] | None = None, permissions: List[_models.Permission] | None = None, **kwargs: Any)[source]

Bases: Model

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

Variables:

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. Known values are: “BuiltInRole” and “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.

Keyword Arguments:

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. Known values are: “BuiltInRole” and “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: str | None = None, type_properties_type: str | _models.RoleDefinitionType | None = None, assignable_scopes: List[str] | None = None, permissions: List[_models.Permission] | None = None, **kwargs: Any)[source]

Bases: 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.
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. Known values are: “BuiltInRole” and “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.

Keyword Arguments:

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. Known values are: “BuiltInRole” and “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: Any)[source]

Bases: 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: _models.SqlStoredProcedureResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

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

Bases: SqlStoredProcedureResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB SQL storedProcedure. Required.
body (str) – Body of the Stored Procedure.

Keyword Arguments:

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

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

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.SqlStoredProcedureListResult(**kwargs: Any)[source]

Bases: 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: str | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB SQL storedProcedure resource object.

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.SqlTriggerCreateUpdateParameters(*, resource: _models.SqlTriggerResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

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

Bases: SqlTriggerResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB SQL trigger. Required.
body (str) – Body of the Trigger.
trigger_type (str or TriggerType) – Type of the Trigger. Known values are: “Pre” and “Post”.
trigger_operation (str or TriggerOperation) – The operation the trigger is associated with. Known values are: “All”, “Create”, “Update”, “Delete”, and “Replace”.

Keyword Arguments:

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

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

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.SqlTriggerListResult(**kwargs: Any)[source]

Bases: 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.

Bases: Model

Cosmos DB SQL trigger resource object.

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionCreateUpdateParameters(*, resource: _models.SqlUserDefinedFunctionResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

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

Bases: SqlUserDefinedFunctionResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB SQL userDefinedFunction. Required.
body (str) – Body of the User Defined Function.

Keyword Arguments:

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

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

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionListResult(**kwargs: Any)[source]

Bases: 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: str | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB SQL userDefinedFunction resource object.

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.Status(*values)[source]

Bases: str, Enum

Enum to indicate current buildout status of the region.

DELETING = 'Deleting'

INITIALIZING = 'Initializing'

INTERNALLY_READY = 'InternallyReady'

ONLINE = 'Online'

UNINITIALIZED = 'Uninitialized'

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “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. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “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. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.cosmosdb.models.TableCreateUpdateParameters(*, resource: _models.TableResource, location: str | None = None, tags: Dict[str, str] | None = None, options: _models.CreateUpdateOptions | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

location (str) – The location of the resource group to which the resource belongs.
tags (dict[str, str]) – Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.
resource (TableResource) – The standard JSON format of a Table. Required.
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: int | None = None, autoscale_settings: _models.AutoscaleSettings | None = None, **kwargs: Any)[source]

Bases: OptionsResource

TableGetPropertiesOptions.

Variables:

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.

Keyword Arguments:

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, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: TableResource, ExtendedResourceProperties

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

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.
id (str) – Name of the Cosmos DB table. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB table. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

class azure.mgmt.cosmosdb.models.TableGetResults(*, location: str | None = None, tags: Dict[str, str] | None = None, resource: _models.TableGetPropertiesResource | None = None, options: _models.TableGetPropertiesOptions | None = None, **kwargs: Any)[source]

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.TableListResult(**kwargs: Any)[source]

Bases: 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, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', **kwargs: Any)[source]

Bases: Model

Cosmos DB table resource object.

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

Variables:

id (str) – Name of the Cosmos DB table. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

Keyword Arguments:

id (str) – Name of the Cosmos DB table. Required.
restore_parameters (ResourceRestoreParameters) – Parameters to indicate the information about the restore.
create_mode (str or CreateMode) – Enum to indicate the mode of resource creation. Known values are: “Default” and “Restore”.

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

Bases: Model

Cosmos DB resource throughput policy.

Variables:

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.

Keyword Arguments:

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: int | None = None, autoscale_settings: _models.AutoscaleSettingsResource | None = None, **kwargs: Any)[source]

Bases: ThroughputSettingsResource, ExtendedResourceProperties

ThroughputSettingsGetPropertiesResource.

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.
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.
minimum_throughput (str) – The minimum throughput of the resource.
offer_replace_pending (str) – The throughput replace is pending.
instant_maximum_throughput (str) – The offer throughput value to instantly scale up without triggering splits.
soft_allowed_maximum_throughput (str) – The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified.

Keyword Arguments:

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.

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

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.ThroughputSettingsResource(*, throughput: int | None = None, autoscale_settings: _models.AutoscaleSettingsResource | None = None, **kwargs: Any)[source]

Bases: 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.

Variables:

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.
minimum_throughput (str) – The minimum throughput of the resource.
offer_replace_pending (str) – The throughput replace is pending.
instant_maximum_throughput (str) – The offer throughput value to instantly scale up without triggering splits.
soft_allowed_maximum_throughput (str) – The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified.

Keyword Arguments:

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.

class azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters(*, resource: _models.ThroughputSettingsResource, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: 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 server.

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

Keyword Arguments:

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

class azure.mgmt.cosmosdb.models.TriggerOperation(*values)[source]

Bases: str, Enum

The operation the trigger is associated with.

ALL = 'All'

CREATE = 'Create'

DELETE = 'Delete'

REPLACE = 'Replace'

UPDATE = 'Update'

class azure.mgmt.cosmosdb.models.TriggerType(*values)[source]

Bases: str, Enum

Type of the Trigger.

POST = 'Post'

PRE = 'Pre'

class azure.mgmt.cosmosdb.models.Type(*values)[source]

Bases: str, Enum

Type of the connection string.

CASSANDRA = 'Cassandra'

CASSANDRA_CONNECTOR_METADATA = 'CassandraConnectorMetadata'

GREMLIN = 'Gremlin'

GREMLIN_V2 = 'GremlinV2'

MONGO_DB = 'MongoDB'

SQL = 'Sql'

SQL_DEDICATED_GATEWAY = 'SqlDedicatedGateway'

TABLE = 'Table'

UNDEFINED = 'Undefined'

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

Bases: Model

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

Variables:: paths (list[str]) – List of paths must be unique for each document in the Azure Cosmos DB service.
Keyword Arguments:: 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: List[_models.UniqueKey] | None = None, **kwargs: Any)[source]

Bases: Model

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

Variables:: unique_keys (list[UniqueKey]) – List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
Keyword Arguments:: 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(*values)[source]

Bases: str, 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: Any)[source]

Bases: 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. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”, and “Milliseconds”.
name (MetricName) – The name information for the metric.
quota_period (str) – The quota period used to summarize the usage values.
limit (int) – Maximum value for this metric.
current_value (int) – Current value for this metric.

class azure.mgmt.cosmosdb.models.UsagesResult(**kwargs: Any)[source]

Bases: 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.VectorDataType(*values)[source]

Bases: str, Enum

Indicates the data type of vector.

FLOAT32 = 'float32'

INT8 = 'int8'

UINT8 = 'uint8'

class azure.mgmt.cosmosdb.models.VectorEmbedding(*, path: str, data_type: str | _models.VectorDataType, distance_function: str | _models.DistanceFunction, dimensions: int, **kwargs: Any)[source]

Bases: Model

Represents a vector embedding. A vector embedding is used to define a vector field in the documents.

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

Variables:

path (str) – The path to the vector field in the document. Required.
data_type (str or VectorDataType) – Indicates the data type of vector. Required. Known values are: “float32”, “uint8”, and “int8”.
distance_function (str or DistanceFunction) – The distance function to use for distance calculation in between vectors. Required. Known values are: “euclidean”, “cosine”, and “dotproduct”.
dimensions (int) – The number of dimensions in the vector. Required.

Keyword Arguments:

path (str) – The path to the vector field in the document. Required.
data_type (str or VectorDataType) – Indicates the data type of vector. Required. Known values are: “float32”, “uint8”, and “int8”.
distance_function (str or DistanceFunction) – The distance function to use for distance calculation in between vectors. Required. Known values are: “euclidean”, “cosine”, and “dotproduct”.
dimensions (int) – The number of dimensions in the vector. Required.

class azure.mgmt.cosmosdb.models.VectorEmbeddingPolicy(*, vector_embeddings: List[_models.VectorEmbedding] | None = None, **kwargs: Any)[source]

Bases: Model

Cosmos DB Vector Embedding Policy.

Variables:: vector_embeddings (list[VectorEmbedding]) – List of vector embeddings.
Keyword Arguments:: vector_embeddings (list[VectorEmbedding]) – List of vector embeddings.

class azure.mgmt.cosmosdb.models.VectorIndex(*, path: str, type: str | _models.VectorIndexType, **kwargs: Any)[source]

Bases: Model

VectorIndex.

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

Variables:

path (str) – The path to the vector field in the document. Required.
type (str or VectorIndexType) – The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported. Required. Known values are: “flat”, “diskANN”, and “quantizedFlat”.

Keyword Arguments:

path (str) – The path to the vector field in the document. Required.
type (str or VectorIndexType) – The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported. Required. Known values are: “flat”, “diskANN”, and “quantizedFlat”.

class azure.mgmt.cosmosdb.models.VectorIndexType(*values)[source]

Bases: str, Enum

The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

DISK_ANN = 'diskANN'

FLAT = 'flat'

QUANTIZED_FLAT = 'quantizedFlat'

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

Bases: Model

Virtual Network ACL Rule object.

Variables:

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.

Keyword Arguments:

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.