Azure.Provisioning.CosmosDB Namespace

Classes

AuthenticationMethodLdapProperties	Ldap authentication method properties. This feature is in preview.
AutoscaleSettingsResourceInfo	Cosmos DB provisioned throughput settings object.
AzureBlobDataTransferDataSourceSink	An Azure Blob Storage data source/sink.
BackupPolicyMigrationState	The object representing the state of the migration between the backup policies.
BaseCosmosDataTransferDataSourceSink	A base CosmosDB data source/sink Please note Azure.ResourceManager.CosmosDB.Models.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 Azure.ResourceManager.CosmosDB.Models.CosmosCassandraDataTransferDataSourceSink, Azure.ResourceManager.CosmosDB.Models.CosmosMongoDataTransferDataSourceSink and Azure.ResourceManager.CosmosDB.Models.CosmosSqlDataTransferDataSourceSink.
CassandraCertificate	The CassandraCertificate.
CassandraCluster	CassandraCluster.
CassandraCluster.ResourceVersions	Supported CassandraCluster resource versions.
CassandraClusterBackupSchedule	The CassandraClusterBackupSchedule.
CassandraClusterKey	Cosmos DB Cassandra table cluster key.
CassandraClusterProperties	Properties of a managed Cassandra cluster.
CassandraColumn	Cosmos DB Cassandra table column.
CassandraDataCenter	CassandraDataCenter.
CassandraDataCenter.ResourceVersions	Supported CassandraDataCenter resource versions.
CassandraDataCenterProperties	Properties of a managed Cassandra data center.
CassandraDataCenterSeedNode	The CassandraDataCenterSeedNode.
CassandraError	The CassandraError.
CassandraKeyspace	CassandraKeyspace.
CassandraKeyspace.ResourceVersions	Supported CassandraKeyspace resource versions.
CassandraKeyspacePropertiesConfig	The CassandraKeyspacePropertiesConfig.
CassandraKeyspaceThroughputSetting	CassandraKeyspaceThroughputSetting.
CassandraKeyspaceThroughputSetting.ResourceVersions	Supported CassandraKeyspaceThroughputSetting resource versions.
CassandraPartitionKey	Cosmos DB Cassandra table partition key.
CassandraSchema	Cosmos DB Cassandra table schema.
CassandraTable	CassandraTable.
CassandraTable.ResourceVersions	Supported CassandraTable resource versions.
CassandraTablePropertiesConfig	The CassandraTablePropertiesConfig.
CassandraTableResourceInfo	Cosmos DB Cassandra table resource object.
CassandraTableThroughputSetting	CassandraTableThroughputSetting.
CassandraTableThroughputSetting.ResourceVersions	Supported CassandraTableThroughputSetting resource versions.
CassandraViewGetPropertiesOptions	The CassandraViewGetPropertiesOptions.
CassandraViewGetPropertiesResource	The CassandraViewGetPropertiesResource.
CassandraViewGetResult	CassandraViewGetResult.
CassandraViewGetResult.ResourceVersions	Supported CassandraViewGetResult resource versions.
CassandraViewResource	Cosmos DB Cassandra view resource object.
CassandraViewThroughputSetting	CassandraViewThroughputSetting.
CassandraViewThroughputSetting.ResourceVersions	Supported CassandraViewThroughputSetting resource versions.
ComputedProperty	The definition of a computed property.
ConflictResolutionPolicy	The conflict resolution policy for the container.
ConsistencyPolicy	The consistency policy for the Cosmos DB database account.
ContinuousModeBackupPolicy	The object representing continuous mode backup policy.
CosmosCassandraDataTransferDataSourceSink	A CosmosDB Cassandra API data source/sink.
CosmosDBAccount	CosmosDBAccount.
CosmosDBAccount.ResourceVersions	Supported CosmosDBAccount resource versions.
CosmosDBAccountBackupPolicy	The object representing the policy for taking backups on an account. Please note Azure.ResourceManager.CosmosDB.Models.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 Azure.ResourceManager.CosmosDB.Models.ContinuousModeBackupPolicy and Azure.ResourceManager.CosmosDB.Models.PeriodicModeBackupPolicy.
CosmosDBAccountCapability	Cosmos DB capability object.
CosmosDBAccountCorsPolicy	The CORS policy for the Cosmos DB database account.
CosmosDBAccountKeyList	The access keys for the given database account.
CosmosDBAccountLocation	A region in which the Azure Cosmos DB database account is deployed.
CosmosDBAccountRestoreParameters	Parameters to indicate the information about the restore.
CosmosDBClientEncryptionIncludedPath	.
CosmosDBClientEncryptionPolicy	Cosmos DB client encryption policy.
CosmosDBCompositePath	The CosmosDBCompositePath.
CosmosDBContainerPartitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions.
CosmosDBCreateUpdateConfig	CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput".
CosmosDBExcludedPath	The CosmosDBExcludedPath.
CosmosDBFailoverPolicy	The failover policy for a given region of a database account.
CosmosDBFirewallRule	CosmosDBFirewallRule.
CosmosDBFirewallRule.ResourceVersions	Supported CosmosDBFirewallRule resource versions.
CosmosDBIncludedPath	The paths that are included in indexing.
CosmosDBIndexingPolicy	Cosmos DB indexing policy.
CosmosDBIPAddressOrRange	IpAddressOrRange object.
CosmosDBKeyWrapMetadata	Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key.
CosmosDBPathIndexes	The indexes for the path.
CosmosDBPrivateEndpointConnection	CosmosDBPrivateEndpointConnection.
CosmosDBPrivateEndpointConnection.ResourceVersions	Supported CosmosDBPrivateEndpointConnection resource versions.
CosmosDBPrivateEndpointConnectionData	A class representing the CosmosDBPrivateEndpointConnection data model. A private endpoint connection
CosmosDBPrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
CosmosDBService	CosmosDBService.
CosmosDBService.ResourceVersions	Supported CosmosDBService resource versions.
CosmosDBServiceProperties	Services response resource. Please note Azure.ResourceManager.CosmosDB.Models.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 Azure.ResourceManager.CosmosDB.Models.DataTransferServiceProperties, Azure.ResourceManager.CosmosDB.Models.GraphApiComputeServiceProperties, Azure.ResourceManager.CosmosDB.Models.MaterializedViewsBuilderServiceProperties and Azure.ResourceManager.CosmosDB.Models.SqlDedicatedGatewayServiceProperties.
CosmosDBSqlClientEncryptionKey	CosmosDBSqlClientEncryptionKey.
CosmosDBSqlClientEncryptionKey.ResourceVersions	Supported CosmosDBSqlClientEncryptionKey resource versions.
CosmosDBSqlClientEncryptionKeyProperties	The CosmosDBSqlClientEncryptionKeyProperties.
CosmosDBSqlClientEncryptionKeyResourceInfo	Cosmos DB client encryption key resource object.
CosmosDBSqlContainer	CosmosDBSqlContainer.
CosmosDBSqlContainer.ResourceVersions	Supported CosmosDBSqlContainer resource versions.
CosmosDBSqlContainerPropertiesConfig	The CosmosDBSqlContainerPropertiesConfig.
CosmosDBSqlContainerResourceInfo	Cosmos DB SQL container resource object.
CosmosDBSqlContainerThroughputSetting	CosmosDBSqlContainerThroughputSetting.
CosmosDBSqlContainerThroughputSetting.ResourceVersions	Supported CosmosDBSqlContainerThroughputSetting resource versions.
CosmosDBSqlDatabase	CosmosDBSqlDatabase.
CosmosDBSqlDatabase.ResourceVersions	Supported CosmosDBSqlDatabase resource versions.
CosmosDBSqlDatabasePropertiesConfig	The CosmosDBSqlDatabasePropertiesConfig.
CosmosDBSqlDatabaseResourceInfo	Cosmos DB SQL database resource object.
CosmosDBSqlDatabaseThroughputSetting	CosmosDBSqlDatabaseThroughputSetting.
CosmosDBSqlDatabaseThroughputSetting.ResourceVersions	Supported CosmosDBSqlDatabaseThroughputSetting resource versions.
CosmosDBSqlRoleAssignment	CosmosDBSqlRoleAssignment.
CosmosDBSqlRoleAssignment.ResourceVersions	Supported CosmosDBSqlRoleAssignment resource versions.
CosmosDBSqlRoleDefinition	CosmosDBSqlRoleDefinition.
CosmosDBSqlRoleDefinition.ResourceVersions	Supported CosmosDBSqlRoleDefinition resource versions.
CosmosDBSqlRolePermission	The set of data plane operations permitted through this Role Definition.
CosmosDBSqlStoredProcedure	CosmosDBSqlStoredProcedure.
CosmosDBSqlStoredProcedure.ResourceVersions	Supported CosmosDBSqlStoredProcedure resource versions.
CosmosDBSqlStoredProcedureResourceInfo	Cosmos DB SQL storedProcedure resource object.
CosmosDBSqlTrigger	CosmosDBSqlTrigger.
CosmosDBSqlTrigger.ResourceVersions	Supported CosmosDBSqlTrigger resource versions.
CosmosDBSqlTriggerResourceInfo	Cosmos DB SQL trigger resource object.
CosmosDBSqlUserDefinedFunction	CosmosDBSqlUserDefinedFunction.
CosmosDBSqlUserDefinedFunction.ResourceVersions	Supported CosmosDBSqlUserDefinedFunction resource versions.
CosmosDBSqlUserDefinedFunctionResourceInfo	Cosmos DB SQL userDefinedFunction resource object.
CosmosDBTable	CosmosDBTable.
CosmosDBTable.ResourceVersions	Supported CosmosDBTable resource versions.
CosmosDBTablePropertiesOptions	The CosmosDBTablePropertiesOptions.
CosmosDBTablePropertiesResource	The CosmosDBTablePropertiesResource.
CosmosDBTableResourceInfo	Cosmos DB table resource object.
CosmosDBThroughputPool	CosmosDBThroughputPool.
CosmosDBThroughputPool.ResourceVersions	Supported CosmosDBThroughputPool resource versions.
CosmosDBThroughputPoolAccount	CosmosDBThroughputPoolAccount.
CosmosDBThroughputPoolAccount.ResourceVersions	Supported CosmosDBThroughputPoolAccount resource versions.
CosmosDBUniqueKey	The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
CosmosDBVirtualNetworkRule	Virtual Network ACL Rule object.
CosmosMongoDataTransferDataSourceSink	A CosmosDB Mongo API data source/sink.
CosmosSqlDataTransferDataSourceSink	A CosmosDB No Sql API data source/sink.
CosmosTableThroughputSetting	CosmosTableThroughputSetting.
CosmosTableThroughputSetting.ResourceVersions	Supported CosmosTableThroughputSetting resource versions.
DatabaseAccountKeysMetadata	The metadata related to each access key for the given Cosmos DB database account.
DatabaseRestoreResourceInfo	Specific Databases to restore.
DataTransferDataSourceSink	Base class for all DataTransfer source/sink Please note Azure.ResourceManager.CosmosDB.Models.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 Azure.ResourceManager.CosmosDB.Models.AzureBlobDataTransferDataSourceSink, Azure.ResourceManager.CosmosDB.Models.BaseCosmosDataTransferDataSourceSink, Azure.ResourceManager.CosmosDB.Models.CosmosCassandraDataTransferDataSourceSink, Azure.ResourceManager.CosmosDB.Models.CosmosMongoDataTransferDataSourceSink and Azure.ResourceManager.CosmosDB.Models.CosmosSqlDataTransferDataSourceSink.
DataTransferJobGetResult	DataTransferJobGetResult.
DataTransferJobGetResult.ResourceVersions	Supported DataTransferJobGetResult resource versions.
DataTransferJobProperties	The properties of a DataTransfer Job.
DataTransferRegionalService	Resource for a regional service location.
DataTransferServiceProperties	Properties for DataTransferServiceResource.
ErrorResponse	Error Response.
ExtendedCassandraKeyspaceResourceInfo	The ExtendedCassandraKeyspaceResourceInfo.
ExtendedCassandraTableResourceInfo	The ExtendedCassandraTableResourceInfo.
ExtendedCosmosDBSqlContainerResourceInfo	The ExtendedCosmosDBSqlContainerResourceInfo.
ExtendedCosmosDBSqlDatabaseResourceInfo	The ExtendedCosmosDBSqlDatabaseResourceInfo.
ExtendedCosmosDBSqlStoredProcedureResourceInfo	The ExtendedCosmosDBSqlStoredProcedureResourceInfo.
ExtendedCosmosDBSqlTriggerResourceInfo	The ExtendedCosmosDBSqlTriggerResourceInfo.
ExtendedCosmosDBSqlUserDefinedFunctionResourceInfo	The ExtendedCosmosDBSqlUserDefinedFunctionResourceInfo.
ExtendedGremlinDatabaseResourceInfo	The ExtendedGremlinDatabaseResourceInfo.
ExtendedGremlinGraphResourceInfo	The ExtendedGremlinGraphResourceInfo.
ExtendedMongoDBCollectionResourceInfo	The ExtendedMongoDBCollectionResourceInfo.
ExtendedMongoDBDatabaseResourceInfo	The ExtendedMongoDBDatabaseResourceInfo.
ExtendedThroughputSettingsResourceInfo	The ExtendedThroughputSettingsResourceInfo.
GraphApiComputeRegionalService	Resource for a regional service location.
GraphApiComputeServiceProperties	Properties for GraphAPIComputeServiceResource.
GraphResourceGetPropertiesOptions	The GraphResourceGetPropertiesOptions.
GraphResourceGetResult	GraphResourceGetResult.
GraphResourceGetResult.ResourceVersions	Supported GraphResourceGetResult resource versions.
GremlinDatabase	GremlinDatabase.
GremlinDatabase.ResourceVersions	Supported GremlinDatabase resource versions.
GremlinDatabasePropertiesConfig	The GremlinDatabasePropertiesConfig.
GremlinDatabaseResourceInfo	Cosmos DB Gremlin database resource object.
GremlinDatabaseRestoreResourceInfo	Specific Gremlin Databases to restore.
GremlinDatabaseThroughputSetting	GremlinDatabaseThroughputSetting.
GremlinDatabaseThroughputSetting.ResourceVersions	Supported GremlinDatabaseThroughputSetting resource versions.
GremlinGraph	GremlinGraph.
GremlinGraph.ResourceVersions	Supported GremlinGraph resource versions.
GremlinGraphPropertiesConfig	The GremlinGraphPropertiesConfig.
GremlinGraphResourceInfo	Cosmos DB Gremlin graph resource object.
GremlinGraphThroughputSetting	GremlinGraphThroughputSetting.
GremlinGraphThroughputSetting.ResourceVersions	Supported GremlinGraphThroughputSetting resource versions.
MaterializedViewDefinition	Materialized View definition for the container.
MaterializedViewsBuilderRegionalService	Resource for a regional service location.
MaterializedViewsBuilderServiceProperties	Properties for MaterializedViewsBuilderServiceResource.
MongoCluster	MongoCluster.
MongoCluster.ResourceVersions	Supported MongoCluster resource versions.
MongoClusterRestoreParameters	Parameters used for restore operations.
MongoDBCollection	MongoDBCollection.
MongoDBCollection.ResourceVersions	Supported MongoDBCollection resource versions.
MongoDBCollectionPropertiesConfig	The MongoDBCollectionPropertiesConfig.
MongoDBCollectionResourceInfo	Cosmos DB MongoDB collection resource object.
MongoDBCollectionThroughputSetting	MongoDBCollectionThroughputSetting.
MongoDBCollectionThroughputSetting.ResourceVersions	Supported MongoDBCollectionThroughputSetting resource versions.
MongoDBDatabase	MongoDBDatabase.
MongoDBDatabase.ResourceVersions	Supported MongoDBDatabase resource versions.
MongoDBDatabasePropertiesConfig	The MongoDBDatabasePropertiesConfig.
MongoDBDatabaseResourceInfo	Cosmos DB MongoDB database resource object.
MongoDBDatabaseThroughputSetting	MongoDBDatabaseThroughputSetting.
MongoDBDatabaseThroughputSetting.ResourceVersions	Supported MongoDBDatabaseThroughputSetting resource versions.
MongoDBIndex	Cosmos DB MongoDB collection index key.
MongoDBIndexConfig	Cosmos DB MongoDB collection index options.
MongoDBPrivilege	The set of data plane operations permitted through this Role Definition.
MongoDBPrivilegeResourceInfo	An Azure Cosmos DB Mongo DB Resource.
MongoDBRole	The set of roles permitted through this Role Definition.
MongoDBRoleDefinition	MongoDBRoleDefinition.
MongoDBRoleDefinition.ResourceVersions	Supported MongoDBRoleDefinition resource versions.
MongoDBUserDefinition	MongoDBUserDefinition.
MongoDBUserDefinition.ResourceVersions	Supported MongoDBUserDefinition resource versions.
NodeGroupSpec	Specification for a node group.
PeriodicModeBackupPolicy	The object representing periodic mode backup policy.
PeriodicModeProperties	Configuration values for periodic mode backup.
ResourceRestoreParameters	Parameters to indicate the information about the restore.
RestorableSqlContainerPropertiesResourceContainer	Cosmos DB SQL container resource object.
RestorableSqlDatabasePropertiesResourceDatabase	Cosmos DB SQL database resource object.
SpatialSpec	The SpatialSpec.
SqlDedicatedGatewayRegionalService	Resource for a regional service location.
SqlDedicatedGatewayServiceProperties	Properties for SqlDedicatedGatewayServiceResource.
ThroughputPolicyResourceInfo	Cosmos DB resource throughput policy.
ThroughputSettingsResourceInfo	Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Structs

CosmosDBBuiltInRole

Built-in CosmosDB roles that you can assign to users, groups, service principals, and managed identities.

Enums

AnalyticalStorageSchemaType	Describes the types of schema for analytical storage.
BackupPolicyMigrationStatus	Describes the status of migration between backup policy types.
BackupPolicyType	Describes the mode of backups.
CassandraAuthenticationMethod	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'.
CassandraAutoReplicateForm	The form of AutoReplicate that is being used by this cluster.
CassandraClusterType	Type of the cluster. If set to Production, some operations might not be permitted on cluster.
CassandraProvisioningState	The status of the resource at the time the operation was called.
CompositePathSortOrder	Sort order for composite paths.
ConflictResolutionMode	Indicates the conflict resolution mode.
ConnectorOffer	The cassandra connector offer type for the Cosmos DB C* database account.
ContinuousTier	Enum to indicate type of Continuous backup tier.
CosmosDBAccountCreateMode	Enum to indicate the mode of account creation.
CosmosDBAccountKind	Indicates the type of database account. This can only be set at database account creation.
CosmosDBAccountOfferType	The offer type for the Cosmos DB database account.
CosmosDBAccountRestoreMode	Describes the mode of the restore.
CosmosDBBackupStorageRedundancy	Enum to indicate type of backup storage redundancy.
CosmosDBDataType	The datatype for which the indexing behavior is applied to.
CosmosDBIndexingMode	Indicates the indexing mode.
CosmosDBIndexKind	Indicates the type of index.
CosmosDBMinimalTlsVersion	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.
CosmosDBPartitionKind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.
CosmosDBProvisioningState	The provisioning state of the resource.
CosmosDBPublicNetworkAccess	Whether requests from Public Network are allowed.
CosmosDBServerVersion	Describes the ServerVersion of an a MongoDB account.
CosmosDBServiceSize	Instance type for the service.
CosmosDBServiceStatus	Describes the status of a service.
CosmosDBServiceType	ServiceType for the service.
CosmosDBSpatialType	Indicates the spatial type of index.
CosmosDBSqlRoleDefinitionType	Indicates whether the Role Definition was built-in or user created.
CosmosDBSqlTriggerOperation	The operation the trigger is associated with.
CosmosDBSqlTriggerType	Type of the Trigger.
CosmosDBStatus	Enum to indicate current buildout status of the region.
DataTransferJobMode	Mode of job execution.
DefaultConsistencyLevel	The default consistency level and configuration settings of the Cosmos DB account.
DefaultPriorityLevel	Enum to indicate default priorityLevel of requests.
EnableFullTextQuery	Describe the level of detail with which queries are to be logged.
MongoClusterStatus	The status of the resource at the time the operation was called.
MongoDBRoleDefinitionType	Indicates whether the Role Definition was built-in or user created.
NetworkAclBypass	Indicates what services are allowed to bypass firewall checks.
NodeKind	The kind of a node in the mongo cluster.
ScheduledEventStrategy	How the nodes in the cluster react to scheduled events.
ServiceConnectionType	How to connect to the azure services needed for running the cluster.