Azure.ResourceManager.CosmosDB.Models Namespace

Access rule in a network security perimeter configuration profile.

Properties of Access Rule.

Model factory for models.

Ldap authentication method properties. This feature is in preview.

Cosmos DB provisioned throughput settings object.

An Azure Blob Storage data source/sink.

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

A base CosmosDB data source/sink Please note BaseCosmosDataTransferDataSourceSink is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CosmosCassandraDataTransferDataSourceSink, CosmosMongoDataTransferDataSourceSink and CosmosSqlDataTransferDataSourceSink.

The transition state information related capacity mode change with update request.

The CassandraCertificate.

A restorable backup of a Cassandra cluster.

The CassandraClusterBackupSchedule.

resource representing a command.

The CassandraClusterDataCenterNodeItem.

Cosmos DB Cassandra table cluster key.

Properties of a managed Cassandra cluster.

Properties of a managed Cassandra cluster public status.

The CassandraClusterPublicStatusDataCentersItem.

Cosmos DB Cassandra table column.

Response of /command api.

Specification of which command to run where.

The CassandraConnectionError.

Properties of a managed Cassandra data center.

The CassandraDataCenterSeedNode.

The CassandraError.

Parameters to create and update Cosmos DB Cassandra keyspace.

The CassandraKeyspacePropertiesConfig.

Cosmos DB Cassandra keyspace resource object.

Cosmos DB Cassandra table partition key.

The CassandraReaperStatus.

Cosmos DB Cassandra table schema.

Parameters to create and update Cosmos DB Cassandra table.

The CassandraTablePropertiesConfig.

Cosmos DB Cassandra table resource object.

The CassandraViewGetPropertiesOptions.

The CassandraViewGetPropertiesResource.

Parameters to create and update Cosmos DB Cassandra view.

Cosmos DB Cassandra view resource object.

The definition of a computed property.

The conflict resolution policy for the container.

The consistency policy for the Cosmos DB database account.

Properties of the regional restorable account.

The object representing continuous mode backup policy.

A CosmosDB Cassandra API data source/sink.

The object representing the policy for taking backups on an account. Please note CosmosDBAccountBackupPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ContinuousModeBackupPolicy and PeriodicModeBackupPolicy.

Cosmos DB capability object.

Connection string for the Cosmos DB account.

The CORS policy for the Cosmos DB database account.

Parameters to create and update Cosmos DB database accounts.

The access keys for the given database account.

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

Parameters for patching Azure Cosmos DB database account properties.

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

Parameters to regenerate the keys within the database account.

Parameters to indicate the information about the restore.

Backup information of a resource.

Cosmos DB options resource object.

Metric data.

The usage data for a usage request.

.

Cosmos DB client encryption policy.

The CosmosDBCompositePath.

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

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

Error Response.

The CosmosDBExcludedPath.

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

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

The paths that are included in indexing.

Cosmos DB indexing policy.

IpAddressOrRange object.

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

Cosmos DB location metadata.

The availability of the metric.

The definition of a metric.

A metric name.

Represents metrics values.

The indexes for the path.

Percentile Metric data.

Connection State of the Private Endpoint Connection.

Resource for a regional service location.

Parameters for Create or Update request for ServiceResource.

Services response resource. Please note CosmosDBServiceProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DataTransferServiceProperties, GraphApiComputeServiceProperties, MaterializedViewsBuilderServiceProperties and SqlDedicatedGatewayServiceProperties.

Parameters to create and update ClientEncryptionKey.

The CosmosDBSqlClientEncryptionKeyProperties.

Cosmos DB client encryption key resource object.

Parameters to create and update Cosmos DB container.

The CosmosDBSqlContainerPropertiesConfig.

Cosmos DB SQL container resource object.

Parameters to create and update Cosmos DB SQL database.

The CosmosDBSqlDatabasePropertiesConfig.

Cosmos DB SQL database resource object.

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

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

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

Parameters to create and update Cosmos DB storedProcedure.

Cosmos DB SQL storedProcedure resource object.

Parameters to create and update Cosmos DB trigger.

Cosmos DB SQL trigger resource object.

Parameters to create and update Cosmos DB userDefinedFunction.

Cosmos DB SQL userDefinedFunction resource object.

Parameters to create and update Cosmos DB Table.

The CosmosDBTablePropertiesOptions.

The CosmosDBTablePropertiesResource.

Cosmos DB table resource object.

Represents a throughput pool resource for updates.

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

Virtual Network ACL Rule object.

A CosmosDB Mongo API data source/sink.

A CosmosDB Mongo vCore API data source/sink.

A CosmosDB No Sql API data source/sink.

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

Specific Databases to restore.

Base class for all DataTransfer source/sink Please note DataTransferDataSourceSink is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureBlobDataTransferDataSourceSink, BaseCosmosDataTransferDataSourceSink, CosmosCassandraDataTransferDataSourceSink, CosmosMongoDataTransferDataSourceSink, CosmosMongoVCoreDataTransferDataSourceSink and CosmosSqlDataTransferDataSourceSink.

Parameters to create Data Transfer Job.

The properties of a DataTransfer Job.

Resource for a regional service location.

Properties for DataTransferServiceResource.

Properties for Create or Update request for DataTransferServiceResource.

The ExtendedCassandraKeyspaceResourceInfo.

The ExtendedCassandraTableResourceInfo.

The ExtendedCosmosDBSqlContainerResourceInfo.

The ExtendedCosmosDBSqlDatabaseResourceInfo.

The ExtendedCosmosDBSqlStoredProcedureResourceInfo.

The ExtendedCosmosDBSqlTriggerResourceInfo.

The ExtendedCosmosDBSqlUserDefinedFunctionResourceInfo.

The ExtendedGremlinDatabaseResourceInfo.

The ExtendedGremlinGraphResourceInfo.

The ExtendedMongoDBCollectionResourceInfo.

The ExtendedMongoDBDatabaseResourceInfo.

The resource of an Azure Cosmos DB Gremlin database event.

The resource of an Azure Cosmos DB Gremlin graph event.

The resource of an Azure Cosmos DB MongoDB collection event.

The resource of an Azure Cosmos DB MongoDB database event.

The resource of an Azure Cosmos DB SQL container event.

The resource of an Azure Cosmos DB SQL database event.

The resource of an Azure Cosmos DB Table event.

The ExtendedThroughputSettingsResourceInfo.

Resource for a regional service location.

Properties for GraphAPIComputeServiceResource.

Properties for Create or Update request for GraphAPIComputeServiceResource.

The GraphResourceGetPropertiesOptions.

Parameters to create and update Cosmos DB Graph resource.

Parameters to create and update Cosmos DB Gremlin database.

The GremlinDatabasePropertiesConfig.

Cosmos DB Gremlin database resource object.

Specific Gremlin Databases to restore.

Parameters to create and update Cosmos DB Gremlin graph.

The GremlinGraphPropertiesConfig.

Cosmos DB Gremlin graph resource object.

Materialized View definition for the container.

Resource for a regional service location.

Properties for MaterializedViewsBuilderServiceResource.

Properties for Create or Update request for MaterializedViewsBuilderServiceResource.

The properties of an Azure Cosmos DB merge operations.

Parameters to create and update Cosmos DB MongoDB collection.

The MongoDBCollectionPropertiesConfig.

Cosmos DB MongoDB collection resource object.

Parameters to create and update Cosmos DB MongoDB database.

The MongoDBDatabasePropertiesConfig.

Cosmos DB MongoDB database resource object.

Cosmos DB MongoDB collection index key.

Cosmos DB MongoDB collection index options.

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

An Azure Cosmos DB Mongo DB Resource.

The set of roles permitted through this Role Definition.

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

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

Information about a network security perimeter (NSP).

Network security configuration properties.

Network security perimeter configuration profile.

The metric values for a single partition.

The partition level usage data for a usage request.

Represents percentile metrics values.

The object representing periodic mode backup policy.

Configuration values for periodic mode backup.

The storage of a physical partition.

List of physical partitions and their properties returned by a merge operation.

PhysicalPartitionThroughputInfo object.

An Azure Cosmos DB PhysicalPartitionThroughputInfoResult object.

Describes a provisioning issue for a network security perimeter configuration.

Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules.

Cosmos DB redistribute throughput parameters object.

Resource to redistribute throughput for Azure Cosmos DB resource.

Cosmos DB region to online or offline.

Information about resource association.

Parameters to indicate the information about the restore.

An Azure Cosmos DB Gremlin database event.

An Azure Cosmos DB Gremlin graph event.

Specific Databases to restore.

Properties of the regional restorable account.

An Azure Cosmos DB MongoDB collection event.

An Azure Cosmos DB MongoDB database event.

Specific Databases to restore.

An Azure Cosmos DB SQL container event.

Cosmos DB SQL container resource object.

An Azure Cosmos DB SQL database event.

Cosmos DB SQL database resource object.

Specific Databases to restore.

An Azure Cosmos DB Table event.

Specific Databases to restore.

Parameters to indicate the information about the restore.

Cosmos DB retrieve throughput parameters object.

Resource to retrieve throughput information for Cosmos DB resource.

Properties in ServiceResourceCreateUpdateParameters. Please note ServiceResourceCreateUpdateProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DataTransferServiceResourceCreateUpdateProperties, GraphApiComputeServiceResourceCreateUpdateProperties, MaterializedViewsBuilderServiceResourceCreateUpdateProperties and SqlDedicatedGatewayServiceResourceCreateUpdateProperties.

The SpatialSpec.

Resource for a regional service location.

Properties for SqlDedicatedGatewayServiceResource.

Properties for Create or Update request for SqlDedicatedGatewayServiceResource.

Cosmos DB resource throughput policy.

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

Parameters to update Cosmos DB resource throughput.

Direction of Access Rule.

Describes the types of schema for analytical storage.

Describes the status of migration between backup policy types.

Describes the mode of backups.

Indicates the capacity mode of the account.

The transition status of capacity mode.

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

The form of AutoReplicate that is being used by this cluster.

The current state of the backup.

Status of the command.

Type of the cluster. If set to Production, some operations might not be permitted on cluster.

The kind of connection error that occurred.

The state of the node in Cassandra ring.

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

Sort order for composite paths.

Indicates the conflict resolution mode.

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

Enum to indicate type of Continuous backup tier.

Enum to indicate the mode of account creation.

The access key to regenerate.

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

The offer type for the Cosmos DB database account.

Describes the mode of the restore.

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

Enum to indicate type of backup storage redundancy.

The datatype for which the indexing behavior is applied to.

Indicates the indexing mode.

Indicates the type of index.

Kind of the connection string key.

The primary aggregation type of the metric.

The unit of the metric.

Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.

Enum to indicate the operation type of the event.

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

Whether requests from Public Network are allowed.

Describes the ServerVersion of an a MongoDB account.

Instance type for the service.

Describes the status of a service.

ServiceType for the service.

Indicates the spatial type of index.

The operation the trigger is associated with.

Type of the Trigger.

Enum to indicate current buildout status of the region.

Type of the connection string.

Mode of job execution.

DedicatedGatewayType for the service.

Enum to indicate default priorityLevel of requests.

Type of issue.

Provisioning state of a network security perimeter configuration that is being created or updated.

Access mode of the resource association.

How the nodes in the cluster react to scheduled events.

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

Severity of the issue.

ThroughputPolicy to apply for throughput redistribution.

Indicates whether what action to take for the Chaos Fault.

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

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

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

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

Indicates what services are allowed to bypass firewall checks.