Microsoft.Azure.Management.CosmosDB.Models Namespace

Classes

AnalyticalStorageConfiguration

Analytical storage specific properties.

AnalyticalStorageSchemaType

Defines values for AnalyticalStorageSchemaType.

ApiProperties
ApiType

Defines values for ApiType.

ARMProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

ARMResourceProperties

The core properties of ARM resources.

AuthenticationMethod

Defines values for AuthenticationMethod.

AutoscaleSettings
AutoscaleSettingsResource

Cosmos DB provisioned throughput settings object

AutoUpgradePolicyResource

Cosmos DB resource auto-upgrade policy

AzureEntityResource

Entity Resource

BackupInformation

Backup information of a resource.

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.

CassandraClusterPublicStatus

Properties of a managed Cassandra cluster public status.

CassandraClusterPublicStatusDataCentersItem
CassandraClusterPublicStatusDataCentersItemNodesItem
CassandraKeyspaceCreateUpdateParameters

Parameters to create and update Cosmos DB Cassandra keyspace.

CassandraKeyspaceGetPropertiesOptions
CassandraKeyspaceGetPropertiesResource
CassandraKeyspaceGetResults

An Azure Cosmos DB Cassandra keyspace.

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
CassandraTableGetPropertiesResource
CassandraTableGetResults

An Azure Cosmos DB Cassandra table.

CassandraTableResource

Cosmos DB Cassandra table resource object

Certificate
ClusterKey

Cosmos DB Cassandra table cluster key

ClusterResource

Representation of a managed Cassandra cluster.

ClusterResourceProperties

Properties of a managed Cassandra cluster.

Column

Cosmos DB Cassandra table column

CommandOutput

Response of /command api

CommandPostBody

Specification of which command to run where

CompositePath
CompositePathSortOrder

Defines values for CompositePathSortOrder.

ConflictResolutionMode

Defines values for ConflictResolutionMode.

ConflictResolutionPolicy

The conflict resolution policy for the container.

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

CreatedByType

Defines values for CreatedByType.

CreateMode

Defines values for CreateMode.

CreateUpdateOptions

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

DatabaseAccountConnectionString

Connection string for the Cosmos DB account

DatabaseAccountCreateUpdateParameters

Parameters to create and update Cosmos DB database accounts.

DatabaseAccountGetResults

An Azure Cosmos DB database account.

DatabaseAccountKind

Defines values for DatabaseAccountKind.

DatabaseAccountListConnectionStringsResult

The connection strings for the given database account.

DatabaseAccountListKeysResult

The access keys for the given database account.

DatabaseAccountListReadOnlyKeysResult

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

DatabaseAccountRegenerateKeyParameters

Parameters to regenerate the keys within the database account.

DatabaseAccountUpdateParameters

Parameters for patching Azure Cosmos DB database account properties.

DatabaseRestoreResource

Specific Databases to restore.

DataCenterResource

A managed Cassandra data center.

DataCenterResourceProperties

Properties of a managed Cassandra data center.

DataType

Defines values for DataType.

ErrorResponse

Error Response.

ErrorResponseException

Exception thrown for an invalid response with ErrorResponse information.

ExcludedPath
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
GremlinDatabaseGetPropertiesResource
GremlinDatabaseGetResults

An Azure Cosmos DB Gremlin database.

GremlinDatabaseResource

Cosmos DB Gremlin database resource object

GremlinGraphCreateUpdateParameters

Parameters to create and update Cosmos DB Gremlin graph.

GremlinGraphGetPropertiesOptions
GremlinGraphGetPropertiesResource
GremlinGraphGetResults

An Azure Cosmos DB Gremlin graph.

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.

Location

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

LocationGetResult

Cosmos DB location get result

LocationProperties

Cosmos DB location metadata

ManagedCassandraARMResourceProperties

The core properties of ARM resources.

ManagedCassandraManagedServiceIdentity

Identity for the resource.

ManagedCassandraProvisioningState

Defines values for ManagedCassandraProvisioningState.

ManagedCassandraReaperStatus
ManagedCassandraResourceIdentityType

Defines values for ManagedCassandraResourceIdentityType.

ManagedServiceIdentity

Identity for the resource.

ManagedServiceIdentityUserAssignedIdentitiesValue
Metric

Metric data

MetricAvailability

The availability of the metric.

MetricDefinition

The definition of a metric.

MetricName

A metric name.

MetricValue

Represents metrics values.

MongoDBCollectionCreateUpdateParameters

Parameters to create and update Cosmos DB MongoDB collection.

MongoDBCollectionGetPropertiesOptions
MongoDBCollectionGetPropertiesResource
MongoDBCollectionGetResults

An Azure Cosmos DB MongoDB collection.

MongoDBCollectionResource

Cosmos DB MongoDB collection resource object

MongoDBDatabaseCreateUpdateParameters

Parameters to create and update Cosmos DB MongoDB database.

MongoDBDatabaseGetPropertiesOptions
MongoDBDatabaseGetPropertiesResource
MongoDBDatabaseGetResults

An Azure Cosmos DB MongoDB database.

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.

NodeStatus

Defines values for NodeStatus.

NotebookWorkspace

A notebook workspace resource

NotebookWorkspaceConnectionInfoResult

The connection info for the given notebook workspace

NotebookWorkspaceCreateUpdateParameters

Parameters to create a notebook workspace resource

Operation

REST API operation

OperationDisplay

The object that represents the operation.

OperationType

Defines values for OperationType.

OptionsResource

Cosmos DB options resource object

Page<T>

Defines a page in Azure responses.

Page1<T>

Defines a page in Azure responses.

PartitionKind

Defines values for PartitionKind.

PartitionMetric

The metric values for a single partition.

PartitionUsage

The partition level usage data for a usage request.

PercentileMetric

Percentile Metric data

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.

PrivateEndpointConnection

A private endpoint connection

PrivateEndpointProperty

Private endpoint which the connection belongs to.

PrivateLinkResource

A private link resource

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

ProxyResource

Proxy Resource

PublicNetworkAccess

Defines values for PublicNetworkAccess.

RegionForOnlineOffline

Cosmos DB region to online or offline.

Resource

Resource

RestorableDatabaseAccountGetResult

A Azure Cosmos DB restorable database account.

RestorableLocationResource

Properties of the regional restorable account.

RestorableMongodbCollectionGetResult

An Azure Cosmos DB MongoDB collection event

RestorableMongodbCollectionPropertiesResource

The resource of an Azure Cosmos DB MongoDB collection event

RestorableMongodbDatabaseGetResult

An Azure Cosmos DB MongoDB database event

RestorableMongodbDatabasePropertiesResource

The resource of an Azure Cosmos DB MongoDB database event

RestorableSqlContainerGetResult

An Azure Cosmos DB SQL container event

RestorableSqlContainerPropertiesResource

The resource of an Azure Cosmos DB SQL container event

RestorableSqlContainerPropertiesResourceContainer

Cosmos DB SQL container resource object

RestorableSqlDatabaseGetResult

An Azure Cosmos DB SQL database event

RestorableSqlDatabasePropertiesResource

The resource of an Azure Cosmos DB SQL database event

RestorableSqlDatabasePropertiesResourceDatabase

Cosmos DB SQL database resource object

RestoreMode

Defines values for RestoreMode.

RestoreParameters

Parameters to indicate the information about the restore.

SeedNode
ServerVersion

Defines values for ServerVersion.

SpatialSpec
SpatialType

Defines values for SpatialType.

SqlContainerCreateUpdateParameters

Parameters to create and update Cosmos DB container.

SqlContainerGetPropertiesOptions
SqlContainerGetPropertiesResource
SqlContainerGetResults

An Azure Cosmos DB container.

SqlContainerResource

Cosmos DB SQL container resource object

SqlDatabaseCreateUpdateParameters

Parameters to create and update Cosmos DB SQL database.

SqlDatabaseGetPropertiesOptions
SqlDatabaseGetPropertiesResource
SqlDatabaseGetResults

An Azure Cosmos DB SQL database.

SqlDatabaseResource

Cosmos DB SQL database resource object

SqlRoleAssignmentCreateUpdateParameters

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

SqlRoleAssignmentGetResults

An Azure Cosmos DB Role Assignment

SqlRoleDefinitionCreateUpdateParameters

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

SqlRoleDefinitionGetResults

An Azure Cosmos DB SQL Role Definition.

SqlStoredProcedureCreateUpdateParameters

Parameters to create and update Cosmos DB storedProcedure.

SqlStoredProcedureGetPropertiesResource
SqlStoredProcedureGetResults

An Azure Cosmos DB storedProcedure.

SqlStoredProcedureResource

Cosmos DB SQL storedProcedure resource object

SqlTriggerCreateUpdateParameters

Parameters to create and update Cosmos DB trigger.

SqlTriggerGetPropertiesResource
SqlTriggerGetResults

An Azure Cosmos DB trigger.

SqlTriggerResource

Cosmos DB SQL trigger resource object

SqlUserDefinedFunctionCreateUpdateParameters

Parameters to create and update Cosmos DB userDefinedFunction.

SqlUserDefinedFunctionGetPropertiesResource
SqlUserDefinedFunctionGetResults

An Azure Cosmos DB userDefinedFunction.

SqlUserDefinedFunctionResource

Cosmos DB SQL userDefinedFunction resource object

SystemData

Metadata pertaining to creation and last modification of the resource.

TableCreateUpdateParameters

Parameters to create and update Cosmos DB Table.

TableGetPropertiesOptions
TableGetPropertiesResource
TableGetResults

An Azure Cosmos DB Table.

TableResource

Cosmos DB table resource object

ThroughputPolicyResource

Cosmos DB resource throughput policy

ThroughputSettingsGetPropertiesResource
ThroughputSettingsGetResults

An Azure Cosmos DB resource throughput.

ThroughputSettingsResource

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

ThroughputSettingsUpdateParameters

Parameters to update Cosmos DB resource throughput.

TrackedResource

Tracked Resource

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.

Usage

The usage data for a usage request.

VirtualNetworkRule

Virtual Network ACL Rule object

Enums

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.