Package com.azure.resourcemanager.cosmos.models

Package containing the data models for CosmosDBManagementClient. Azure Cosmos DB Database Service Resource Provider REST API.

Interface Summary

Interface	Description
CosmosDBAccount	An immutable client-side representation of an Azure Cosmos DB.
CosmosDBAccount.Definition	Grouping of cosmos db definition stages.
CosmosDBAccount.DefinitionStages	Grouping of cosmos db definition stages.
CosmosDBAccount.DefinitionStages.Blank	The first stage of a cosmos db definition.
CosmosDBAccount.DefinitionStages.WithConnector	The stage of the cosmos db definition allowing to specify cassandra connector offer.
CosmosDBAccount.DefinitionStages.WithConsistencyPolicy	The stage of the cosmos db definition allowing to set the consistency policy.
CosmosDBAccount.DefinitionStages.WithCreate	The stage of the definition which contains all the minimum required inputs for the resource to be created, but also allows for any other optional settings to be specified.
CosmosDBAccount.DefinitionStages.WithGroup	The stage of the cosmos db definition allowing to specify the resource group.
CosmosDBAccount.DefinitionStages.WithIpRules	The stage of the cosmos db definition allowing to set the IP range filter.
CosmosDBAccount.DefinitionStages.WithKeyBasedMetadataWriteAccess	The stage of the cosmos db definition allowing to specify metadata write access.
CosmosDBAccount.DefinitionStages.WithKind	The stage of the cosmos db definition allowing to set the database account kind.
CosmosDBAccount.DefinitionStages.WithMultipleLocations	The stage of the cosmos db definition allowing to specify whether multiple write locations will be enabled.
CosmosDBAccount.DefinitionStages.WithPrivateEndpointConnection	The stage of the cosmos db definition allowing to specify private endpoint connection.
CosmosDBAccount.DefinitionStages.WithReadReplication	The stage of the cosmos db definition allowing the definition of a write location.
CosmosDBAccount.DefinitionStages.WithVirtualNetworkRule	The stage of the cosmos db definition allowing the definition of a Virtual Network ACL Rule.
CosmosDBAccount.DefinitionStages.WithWriteReplication	The stage of the cosmos db definition allowing the definition of a read location.
CosmosDBAccount.Update	Grouping of cosmos db update stages.
CosmosDBAccount.UpdateStages	Grouping of cosmos db update stages.
CosmosDBAccount.UpdateStages.WithConnector	The stage of the cosmos db update allowing to specify cassandra connector offer.
CosmosDBAccount.UpdateStages.WithConsistencyPolicy	The stage of the cosmos db update allowing to set the consistency policy.
CosmosDBAccount.UpdateStages.WithIpRules	The stage of the cosmos db definition allowing to set the IP range filter.
CosmosDBAccount.UpdateStages.WithKeyBasedMetadataWriteAccess	The stage of the cosmos db update allowing to specify metadata write access.
CosmosDBAccount.UpdateStages.WithMultipleLocations	The stage of the Cosmos DB update definition allowing to specify whether multiple write locations are enabled or not.
CosmosDBAccount.UpdateStages.WithOptionals	Grouping of cosmos db update stages.
CosmosDBAccount.UpdateStages.WithPrivateEndpointConnection	The stage of the cosmos db update allowing to specify private endpoint connection.
CosmosDBAccount.UpdateStages.WithReadLocations	The stage of the cosmos db definition allowing the definition of a write location.
CosmosDBAccount.UpdateStages.WithVirtualNetworkRule	The stage of the Cosmos DB update definition allowing the definition of a Virtual Network ACL Rule.
CosmosDBAccounts	Entry point to Cosmos DB management API.
DatabaseAccountListConnectionStringsResult	An immutable client-side representation of an Azure Cosmos DB DatabaseAccountListConnectionStringsResult.
DatabaseAccountListKeysResult	An immutable client-side representation of an Azure Cosmos DB DatabaseAccountListKeysResult.
DatabaseAccountListReadOnlyKeysResult	An immutable client-side representation of an Azure Cosmos DB DatabaseAccountListReadOnlyKeysResult.
PrivateEndpointConnection	A private endpoint connection.
PrivateEndpointConnection.Definition<ParentT>	The entirety of a private endpoint connection definition as a part of parent definition.
PrivateEndpointConnection.DefinitionStages	Grouping of private endpoint connection definition stages as a port of cosmos db account definition.
PrivateEndpointConnection.DefinitionStages.Blank<ParentT>	The first stage of a private endpoint connection definition.
PrivateEndpointConnection.DefinitionStages.WithAttach<ParentT>	The final stage of the private endpoint connection definition.
PrivateEndpointConnection.DefinitionStages.WithState<ParentT>	The stage of the private endpoint connection definition allowing to set state.
PrivateEndpointConnection.Update	The entirety of private endpoint connection update as a part of parent virtual machine update.
PrivateEndpointConnection.UpdateDefinition<ParentT>	The entirety of a private endpoint connection definition definition as a part of parent update.
PrivateEndpointConnection.UpdateDefinitionStages	Grouping of private endpoint connection definition stages as part of parent cosmos db account update.
PrivateEndpointConnection.UpdateDefinitionStages.Blank<ParentT>	The first stage of a private endpoint connection definition.
PrivateEndpointConnection.UpdateDefinitionStages.WithAttach<ParentT>	The final stage of the private endpoint connection definition.
PrivateEndpointConnection.UpdateDefinitionStages.WithState<ParentT>	The stage of the private endpoint connection definition allowing to set state.
PrivateEndpointConnection.UpdateStages	Grouping of private endpoint connection update stages.
PrivateEndpointConnection.UpdateStages.WithState	The stage of the private endpoint connection update allowing to specify state.
PrivateLinkResource	A private link resource.
SqlDatabase	An Azure Cosmos DB SQL database.

Class Summary

Class	Description
AnalyticalStorageConfiguration	Analytical storage specific properties.
AnalyticalStorageSchemaType	Defines values for AnalyticalStorageSchemaType.
ApiProperties	The ApiProperties model.
ApiType	Defines values for ApiType.
ArmProxyResource	The resource model definition for a ARM proxy resource.
ArmResourceProperties	The core properties of ARM resources.
AuthenticationMethod	Defines values for AuthenticationMethod.
AutoscaleSettings	The AutoscaleSettings model.
AutoscaleSettingsResource	Cosmos DB provisioned throughput settings object.
AutoUpgradePolicyResource	Cosmos DB resource auto-upgrade policy.
BackupPolicy	The object representing the policy for taking backups on an account.
BackupPolicyMigrationState	The object representing the state of the migration between the backup policies.
BackupPolicyMigrationStatus	Defines values for BackupPolicyMigrationStatus.
BackupPolicyType	Defines values for BackupPolicyType.
BackupStorageRedundancy	Defines values for BackupStorageRedundancy.
Capability	Cosmos DB capability object.
Capacity	The object that represents all properties related to capacity enforcement on an account.
CassandraClusterPublicStatusDataCentersItem	The CassandraClusterPublicStatusDataCentersItem model.
CassandraKeyspaceCreateUpdateParameters	Parameters to create and update Cosmos DB Cassandra keyspace.
CassandraKeyspaceGetPropertiesOptions	The CassandraKeyspaceGetPropertiesOptions model.
CassandraKeyspaceGetPropertiesResource	The CassandraKeyspaceGetPropertiesResource model.
CassandraKeyspaceListResult	The List operation response, that contains the Cassandra keyspaces and their properties.
CassandraKeyspaceResource	Cosmos DB Cassandra keyspace resource object.
CassandraPartitionKey	Cosmos DB Cassandra table partition key.
CassandraSchema	Cosmos DB Cassandra table schema.
CassandraTableCreateUpdateParameters	Parameters to create and update Cosmos DB Cassandra table.
CassandraTableGetPropertiesOptions	The CassandraTableGetPropertiesOptions model.
CassandraTableGetPropertiesResource	The CassandraTableGetPropertiesResource model.
CassandraTableListResult	The List operation response, that contains the Cassandra tables and their properties.
CassandraTableResource	Cosmos DB Cassandra table resource object.
Certificate	The Certificate model.
ClusterKey	Cosmos DB Cassandra table cluster key.
ClusterResourceProperties	Properties of a managed Cassandra cluster.
Column	Cosmos DB Cassandra table column.
CommandPostBody	Specification of which command to run where.
ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems	The ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems model.
CompositePath	The CompositePath model.
CompositePathSortOrder	Defines values for CompositePathSortOrder.
ConflictResolutionMode	Defines values for ConflictResolutionMode.
ConflictResolutionPolicy	The conflict resolution policy for the container.
ConnectionError	The ConnectionError model.
ConnectionState	Defines values for ConnectionState.
ConnectorOffer	Defines values for ConnectorOffer.
ConsistencyPolicy	The consistency policy for the Cosmos DB database account.
ContainerPartitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions.
ContinuousBackupInformation	Information about the status of continuous backups.
ContinuousBackupRestoreLocation	Properties of the regional restorable account.
ContinuousModeBackupPolicy	The object representing continuous mode backup policy.
CorsPolicy	The CORS policy for the Cosmos DB database account.
CreateMode	Defines values for CreateMode.
CreateUpdateOptions	CreateUpdateOptions are a list of key-value pairs that describe the resource.
DatabaseAccountConnectionString	Connection string for the Cosmos DB account.
DatabaseAccountCreateUpdateParameters	Parameters to create and update Cosmos DB database accounts.
DatabaseAccountKind	Defines values for DatabaseAccountKind.
DatabaseAccountRegenerateKeyParameters	Parameters to regenerate the keys within the database account.
DatabaseAccountsListResult	The List operation response, that contains the database accounts and their properties.
DatabaseAccountUpdateParameters	Parameters for patching Azure Cosmos DB database account properties.
DataCenterResourceProperties	Properties of a managed Cassandra data center.
DataType	Defines values for DataType.
ExcludedPath	The ExcludedPath model.
ExtendedResourceProperties	The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs.
FailoverPolicies	The list of new failover policies for the failover priority change.
FailoverPolicy	The failover policy for a given region of a database account.
GremlinDatabaseCreateUpdateParameters	Parameters to create and update Cosmos DB Gremlin database.
GremlinDatabaseGetPropertiesOptions	The GremlinDatabaseGetPropertiesOptions model.
GremlinDatabaseGetPropertiesResource	The GremlinDatabaseGetPropertiesResource model.
GremlinDatabaseListResult	The List operation response, that contains the Gremlin databases and their properties.
GremlinDatabaseResource	Cosmos DB Gremlin database resource object.
GremlinGraphCreateUpdateParameters	Parameters to create and update Cosmos DB Gremlin graph.
GremlinGraphGetPropertiesOptions	The GremlinGraphGetPropertiesOptions model.
GremlinGraphGetPropertiesResource	The GremlinGraphGetPropertiesResource model.
GremlinGraphListResult	The List operation response, that contains the graphs and their properties.
GremlinGraphResource	Cosmos DB Gremlin graph resource object.
IncludedPath	The paths that are included in indexing.
Indexes	The indexes for the path.
IndexingMode	Defines values for IndexingMode.
IndexingPolicy	Cosmos DB indexing policy.
IndexKind	Defines values for IndexKind.
IpAddressOrRange	IpAddressOrRange object.
KeyKind	Defines values for KeyKind.
ListClusters	List of managed Cassandra clusters.
ListDataCenters	List of managed Cassandra data centers and their properties.
Location	A region in which the Azure Cosmos DB database account is deployed.
LocationListResult	The List operation response, that contains Cosmos DB locations and their properties.
LocationProperties	Cosmos DB location metadata.
ManagedCassandraArmResourceProperties	The core properties of ARM resources.
ManagedCassandraManagedServiceIdentity	Identity for the resource.
ManagedCassandraProvisioningState	Defines values for ManagedCassandraProvisioningState.
ManagedCassandraReaperStatus	The ManagedCassandraReaperStatus model.
ManagedCassandraResourceIdentityType	Defines values for ManagedCassandraResourceIdentityType.
ManagedServiceIdentity	Identity for the resource.
ManagedServiceIdentityUserAssignedIdentities	The ManagedServiceIdentityUserAssignedIdentities model.
MetricAvailability	The availability of the metric.
MetricDefinitionsListResult	The response to a list metric definitions request.
MetricListResult	The response to a list metrics request.
MetricName	A metric name.
MetricValue	Represents metrics values.
MongoDBCollectionCreateUpdateParameters	Parameters to create and update Cosmos DB MongoDB collection.
MongoDBCollectionGetPropertiesOptions	The MongoDBCollectionGetPropertiesOptions model.
MongoDBCollectionGetPropertiesResource	The MongoDBCollectionGetPropertiesResource model.
MongoDBCollectionListResult	The List operation response, that contains the MongoDB collections and their properties.
MongoDBCollectionResource	Cosmos DB MongoDB collection resource object.
MongoDBDatabaseCreateUpdateParameters	Parameters to create and update Cosmos DB MongoDB database.
MongoDBDatabaseGetPropertiesOptions	The MongoDBDatabaseGetPropertiesOptions model.
MongoDBDatabaseGetPropertiesResource	The MongoDBDatabaseGetPropertiesResource model.
MongoDBDatabaseListResult	The List operation response, that contains the MongoDB databases and their properties.
MongoDBDatabaseResource	Cosmos DB MongoDB database resource object.
MongoIndex	Cosmos DB MongoDB collection index key.
MongoIndexKeys	Cosmos DB MongoDB collection resource object.
MongoIndexOptions	Cosmos DB MongoDB collection index options.
NodeState	Defines values for NodeState.
NotebookWorkspaceCreateUpdateParameters	Parameters to create a notebook workspace resource.
NotebookWorkspaceListResult	A list of notebook workspace resources.
NotebookWorkspaceName	Defines values for NotebookWorkspaceName.
OperationDisplay	The object that represents the operation.
OperationListResult	Result of the request to list Resource Provider operations.
OperationType	Defines values for OperationType.
OptionsResource	Cosmos DB options resource object.
PartitionKind	Defines values for PartitionKind.
PartitionMetricListResult	The response to a list partition metrics request.
PartitionUsagesResult	The response to a list partition level usage request.
PercentileMetricListResult	The response to a list percentile metrics request.
PercentileMetricValue	Represents percentile metrics values.
PeriodicModeBackupPolicy	The object representing periodic mode backup policy.
PeriodicModeProperties	Configuration values for periodic mode backup.
Permission	The set of data plane operations permitted through this Role Definition.
PrimaryAggregationType	Defines values for PrimaryAggregationType.
PrivateEndpointConnectionListResult	A list of private endpoint connections.
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkResourceListResult	A list of private link resources.
PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
PublicNetworkAccess	Defines values for PublicNetworkAccess.
RegionForOnlineOffline	Cosmos DB region to online or offline.
RestorableDatabaseAccountsListResult	The List operation response, that contains the restorable database accounts and their properties.
RestorableLocationResource	Properties of the regional restorable account.
RestorableMongodbCollectionPropertiesResource	The resource of an Azure Cosmos DB MongoDB collection event.
RestorableMongodbCollectionsListResult	The List operation response, that contains the MongoDB collection events and their properties.
RestorableMongodbDatabasePropertiesResource	The resource of an Azure Cosmos DB MongoDB database event.
RestorableMongodbDatabasesListResult	The List operation response, that contains the MongoDB database events and their properties.
RestorableMongodbResourcesListResult	The List operation response, that contains the restorable MongoDB resources.
RestorableSqlContainerPropertiesResource	The resource of an Azure Cosmos DB SQL container event.
RestorableSqlContainerPropertiesResourceContainer	Cosmos DB SQL container resource object.
RestorableSqlContainersListResult	The List operation response, that contains the SQL container events and their properties.
RestorableSqlDatabasePropertiesResource	The resource of an Azure Cosmos DB SQL database event.
RestorableSqlDatabasePropertiesResourceDatabase	Cosmos DB SQL database resource object.
RestorableSqlDatabasesListResult	The List operation response, that contains the SQL database events and their properties.
RestorableSqlResourcesListResult	The List operation response, that contains the restorable SQL resources.
RestoreMode	Defines values for RestoreMode.
RestoreParameters	Parameters to indicate the information about the restore.
SeedNode	The SeedNode model.
ServerVersion	Defines values for ServerVersion.
SpatialSpec	The SpatialSpec model.
SpatialType	Defines values for SpatialType.
SqlContainerCreateUpdateParameters	Parameters to create and update Cosmos DB container.
SqlContainerGetPropertiesOptions	The SqlContainerGetPropertiesOptions model.
SqlContainerGetPropertiesResource	The SqlContainerGetPropertiesResource model.
SqlContainerListResult	The List operation response, that contains the containers and their properties.
SqlContainerResource	Cosmos DB SQL container resource object.
SqlDatabaseCreateUpdateParameters	Parameters to create and update Cosmos DB SQL database.
SqlDatabaseGetPropertiesOptions	The SqlDatabaseGetPropertiesOptions model.
SqlDatabaseGetPropertiesResource	The SqlDatabaseGetPropertiesResource model.
SqlDatabaseListResult	The List operation response, that contains the SQL databases and their properties.
SqlDatabaseResource	Cosmos DB SQL database resource object.
SqlRoleAssignmentCreateUpdateParameters	Parameters to create and update an Azure Cosmos DB SQL Role Assignment.
SqlRoleAssignmentListResult	The relevant Role Assignments.
SqlRoleDefinitionCreateUpdateParameters	Parameters to create and update an Azure Cosmos DB SQL Role Definition.
SqlRoleDefinitionListResult	The relevant Role Definitions.
SqlStoredProcedureCreateUpdateParameters	Parameters to create and update Cosmos DB storedProcedure.
SqlStoredProcedureGetPropertiesResource	The SqlStoredProcedureGetPropertiesResource model.
SqlStoredProcedureListResult	The List operation response, that contains the storedProcedures and their properties.
SqlStoredProcedureResource	Cosmos DB SQL storedProcedure resource object.
SqlTriggerCreateUpdateParameters	Parameters to create and update Cosmos DB trigger.
SqlTriggerGetPropertiesResource	The SqlTriggerGetPropertiesResource model.
SqlTriggerListResult	The List operation response, that contains the triggers and their properties.
SqlTriggerResource	Cosmos DB SQL trigger resource object.
SqlUserDefinedFunctionCreateUpdateParameters	Parameters to create and update Cosmos DB userDefinedFunction.
SqlUserDefinedFunctionGetPropertiesResource	The SqlUserDefinedFunctionGetPropertiesResource model.
SqlUserDefinedFunctionListResult	The List operation response, that contains the userDefinedFunctions and their properties.
SqlUserDefinedFunctionResource	Cosmos DB SQL userDefinedFunction resource object.
TableCreateUpdateParameters	Parameters to create and update Cosmos DB Table.
TableGetPropertiesOptions	The TableGetPropertiesOptions model.
TableGetPropertiesResource	The TableGetPropertiesResource model.
TableListResult	The List operation response, that contains the Table and their properties.
TableResource	Cosmos DB table resource object.
ThroughputPolicyResource	Cosmos DB resource throughput policy.
ThroughputSettingsGetPropertiesResource	The ThroughputSettingsGetPropertiesResource model.
ThroughputSettingsResource	Cosmos DB resource throughput object.
ThroughputSettingsUpdateParameters	Parameters to update Cosmos DB resource throughput.
TriggerOperation	Defines values for TriggerOperation.
TriggerType	Defines values for TriggerType.
UniqueKey	The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
UniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
UnitType	Defines values for UnitType.
UsagesResult	The response to a list usage request.
VirtualNetworkRule	Virtual Network ACL Rule object.

Enum Summary

Enum	Description
DatabaseAccountOfferType	Defines values for DatabaseAccountOfferType.
DefaultConsistencyLevel	Defines values for DefaultConsistencyLevel.
NetworkAclBypass	Defines values for NetworkAclBypass.
ResourceIdentityType	Defines values for ResourceIdentityType.
RoleDefinitionType	Defines values for RoleDefinitionType.