Microsoft.Azure.Documents Namespace

Contains classes and interfaces that support defining document resources.

Classes

Attachment

Represents a document attachment in the Azure DocumentDB database service.

Conflict

This is the conflicting resource resulting from a concurrent async operation in the Azure DocumentDB database service.

ConsistencyPolicy

Represents the consistency policy of a database account of the Azure DocumentDB database service.

Database

Represents a database in the Azure DocumentDB account.

DatabaseAccount

Represents a DatabaseAccount. A DatabaseAccount is the container for databases in the Azure DocumentDB database service.

DatabaseAccountLocation

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

Document

Represents a document in the Azure DocumentDB database service.

DocumentClientException

The base class for client exceptions in the Azure DocumentDB database service.

DocumentCollection

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

Error

Encapsulates error related details in the Azure DocumentDB database service.

ExcludedPath

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

HashIndex

Represents details of the hash index setting in an Azure DocumentDB database service.

IncludedPath

Specifies a path within a JSON document to be included in the Azure DocumentDB database service.

Index

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

IndexingPolicy

Represents the indexing policy configuration for a collection in the Azure DocumentDB database service.

JsonSerializable

Represents the base class for Azure DocumentDB 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 DocumentDB database service.

Offer

Represents the offer for a resource (collection) in the Azure DocumentDB database service.

OfferContentV2

Represents content properties tied to the Standard pricing tier for the Azure DocumentDB database service.

OfferV2

Represents the Standard pricing offer for a resource in the Azure DocumentDB database service.

PartitionKey

Represents a partition key value that identifies the target partition of a collection in the Azure DocumentDB database service.

PartitionKeyDefinition

Specifies a partition key definition for a particular path in the Azure DocumentDB database service.

PartitionKeyRange

Represents a partition key range in the Azure DocumentDB database service.

Permission

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

QueryEngineTimes

Query engine time in the Azure DocumentDB database service.

QueryMetrics

Query metrics in the Azure DocumentDB database service.

QueryPreparationTimes

Query preparation metrics in the Azure DocumentDB database service.

RangeIndex

Specifies an instance of the RangeIndex class in the Azure DocumentDB database service.

ReplicationPolicy

Replication policy.

Resource

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

RuntimeExecutionTimes

Query runtime execution times in the Azure DocumentDB database service.

SpatialIndex

Specifies an instance of the SpatialIndex class in the Azure DocumentDB database service.

SqlParameter

Represents a parameter associated with SqlQuerySpec in the Azure DocumentDB database service.

SqlParameterCollection

Represents a collection of parameters associated with SqlQuerySpec for use in the Azure DocumentDB database service.

SqlQuerySpec

Represents a SQL query in the Azure DocumentDB database service.

StoredProcedure

Represents a stored procedure in the Azure DocumentDB database service.

Trigger

Represents a trigger in the Azure DocumentDB database 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 DocumentDB document.

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 DocumentDB database service.

UserDefinedFunction

Represents a user defined function in the Azure DocumentDB database service.

Interfaces

IDocumentClient

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

Enums

ConsistencyLevel

These are the consistency levels supported by the Azure DocumentDB database service.

DataType

Defines the target data type of an index path specification in the Azure DocumentDB database service.

IndexingDirective

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

IndexingMode

Specifies the supported indexing modes in the Azure DocumentDB database service.

IndexKind

These are the indexing types available for indexing a path in the Azure DocumentDB database service.

OperationKind

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

PermissionMode

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

SerializationFormattingPolicy

The formatting policy associated with JSON serialization/de-serialization in the Azure DocumentDB database service.

TriggerOperation

Specifies the operations on which a trigger should be executed in the Azure DocumentDB database service.

TriggerType

Specifies the type of the trigger in the Azure DocumentDB database service.

UserDefinedFunctionType