Azure.ResourceManager.CosmosDB.Models Namespace

Classes

ApiProperties

The ApiProperties.

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.

AutoscaleSettings

The AutoscaleSettings.

AutoscaleSettingsResource

Cosmos DB provisioned throughput settings object.

AutoUpgradePolicyResource

Cosmos DB resource auto-upgrade policy.

Capability

Cosmos DB capability object.

CassandraKeyspaceCreateUpdateParameters

Parameters to create and update Cosmos DB Cassandra keyspace.

CassandraKeyspaceGetPropertiesOptions

The CassandraKeyspaceGetPropertiesOptions.

CassandraKeyspaceGetPropertiesResource

The CassandraKeyspaceGetPropertiesResource.

CassandraKeyspaceGetResults

An Azure Cosmos DB Cassandra keyspace.

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.

CassandraTableGetPropertiesResource

The CassandraTableGetPropertiesResource.

CassandraTableGetResults

An Azure Cosmos DB Cassandra table.

CassandraTableListResult

The List operation response, that contains the Cassandra tables and their properties.

CassandraTableResource

Cosmos DB Cassandra table resource object.

ClusterKey

Cosmos DB Cassandra table cluster key.

Column

Cosmos DB Cassandra table column.

CompositePath

The CompositePath.

ConflictResolutionPolicy

The conflict resolution policy for the container.

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.

CorsPolicy

The CORS policy for the Cosmos DB database account.

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.

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.

DatabaseAccountsListResult

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

DatabaseAccountUpdateParameters

Parameters for patching Azure Cosmos DB database account properties.

ExcludedPath

The 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

The GremlinDatabaseGetPropertiesOptions.

GremlinDatabaseGetPropertiesResource

The GremlinDatabaseGetPropertiesResource.

GremlinDatabaseGetResults

An Azure Cosmos DB Gremlin database.

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.

GremlinGraphGetPropertiesResource

The GremlinGraphGetPropertiesResource.

GremlinGraphGetResults

An Azure Cosmos DB Gremlin graph.

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.

IndexingPolicy

Cosmos DB indexing policy.

IpAddressOrRange

IpAddressOrRange object.

Location

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

Metric

Metric data.

MetricAvailability

The availability of the metric.

MetricDefinition

The definition of a 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.

MongoDBCollectionGetPropertiesResource

The MongoDBCollectionGetPropertiesResource.

MongoDBCollectionGetResults

An Azure Cosmos DB MongoDB collection.

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.

MongoDBDatabaseGetPropertiesResource

The MongoDBDatabaseGetPropertiesResource.

MongoDBDatabaseGetResults

An Azure Cosmos DB MongoDB database.

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.

NotebookWorkspace

A notebook workspace resource.

NotebookWorkspaceConnectionInfoResult

The connection info for the given notebook workspace.

NotebookWorkspaceCreateUpdateParameters

Parameters to create a notebook workspace resource.

NotebookWorkspaceListResult

A list of notebook workspace resources.

Operation

REST API operation.

OperationDisplay

The object that represents the operation.

OperationListResult

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.

OptionsResource

Cosmos DB options resource object.

PartitionMetric

The metric values for a single partition.

PartitionMetricListResult

The response to a list partition metrics request.

PartitionUsage

The partition level usage data for a usage request.

PartitionUsagesResult

The response to a list partition level usage request.

PercentileMetric

Percentile Metric data.

PercentileMetricListResult

The response to a list percentile metrics request.

PercentileMetricValue

Represents percentile metrics values.

PrivateEndpointConnection

A private endpoint connection.

PrivateEndpointConnectionAutoGenerated

A private endpoint connection.

PrivateEndpointConnectionListResult

A list of private endpoint connections.

PrivateEndpointProperty

Private endpoint which the connection belongs to.

PrivateLinkResource

A private link resource.

PrivateLinkResourceListResult

A list of private link resources.

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

PrivateLinkServiceConnectionStatePropertyAutoGenerated

Connection State of the Private Endpoint Connection.

ProxyResource

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

RegionForOnlineOffline

Cosmos DB region to online or offline.

Resource

The Resource.

SpatialSpec

The SpatialSpec.

SqlContainerCreateUpdateParameters

Parameters to create and update Cosmos DB container.

SqlContainerGetPropertiesOptions

The SqlContainerGetPropertiesOptions.

SqlContainerGetPropertiesResource

The SqlContainerGetPropertiesResource.

SqlContainerGetResults

An Azure Cosmos DB container.

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.

SqlDatabaseGetPropertiesResource

The SqlDatabaseGetPropertiesResource.

SqlDatabaseGetResults

An Azure Cosmos DB SQL database.

SqlDatabaseListResult

The List operation response, that contains the SQL databases and their properties.

SqlDatabaseResource

Cosmos DB SQL database resource object.

SqlStoredProcedureCreateUpdateParameters

Parameters to create and update Cosmos DB storedProcedure.

SqlStoredProcedureGetPropertiesResource

The SqlStoredProcedureGetPropertiesResource.

SqlStoredProcedureGetResults

An Azure Cosmos DB storedProcedure.

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.

SqlTriggerGetResults

An Azure Cosmos DB trigger.

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.

SqlUserDefinedFunctionGetResults

An Azure Cosmos DB userDefinedFunction.

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.

TableGetPropertiesResource

The TableGetPropertiesResource.

TableGetResults

An Azure Cosmos DB Table.

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.

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.

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.

Usage

The usage data for a usage request.

UsagesResult

The response to a list usage request.

VirtualNetworkRule

Virtual Network ACL Rule object.

Structs

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.

DatabaseAccountKind

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

DataType

The datatype for which the indexing behavior is applied to.

IndexingMode

Indicates the indexing mode.

IndexKind

Indicates the type of index.

KeyKind

The access key to regenerate.

NotebookWorkspaceName

The NotebookWorkspaceName.

PartitionKind

Indicates the kind of algorithm used for partitioning.

PrimaryAggregationType

The primary aggregation type of the metric.

PublicNetworkAccess

Whether requests from Public Network are allowed.

ServerVersion

Describes the ServerVersion of an a MongoDB account.

SpatialType

Indicates the spatial type of index.

TriggerOperation

The operation the trigger is associated with.

TriggerType

Type of the Trigger.

UnitType

The unit of the metric.

Enums

DefaultConsistencyLevel

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