Microsoft.Azure.Documents.Client Namespace

Contains classes and interfaces that support creating clients for the Azure DocumentDB service.

Classes

AccessCondition

Represents a set of access conditions to be used for operations in the Azure Cosmos DB service.

ChangeFeedOptions

Specifies the options associated with change feed methods (enumeration operations) in the Azure Cosmos DB service.

ConnectionPolicy

Represents the connection policy associated with a DocumentClient to connect to the Azure Cosmos DB service.

DocumentClient

Provides a client-side logical representation for the Azure Cosmos DB service. This client is used to configure and execute requests against the service.

DocumentResponse<TDocument>

Represents the template class used by methods returning single objects in the Azure Cosmos DB service.

FeedOptions

Specifies the options associated with feed methods (enumeration operations) in the Azure Cosmos DB service.

FeedResponse<T>

Represents the template class used by feed methods (enumeration operations) for the Azure Cosmos DB service.

MediaOptions

Options used with attachment content (aka media) creation in the Azure Cosmos DB service.

MediaResponse

Represents the response associated with retrieving attachment content from the Azure Cosmos DB service.

RequestOptions

Encapsulates options that can be specified for different requests issued to the Azure Cosmos DB service.

ResourceResponse<TResource>

Represents the template class used by methods returning single objects in the Azure Cosmos DB service.

ResourceResponseBase

Represents the non-resource specific service response headers returned by any request in the Azure Cosmos DB service.

RetryOptions

RetryOptions class defines the parameters an application can set to customize the built-in retry policies in the Azure Cosmos DB service.

StoredProcedureResponse<TValue>

Represents the response returned from a database stored procedure in the Azure Cosmos DB service. Wraps the response body and headers.

UriFactory

Helper class to assist in creating the various Uris needed for use with the DocumentClient instance in the Azure Cosmos DB service.

Interfaces

IDocumentResponse<TDocument>

Interface exposed for mocking purposes for the Azure Cosmos DB service.

IFeedResponse<T>

Captures APIs for responses associated with feed methods (enumeration operations) in the Azure Cosmos DB service. Interface exposed for mocking purposes.

IMediaResponse

Captures the APIs for responses associated with media resource in the Azure Cosmos DB service. Interface exposed for mocking purposes.

IPartitionResolver

This represents a partition resolver for a database. Given a partition key, return the collection link(s) matching the partition key in the Azure Cosmos DB service.

IResourceResponse<TResource>

Interface exposed for mocking purposes for the Azure Cosmos DB service.

IResourceResponseBase

Represents the non-resource specific service response headers returned by any request in the Azure Cosmos DB service.

IStoredProcedureResponse<TValue>

Interface exposed for mocking purposes for the Azure Cosmos DB service.

Enums

AccessConditionType

Specifies the set of AccessCondition types that can be used for operations in the Azure Cosmos DB service.

ConnectionMode

Represents the connection mode to be used by the client when connecting to the Azure Cosmos DB service.

MediaReadMode

Represents the mode for use with downloading attachment content (a.k.a. media) in the Azure Cosmos DB service.

Protocol

Specifies the protocol to be used by DocumentClient for communicating to the Azure Cosmos DB service.