Microsoft.Azure.Documents Namespace

Classes

Attachment

Represents a document attachment in the Azure Cosmos DB service.

CompositePath

DOM for a composite path. A composite path is used in a composite index. For example if you want to run a query like "SELECT * FROM c ORDER BY c.age, c.height", then you need to add "/age" and "/height" as composite paths to your composite index.

Conflict

This is the conflicting resource resulting from a concurrent async operation in the Azure Cosmos DB service.

ConflictResolutionPolicy

Represents the conflict resolution policy configuration for specifying how to resolve conflicts in case writes from different regions result in conflicts on documents in the collection in the Azure Cosmos DB service.

ConsistencyPolicy

Represents the consistency policy of a database account of the Azure Cosmos DB service.

Database

Represents a database in the Azure Cosmos DB account.

DatabaseAccount

Represents a DatabaseAccount. A DatabaseAccount is the container for databases in the Azure Cosmos DB service.

DatabaseAccountLocation

The DatabaseAccountLocation class represents an Azure Cosmos DB database account in a specific region.

Document

Represents a document in the Azure Cosmos DB service.

DocumentClientException

The base class for client exceptions in the Azure Cosmos DB service.

DocumentCollection

Represents a document collection in the Azure Cosmos DB service. A collection is a named logical container for documents.

Error

Encapsulates error related details in the Azure Cosmos DB service.

ExcludedPath

Specifies a path within a JSON document to be excluded while indexing data for the Azure Cosmos DB service.

HashIndex

Represents details of the hash index setting in an Azure Cosmos DB service.

IncludedPath

Specifies a path within a JSON document to be included in the Azure Cosmos DB service.

Index

Base class for IndexingPolicy Indexes in the Azure Cosmos DB service, you should use a concrete Index like HashIndex or RangeIndex.

IndexingPolicy

Represents the indexing policy configuration for a collection in the Azure Cosmos DB service.

JsonSerializable

Represents the base class for Azure Cosmos DB database objects and provides methods for serializing and deserializing from JSON.

LocationNames

The LocationNames class contains the names of Azure regions that are currently supported by the Azure Cosmos DB service.

Offer

Represents the offer for a resource (collection) in the Azure Cosmos DB service.

OfferContentV2

Represents content properties tied to the Standard pricing tier for the Azure Cosmos DB service.

OfferV2

Represents the Standard pricing offer for a resource in the Azure Cosmos DB service.

PartitionKey

Represents a partition key value that identifies the target partition of a collection in the Azure Cosmos DB service.

PartitionKeyDefinition

Specifies a partition key definition for a particular path in the Azure Cosmos DB service.

PartitionKeyRange

Represents a partition key range in the Azure Cosmos DB service.

PartitionKeyRangeStatistics

Represents statistics for a partition key range in the Azure Cosmos DB service.

PartitionKeyStatistics

Represents statistics of a partition key in the Azure Cosmos DB service.

Permission

Represents a per-User permission to access a specific resource in the Azure Cosmos DB service, for example Document or Collection.

QueryEngineTimes

Query engine time in the Azure Cosmos database service. (dummy class that will be deprecated).

QueryMetrics

Query metrics in the Azure Cosmos database service. This metric represents a moving average for a set of queries whose metrics have been aggregated together.

QueryPreparationTimes

Query preparation metrics in the Azure Cosmos database service.

RangeIndex

Specifies an instance of the RangeIndex class in the Azure Cosmos DB service.

ReplicationPolicy

Replication policy.

Resource

Represents an abstract resource type in the Azure Cosmos DB service. All Azure Cosmos DB resources, such as Database, DocumentCollection, and Document extend this abstract type.

RuntimeExecutionTimes

Query runtime execution times in the Azure Cosmos DB service.

SpatialIndex

Specifies an instance of the SpatialIndex class in the Azure Cosmos DB service.

SpatialSpec

Spatial index specification

SqlParameter

Represents a parameter associated with SqlQuerySpec in the Azure Cosmos DB service.

SqlParameterCollection

Represents a collection of parameters associated with SqlQuerySpec for use in the Azure Cosmos DB service.

SqlQuerySpec

Represents a SQL query in the Azure Cosmos DB service.

StoredProcedure

Represents a stored procedure in the Azure Cosmos DB service.

Trigger

Represents a trigger in the Azure Cosmos DB service.

Undefined

Instance of the class can be supplied as part of Partition Key Value to denote a value which is absent in the Azure Cosmos DB document.

UniqueKey

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

UniqueKeyPolicy

Represents the unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

UnixDateTimeConverter

Converts a DateTime object to and from JSON. DateTime is represented as the total number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970-01-01T00:00:00Z).

User

Represents a user in the Azure Cosmos DB service.

UserDefinedFunction

Represents a user defined function in the Azure Cosmos DB service.

Interfaces

IDocumentClient

The IDocumentClient interface captures the API signatures of the Azure Cosmos DB service .NET SDK. See DocumentClient for implementation details.

Enums

CompositePathSortOrder

Defines the target data type of an index path specification in the Azure Cosmos DB service.

ConflictResolutionMode

Specifies the supported conflict resolution modes, as specified in ConflictResolutionPolicy

ConsistencyLevel

These are the consistency levels supported by the Azure Cosmos DB service.

DataType

Defines the target data type of an index path specification in the Azure Cosmos DB service.

IndexingDirective

Specifies whether or not the resource in the Azure Cosmos DB database is to be indexed.

IndexingMode

Specifies the supported indexing modes in the Azure Cosmos DB service.

IndexKind

These are the indexing types available for indexing a path in the Azure Cosmos DB service.

OperationKind

These are the operation types resulted in a version conflict on a resource.

PartitionKeyDefinitionVersion

Partitioning version.

PermissionMode

These are the access permissions for creating or replacing a Permission resource in the Azure Cosmos DB service.

PortReuseMode
SerializationFormattingPolicy

The formatting policy associated with JSON serialization/de-serialization in the Azure Cosmos DB service.

SpatialType

Defines the target data type of an index path specification in the Azure Cosmos DB service.

TriggerOperation

Specifies the operations on which a trigger should be executed in the Azure Cosmos DB service.

TriggerType

Specifies the type of the trigger in the Azure Cosmos DB service.