DocumentClient Class

 

Updated: June 30, 2017

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

Namespace:   Microsoft.Azure.Documents.Client
Assembly:  Microsoft.Azure.Documents.Client (in Microsoft.Azure.Documents.Client.dll)

SystemObject
  Microsoft.Azure.Documents.ClientDocumentClient

C#
C++
VB
F#
Copy
No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodDocumentClient

Obsolete. Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified Azure DocumentDB database service endpoint, a dictionary of resource tokens and a connection policy.

System_CAPS_pubmethodDocumentClient

Initializes a new instance of the DocumentClient class using the specified DocumentDB service endpoint for the Azure DocumentDB database service, a list of permission objects and a connection policy.

System_CAPS_pubmethodDocumentClient

Initializes a new instance of the DocumentClient class using the specified DocumentDB service endpoint, key, and connection policy for the Azure DocumentDB database service.

System_CAPS_pubmethodDocumentClient

Initializes a new instance of the DocumentClient class using the specified service endpoint, an authorization key (or resource token) and a connection policy for the Azure DocumentDB database service.

NameDescription
System_CAPS_pubproperty

Gets the AuthKey used by the client from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the Connection policy used by the client from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the configured consistency level of the client from the Azure DocumentDB database service.

System_CAPS_pubproperty

Obsolete. Partition resolvers are a dictionary of database links to IPartitionResolver to be used in partitioning for the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the current read endpoint chosen based on availability and preference from the Azure DocumentDB database service.

System_CAPS_pubproperty

Obsolete. Gets a dictionary of resource tokens used by the client from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the endpoint Uri for the service endpoint from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets or sets the session object used for session consistency version tracking in the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the current write endpoint chosen based on availability and preference from the Azure DocumentDB database service.

NameDescription
System_CAPS_pubmethodCreateAttachmentAsync

Creates an attachment as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentAsync

Creates an Attachment with the contents of the provided mediaStream as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentAsync

Creates an attachment as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentAsync

Creates an attachment as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentQuery

Overloaded. This method creates a query for attachments in the Azure DocumentDB database service. It returns an IOrderedQueryable{Attachment}.

System_CAPS_pubmethodCreateAttachmentQuery

Overloaded. This method creates a query for attachments in the Azure DocumentDB database service by using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateAttachmentQuery

Overloaded. This method creates a query for attachments in the Azure DocumentDB database service by using a SQL statement. It returns an IQueryable{dynamic}.

System_CAPS_pubmethodCreateAttachmentQuery

Extension method to create a query for attachments in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentQuery

Extension method to create a query for attachments in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentQuery

Extension method to create a query for attachments in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentQuery

Overloaded. This method creates a query for attachments in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentQuery

Overloaded. This method creates a query for attachments in the Azure DocumentDB database service by using a SQL statement with parameterized values. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateAttachmentQuery

Overloaded. This method creates a query for attachments in the Azure DocumentDB database service by using a SQL statement.

System_CAPS_pubmethodCreateAttachmentQuery

Extension method to create a query for attachments in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentQuery

Extension method to create a query for attachments in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateAttachmentQuery

Extension method to create a query for attachments in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateConflictQuery

Overloaded. This method creates a query for conflicts under a collection in an Azure DocumentDB database service. It returns An IOrderedQueryable{Conflict}.

System_CAPS_pubmethodCreateConflictQuery

Overloaded. This method creates a query for conflicts under a collection in an Azure DocumentDB database with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateConflictQuery

Overloaded. This method creates a query for conflicts under a collection in an Azure DocumentDB database service. It returns an IQueryable{Conflict}.

System_CAPS_pubmethodCreateConflictQuery

Extension method to create a query for conflicts in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateConflictQuery

Extension method to create a query for conflicts in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateConflictQuery

Extension method to create a query for conflicts in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDatabaseAsync

Creates a database resource as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDatabaseIfNotExistsAsync

Creates(if doesn't exist) or gets(if already exists) a database resource as an asychronous operation in the Azure DocumentDB database service. You can check the status code from the response to determine whether the database was newly created(201) or existing database was returned(200)

System_CAPS_pubmethodCreateDatabaseQuery

Overloaded. This method creates a query for database resources under an account in the Azure DocumentDB database service. It returns An IOrderedQueryable{Database}.

System_CAPS_pubmethodCreateDatabaseQuery

Overloaded. This method creates a query for database resources under an Azure DocumentDB database account by using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateDatabaseQuery

Overloaded. This method creates a query for database resources under an Azure DocumentDB database account by using a SQL statement. It returns an IQueryable{dynamic}.

System_CAPS_pubmethodCreateDocumentAsync

Creates a Document as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentAsync

Creates a document as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentChangeFeedQuery

Overloaded. This method creates a change feed query for documents under a collection in an Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentChangeFeedQuery

Extension method to create a change feed query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentCollectionAsync

Creates a collection as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentCollectionAsync

Creates a collection as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentCollectionIfNotExistsAsync

Creates(if doesn't exist) or gets(if already exists) a collection as an asychronous operation in the Azure DocumentDB database service. You can check the status code from the response to determine whether the collection was newly created(201) or existing collection was returned(200).

System_CAPS_pubmethodCreateDocumentCollectionIfNotExistsAsync

Creates(if doesn't exist) or gets(if already exists) a collection as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentCollectionQuery

Overloaded. This method creates a query for collections under an Azure DocumentDB database database. It returns An IOrderedQueryable{DocumentCollection}.

System_CAPS_pubmethodCreateDocumentCollectionQuery

Overloaded. This method creates a query for collections under an Azure DocumentDB database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateDocumentCollectionQuery

Overloaded. This method creates a query for collections under an Azure DocumentDB database using a SQL statement. It returns an IQueryable{DocumentCollection}.

System_CAPS_pubmethodCreateDocumentCollectionQuery

Extension method to create a query for document collections in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentCollectionQuery

Extension method to create a query for document collections in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentCollectionQuery

Extension method to create a query for document collections in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database service. It returns IOrderedQueryable{Document}.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database service. It returns IOrderedQueryable{Document}.

System_CAPS_pubmethodCreateDocumentQuery

Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateDocumentQuery

Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database using a SQL statement. It returns an IQueryable{dynamic}.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database using a SQL statement. It returns an IQueryable{dynamic}.

System_CAPS_pubmethodCreateDocumentQuery

Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database using a SQL statement with parameterized values. It returns an IQueryable{T}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database using a SQL statement with parameterized values. It returns an IQueryable{T}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateDocumentQuery

Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database using a SQL statement. It returns an IQueryable{T}.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Overloaded. This method creates a query for documents under a collection in an Azure DocumentDB database using a SQL statement. It returns an IQueryable{T}.

System_CAPS_pubmethodCreateDocumentQuery

Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Extension method to create a query for documents for the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateDocumentQuery

Obsolete. Extension method to create a query for documents in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateOfferQuery

Overloaded. This method creates a query for offers under an Azure DocumentDB database account. It returns IOrderedQueryable{Offer}.

System_CAPS_pubmethodCreateOfferQuery

Overloaded. This method creates a query for offers under an Azure DocumentDB database account using a SQL statement with parameterized values. It returns IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateOfferQuery

Overloaded. This method creates a query for offers under an Azure DocumentDB database account using a SQL statement. It returns IQueryable{dynamic}.

System_CAPS_pubmethodCreatePermissionAsync

Creates a permission on a user object as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreatePermissionAsync

Creates a permission as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreatePermissionQuery

Overloaded. This method creates a query for permissions under a user in an Azure DocumentDB database service. It returns IOrderedQueryable{Permission}.

System_CAPS_pubmethodCreatePermissionQuery

Overloaded. This method creates a query for permissions under a user in an Azure DocumentDB database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreatePermissionQuery

Overloaded. This method creates a query for permissions under a user in an Azure DocumentDB database using a SQL statement. It returns IQueryable{dynamic}.

System_CAPS_pubmethodCreatePermissionQuery

Extension method to create a query for permissions in the Azure DocumentDB database service.

System_CAPS_pubmethodCreatePermissionQuery

Extension method to create a query for permissions in the Azure DocumentDB database service.

System_CAPS_pubmethodCreatePermissionQuery

Extension method to create a query for permissions in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateStoredProcedureAsync

Creates a stored procedure as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateStoredProcedureAsync

Creates a stored procedure as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateStoredProcedureQuery

Overloaded. This method creates a query for stored procedures under a collection in an Azure DocumentDB database service. It returns An IOrderedQueryable{StoredProcedure}.

System_CAPS_pubmethodCreateStoredProcedureQuery

Overloaded. This method creates a query for stored procedures under a collection in an Azure DocumentDB database using a SQL statement using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateStoredProcedureQuery

Overloaded. This method creates a query for stored procedures under a collection in an Azure DocumentDB database using a SQL statement. It returns an IQueryable{dynamic}.

System_CAPS_pubmethodCreateStoredProcedureQuery

Extension method to create query for stored procedures in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateStoredProcedureQuery

Extension method to create query for stored procedures in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateStoredProcedureQuery

Extension method to create query for stored procedures in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateTriggerAsync

Creates a trigger as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateTriggerAsync

Creates a trigger as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateTriggerQuery

Overloaded. This method creates a query for triggers under a collection in an Azure DocumentDB database service. It returns An IOrderedQueryable{Trigger}.

System_CAPS_pubmethodCreateTriggerQuery

Overloaded. This method creates a query for triggers under a collection in an Azure DocumentDB database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateTriggerQuery

Overloaded. This method creates a query for triggers under a collection in an Azure DocumentDB database service. It returns an IQueryable{dynamic}.

System_CAPS_pubmethodCreateTriggerQuery

Extension method to create query for triggers in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateTriggerQuery

Extension method to create query for triggers in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateTriggerQuery

Extension method to create query for triggers in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserAsync

Creates a user object as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserAsync

Creates a user as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserDefinedFunctionAsync

Creates a user defined function as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserDefinedFunctionAsync

Creates a user defined function as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserDefinedFunctionQuery

Overloaded. This method creates a query for udfs under a collection in an Azure DocumentDB database service. It returns An IOrderedQueryable{UserDefinedFunction}.

System_CAPS_pubmethodCreateUserDefinedFunctionQuery

Overloaded. This method creates a query for udfs under a collection in an Azure DocumentDB database with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateUserDefinedFunctionQuery

Overloaded. This method creates a query for udfs under a collection in an Azure DocumentDB database using a SQL statement. It returns an IQueryable{dynamic}.

System_CAPS_pubmethodCreateUserDefinedFunctionQuery

Extension method to create a query for user-defined functions in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserDefinedFunctionQuery

Extension method to create a query for user-defined functions in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserDefinedFunctionQuery

Extension method to create a query for user-defined functions in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserQuery

Overloaded. This method creates a query for users under an Azure DocumentDB database service. It returns IOrderedQueryable{User}.

System_CAPS_pubmethodCreateUserQuery

Overloaded. This method creates a query for users under an Azure DocumentDB database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec.

System_CAPS_pubmethodCreateUserQuery

Overloaded. This method creates a query for users under an Azure DocumentDB database service. It returns IQueryable{dyanamic}.

System_CAPS_pubmethodCreateUserQuery

Extension method to create a query for users in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserQuery

Extension method to create a query for users in the Azure DocumentDB database service.

System_CAPS_pubmethodCreateUserQuery

Extension method to create a query for users in the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteAttachmentAsync

Delete an Attachment from the the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteAttachmentAsync

Delete an attachment as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteConflictAsync

Delete a Conflict from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteConflictAsync

Delete a conflict as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteDatabaseAsync

Delete a Database from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteDatabaseAsync

Delete a database as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteDocumentAsync

Delete a Document from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteDocumentAsync

Delete a document as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteDocumentCollectionAsync

Delete a DocumentCollection from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteDocumentCollectionAsync

Delete a collection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeletePermissionAsync

Delete a Permission from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeletePermissionAsync

Delete a permission as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteStoredProcedureAsync

Delete a StoredProcedure from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteStoredProcedureAsync

Delete a stored procedure as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteTriggerAsync

Delete a Trigger from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteTriggerAsync

Delete a trigger as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteUserAsync

Delete a User from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteUserAsync

Delete a user as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDeleteUserDefinedFunctionAsync

Delete a UserDefinedFunction from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodDeleteUserDefinedFunctionAsync

Delete a user defined function as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodDispose

Disposes the client for the Azure DocumentDB database service.

System_CAPS_pubmethodEquals

(Inherited from Object.)

System_CAPS_pubmethodExecuteStoredProcedureAsync

Executes a stored procedure against a collection as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodExecuteStoredProcedureAsync

Executes a stored procedure against a partitioned collection in the Azure DocumentDB database service as an asynchronous operation, specifiying a target partition.

System_CAPS_pubmethodExecuteStoredProcedureAsync

Executes a stored procedure against a collection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodExecuteStoredProcedureAsync

Executes a stored procedure against a collection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodGetDatabaseAccountAsync

Read the DatabaseAccount from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodGetHashCode

(Inherited from Object.)

System_CAPS_pubmethodGetType

(Inherited from Object.)

System_CAPS_pubmethodOpenAsync

Open the connection to validate that the client initialization is successful in the Azure DocumentDB database service.

System_CAPS_pubmethodReadAttachmentAsync

Reads an Attachment from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadAttachmentAsync

Reads an Attachment as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadAttachmentFeedAsync

Reads the feed (sequence) of Attachment for a document from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadAttachmentFeedAsync

Reads the feed (sequence) of attachments for a document as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadConflictAsync

Reads a Conflict from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadConflictAsync

Reads a Conflict as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadConflictFeedAsync

Reads the feed (sequence) of Conflict for a collection from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadConflictFeedAsync

Reads the feed (sequence) of conflicts for a collection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadDatabaseAsync

Reads a Database from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadDatabaseAsync

Reads a Database as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadDatabaseFeedAsync

Reads the feed (sequence) of Database for a database account from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadDocumentAsync

Reads a Document from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadDocumentAsync

Reads a Document as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadDocumentAsync

Reads a Document as a generic type T from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadDocumentAsync

Reads a Document as a generic type T from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadDocumentCollectionAsync

Reads a DocumentCollection from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadDocumentCollectionAsync

Reads a DocumentCollection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadDocumentCollectionFeedAsync

Reads the feed (sequence) of DocumentCollection for a database from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadDocumentCollectionFeedAsync

Reads the feed (sequence) of collections for a database as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadDocumentFeedAsync

Reads the feed (sequence) of documents for a specified collection from the Azure DocumentDB database service. This takes returns a ResourceResponse which will contain an enumerable list of dynamic objects.

System_CAPS_pubmethodReadDocumentFeedAsync

Reads the feed (sequence) of documents for a collection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadMediaAsync

Retrieves the specified attachment content (aka media) from the Azure DocumentDB database service.

System_CAPS_pubmethodReadMediaMetadataAsync

Retrieves the metadata associated with the specified attachment content (aka media) as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadOfferAsync

Reads an Offer from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadOffersFeedAsync

Reads the feed (sequence) of Offer for a database account from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadPartitionKeyRangeFeedAsync

Reads the feed (sequence) of PartitionKeyRange for a database account from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadPartitionKeyRangeFeedAsync

Reads the feed (sequence) of PartitionKeyRange for a database account from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadPermissionAsync

Reads a Permission from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadPermissionAsync

Reads a Permission resource as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadPermissionFeedAsync

Reads the feed (sequence) of Permission for a user from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadPermissionFeedAsync

Reads the feed (sequence) of permissions for a user as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadStoredProcedureAsync

Reads a StoredProcedure from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadStoredProcedureAsync

Reads a StoredProcedure as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadStoredProcedureFeedAsync

Reads the feed (sequence) of StoredProcedure for a collection from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadStoredProcedureFeedAsync

Reads the feed (sequence) of stored procedures for a collection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadTriggerAsync

Reads a Trigger from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadTriggerAsync

Reads a Trigger as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadTriggerFeedAsync

Reads the feed (sequence) of Trigger for a collection from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadTriggerFeedAsync

Reads the feed (sequence) of triggers for a collection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadUserAsync

Reads a User from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadUserAsync

Reads a User as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadUserDefinedFunctionAsync

Reads a UserDefinedFunction from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadUserDefinedFunctionAsync

Reads a UserDefinedFunction as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadUserDefinedFunctionFeedAsync

Reads the feed (sequence) of UserDefinedFunction for a collection from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadUserDefinedFunctionFeedAsync

Reads the feed (sequence) of user defined functions for a collection as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReadUserFeedAsync

Reads the feed (sequence) of User for a database from the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReadUserFeedAsync

Reads the feed (sequence) of users for a database as an asynchronous operation from the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceAttachmentAsync

Replaces a Attachment in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplaceAttachmentAsync

Replaces an attachment as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceDocumentAsync

Replaces a Document in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplaceDocumentAsync

Replaces a Document in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplaceDocumentAsync

Replaces a document as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceDocumentCollectionAsync

Replaces a document collection in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplaceDocumentCollectionAsync

Replaces a document collection as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceOfferAsync

Replaces a Offer in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplacePermissionAsync

Replaces a Permission in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplacePermissionAsync

Replaces a permission as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceStoredProcedureAsync

Replaces a StoredProcedure in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplaceStoredProcedureAsync

Replace the specified stored procedure in the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceTriggerAsync

Replaces a Trigger in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplaceTriggerAsync

Replaces a trigger as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceUserAsync

Replaces a user as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceUserAsync

Replaces a User in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodReplaceUserDefinedFunctionAsync

Replaces a user defined function as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodReplaceUserDefinedFunctionAsync

Replaces a UserDefinedFunction in the Azure DocumentDB database service as an asynchronous operation.

System_CAPS_pubmethodToString

(Inherited from Object.)

System_CAPS_pubmethodUpdateMediaAsync

Replaces the specified media's content as an asynchronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertDocumentAsync

Upserts a Document as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertDocumentAsync

Upserts a document as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertPermissionAsync

Upserts a permission on a user object in the Azure DocumentDB database service as an asychronous operation.

System_CAPS_pubmethodUpsertPermissionAsync

Upserts a permission as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertStoredProcedureAsync

Upserts a stored procedure as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertStoredProcedureAsync

Upserts a stored procedure as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertTriggerAsync

Upserts a trigger as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertTriggerAsync

Upserts a trigger as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertUserAsync

Upserts a permission on a user object in the Azure DocumentDB database service as an asychronous operation.

System_CAPS_pubmethodUpsertUserAsync

Upserts a user as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertUserDefinedFunctionAsync

Upserts a user defined function as an asychronous operation in the Azure DocumentDB database service.

System_CAPS_pubmethodUpsertUserDefinedFunctionAsync

Upserts a user defined function as an asychronous operation in the Azure DocumentDB database service.

NameDescription
System_CAPS_pubmethodIsDefined

Determines if a certain property is defined or not. (Defined by TypeCheckFunctionsExtensions.)

System_CAPS_pubmethodIsNull

Determines if a certain property is null or not. (Defined by TypeCheckFunctionsExtensions.)

System_CAPS_pubmethodIsPrimitive

Determines if a certain property is of premitive JSON type. (Defined by TypeCheckFunctionsExtensions.)

The service client that encapsulates the endpoint and credentials and connection policy used to access the DocumentDB service. It is recommended to cache and reuse this instance within your application rather than creating a new instance for every operation.

When your app uses DocumentClient, you should call its IDisposable.Dispose implementation when you are finished using it. Depending on your programming technique, you can do this in one of two ways:

1. By using a language construct such as the using statement in C#. The using statement is actually a syntactic convenience. At compile time, the language compiler implements the intermediate language (IL) for a try/catch block.

C#
Copy 

using (DocumentClient client = new DocumentClient(new Uri("endpoint"), "authKey"))
{
    ...
}

2. By wrapping the call to the IDisposable.Dispose implementation in a try/catch block. The following example replaces the using block in the previous example with a try/catch/finally block.

C#
Copy 

DocumentClient client = new DocumentClient(new Uri("endpoint"), "authKey"))
try{
    ...               
}
finally{
    if (client != null) client.Dispose();
}

This type is thread safe.

Return to top
Show: