DocumentClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a client-side logical representation for the Azure Cosmos DB service. This client is used to configure and execute requests against the service.
public sealed class DocumentClient : IDisposabletype DocumentClient = class
interface IDisposable
interface IDocumentClientPublic NotInheritable Class DocumentClient
Implements IDisposable- Inheritance
-
DocumentClient
- Implements
Remarks
The service client that encapsulates the endpoint and credentials and connection policy used to access the Azure Cosmos DB 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.
using (IDocumentClient 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.
IDocumentClient client = new DocumentClient(new Uri("endpoint"), "authKey"))
try{
...
}
finally{
if (client != null) client.Dispose();
}
Constructors
| DocumentClient(Uri, IDictionary<String,String>, ConnectionPolicy, Nullable<ConsistencyLevel>) |
Obsolete.
Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified Azure Cosmos DB service endpoint, a dictionary of resource tokens and a connection policy. |
| DocumentClient(Uri, IList<Permission>, ConnectionPolicy, Nullable<ConsistencyLevel>) |
Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint for the Azure Cosmos DB service, a list of permission objects and a connection policy. |
| DocumentClient(Uri, SecureString, ConnectionPolicy, Nullable<ConsistencyLevel>, JsonSerializerSettings) |
Obsolete.
Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint, key, connection policy and a custom JsonSerializerSettings for the Azure Cosmos DB service. |
| DocumentClient(Uri, SecureString, ConnectionPolicy, Nullable<ConsistencyLevel>) |
Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint, key, and connection policy for the Azure Cosmos DB service. |
| DocumentClient(Uri, SecureString, JsonSerializerSettings, ConnectionPolicy, Nullable<ConsistencyLevel>) |
Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint, key, connection policy and a custom JsonSerializerSettings for the Azure Cosmos DB service. |
| DocumentClient(Uri, String, ConnectionPolicy, Nullable<ConsistencyLevel>, JsonSerializerSettings) |
Obsolete.
Initializes a new instance of the DocumentClient class using the specified service endpoint, an authorization key (or resource token), a connection policy and a custom JsonSerializerSettings for the Azure Cosmos DB service. |
| DocumentClient(Uri, String, ConnectionPolicy, Nullable<ConsistencyLevel>) |
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 Cosmos DB service. |
| DocumentClient(Uri, String, HttpMessageHandler, ConnectionPolicy, Nullable<ConsistencyLevel>) |
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 Cosmos DB service. |
| DocumentClient(Uri, String, JsonSerializerSettings, ConnectionPolicy, Nullable<ConsistencyLevel>) |
Initializes a new instance of the DocumentClient class using the specified service endpoint, an authorization key (or resource token), a connection policy and a custom JsonSerializerSettings for the Azure Cosmos DB service. |
Properties
| AuthKey |
Gets the AuthKey used by the client from the Azure Cosmos DB service. |
| ConnectionPolicy |
Gets the Connection policy used by the client from the Azure Cosmos DB service. |
| ConsistencyLevel |
Gets the configured consistency level of the client from the Azure Cosmos DB service. |
| PartitionResolvers |
Obsolete.
Partition resolvers are a dictionary of database links to IPartitionResolver to be used in partitioning for the Azure Cosmos DB service. |
| ReadEndpoint |
Gets the current read endpoint chosen based on availability and preference from the Azure Cosmos DB service. |
| ResourceTokens |
Obsolete.
Gets a dictionary of resource tokens used by the client from the Azure Cosmos DB service. |
| ServiceEndpoint |
Gets the endpoint Uri for the service endpoint from the Azure Cosmos DB service. |
| Session |
Gets or sets the session object used for session consistency version tracking in the Azure Cosmos DB service. |
| WriteEndpoint |
Gets the current write endpoint chosen based on availability and preference from the Azure Cosmos DB service. |
Methods
| CreateAttachmentAsync(String, Object, RequestOptions, CancellationToken) |
Creates an attachment as an asychronous operation in the Azure Cosmos DB service. |
| CreateAttachmentAsync(String, Stream, MediaOptions, RequestOptions, CancellationToken) |
Creates an Attachment with the contents of the provided |
| CreateAttachmentAsync(Uri, Object, RequestOptions, CancellationToken) |
Creates an attachment as an asychronous operation in the Azure Cosmos DB service. |
| CreateAttachmentAsync(Uri, Stream, MediaOptions, RequestOptions, CancellationToken) |
Creates an attachment as an asynchronous operation in the Azure Cosmos DB service. |
| CreateAttachmentQuery(String, FeedOptions) |
Overloaded. This method creates a query for attachments in the Azure Cosmos DB service. It returns an IOrderedQueryable{Attachment}. |
| CreateAttachmentQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for attachments in the Azure Cosmos DB 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. |
| CreateAttachmentQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for attachments in the Azure Cosmos DB service by using a SQL statement. It returns an IQueryable{dynamic}. |
| CreateAttachmentQuery(Uri, FeedOptions) |
Extension method to create a query for attachments in the Azure Cosmos DB service. |
| CreateAttachmentQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for attachments in the Azure Cosmos DB service. |
| CreateAttachmentQuery(Uri, String, FeedOptions) |
Extension method to create a query for attachments in the Azure Cosmos DB service. |
| CreateAttachmentQuery<T>(String, FeedOptions) |
Overloaded. This method creates a query for attachments in the Azure Cosmos DB service. |
| CreateAttachmentQuery<T>(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for attachments in the Azure Cosmos DB service by using a SQL statement with parameterized values. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec. |
| CreateAttachmentQuery<T>(String, String, FeedOptions) |
Overloaded. This method creates a query for attachments in the Azure Cosmos DB service by using a SQL statement. |
| CreateAttachmentQuery<T>(Uri, FeedOptions) |
Extension method to create a query for attachments in the Azure Cosmos DB service. |
| CreateAttachmentQuery<T>(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for attachments in the Azure Cosmos DB service. |
| CreateAttachmentQuery<T>(Uri, String, FeedOptions) |
Extension method to create a query for attachments in the Azure Cosmos DB service. |
| CreateConflictQuery(String, FeedOptions) |
Overloaded. This method creates a query for conflicts under a collection in an Azure Cosmos DB service. It returns An IOrderedQueryable{Conflict}. |
| CreateConflictQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for conflicts under a collection in an Azure Cosmos DB database with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec. |
| CreateConflictQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for conflicts under a collection in an Azure Cosmos DB service. It returns an IQueryable{Conflict}. |
| CreateConflictQuery(Uri, FeedOptions) |
Extension method to create a query for conflicts in the Azure Cosmos DB service. |
| CreateConflictQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for conflicts in the Azure Cosmos DB service. |
| CreateConflictQuery(Uri, String, FeedOptions) |
Extension method to create a query for conflicts in the Azure Cosmos DB service. |
| CreateDatabaseAsync(Database, RequestOptions) |
Creates a database resource as an asychronous operation in the Azure Cosmos DB service. |
| CreateDatabaseIfNotExistsAsync(Database, RequestOptions) |
Creates(if doesn't exist) or gets(if already exists) a database resource as an asychronous operation in the Azure Cosmos DB 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) |
| CreateDatabaseQuery(FeedOptions) |
Overloaded. This method creates a query for database resources under an account in the Azure Cosmos DB service. It returns An IOrderedQueryable{Database}. |
| CreateDatabaseQuery(SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for database resources under an Azure Cosmos DB 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. |
| CreateDatabaseQuery(String, FeedOptions) |
Overloaded. This method creates a query for database resources under an Azure Cosmos DB database account by using a SQL statement. It returns an IQueryable{dynamic}. |
| CreateDocumentAsync(String, Object, RequestOptions, Boolean, CancellationToken) |
Creates a Document as an asychronous operation in the Azure Cosmos DB service. |
| CreateDocumentAsync(Uri, Object, RequestOptions, Boolean, CancellationToken) |
Creates a document as an asychronous operation in the Azure Cosmos DB service. |
| CreateDocumentChangeFeedQuery(String, ChangeFeedOptions) |
Overloaded. This method creates a change feed query for documents under a collection in an Azure Cosmos DB service. |
| CreateDocumentChangeFeedQuery(Uri, ChangeFeedOptions) |
Extension method to create a change feed query for documents in the Azure Cosmos DB service. |
| CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions) |
Creates a collection as an asychronous operation in the Azure Cosmos DB service. |
| CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions) |
Creates a collection as an asychronous operation in the Azure Cosmos DB service. |
| CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions) |
Creates (if doesn't exist) or gets (if already exists) a collection as an asychronous operation in the Azure Cosmos DB 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). |
| CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions) |
Creates(if doesn't exist) or gets(if already exists) a collection as an asychronous operation in the Azure Cosmos DB service. |
| CreateDocumentCollectionQuery(String, FeedOptions) |
Overloaded. This method creates a query for collections under an Azure Cosmos DB database. It returns An IOrderedQueryable{DocumentCollection}. |
| CreateDocumentCollectionQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for collections under an Azure Cosmos DB 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. |
| CreateDocumentCollectionQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for collections under an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{DocumentCollection}. |
| CreateDocumentCollectionQuery(Uri, FeedOptions) |
Extension method to create a query for document collections in the Azure Cosmos DB service. |
| CreateDocumentCollectionQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for document collections in the Azure Cosmos DB service. |
| CreateDocumentCollectionQuery(Uri, String, FeedOptions) |
Extension method to create a query for document collections in the Azure Cosmos DB service. |
| CreateDocumentQuery(String, FeedOptions, Object) |
Obsolete.
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB service. It returns IOrderedQueryable{Document}. |
| CreateDocumentQuery(String, FeedOptions) |
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB service. It returns IOrderedQueryable{Document}. |
| CreateDocumentQuery(String, SqlQuerySpec, FeedOptions, Object) |
Obsolete.
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB 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. |
| CreateDocumentQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB 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. |
| CreateDocumentQuery(String, String, FeedOptions, Object) |
Obsolete.
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{dynamic}. |
| CreateDocumentQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{dynamic}. |
| CreateDocumentQuery(Uri, FeedOptions, Object) |
Obsolete.
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery(Uri, FeedOptions) |
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery(Uri, SqlQuerySpec, FeedOptions, Object) |
Obsolete.
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery(Uri, String, FeedOptions, Object) |
Obsolete.
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery(Uri, String, FeedOptions) |
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery<T>(String, FeedOptions, Object) |
Obsolete.
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB service. |
| CreateDocumentQuery<T>(String, FeedOptions) |
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB service. |
| CreateDocumentQuery<T>(String, SqlQuerySpec, FeedOptions, Object) |
Obsolete.
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB 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. |
| CreateDocumentQuery<T>(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB 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. |
| CreateDocumentQuery<T>(String, String, FeedOptions, Object) |
Obsolete.
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{T}. |
| CreateDocumentQuery<T>(String, String, FeedOptions) |
Overloaded. This method creates a query for documents under a collection in an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{T}. |
| CreateDocumentQuery<T>(Uri, FeedOptions, Object) |
Obsolete.
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery<T>(Uri, FeedOptions) |
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery<T>(Uri, SqlQuerySpec, FeedOptions, Object) |
Obsolete.
Extension method to create a query for documents for the Azure Cosmos DB service. |
| CreateDocumentQuery<T>(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery<T>(Uri, String, FeedOptions, Object) |
Obsolete.
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateDocumentQuery<T>(Uri, String, FeedOptions) |
Extension method to create a query for documents in the Azure Cosmos DB service. |
| CreateOfferQuery(FeedOptions) |
Overloaded. This method creates a query for offers under an Azure Cosmos DB database account. It returns IOrderedQueryable{Offer}. |
| CreateOfferQuery(SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for offers under an Azure Cosmos DB 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. |
| CreateOfferQuery(String, FeedOptions) |
Overloaded. This method creates a query for offers under an Azure Cosmos DB database account using a SQL statement. It returns IQueryable{dynamic}. |
| CreatePermissionAsync(String, Permission, RequestOptions) |
Creates a permission on a user object as an asychronous operation in the Azure Cosmos DB service. |
| CreatePermissionAsync(Uri, Permission, RequestOptions) |
Creates a permission as an asychronous operation in the Azure Cosmos DB service. |
| CreatePermissionQuery(String, FeedOptions) |
Overloaded. This method creates a query for permissions under a user in an Azure Cosmos DB service. It returns IOrderedQueryable{Permission}. |
| CreatePermissionQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for permissions under a user in an Azure Cosmos DB 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. |
| CreatePermissionQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for permissions under a user in an Azure Cosmos DB database using a SQL statement. It returns IQueryable{dynamic}. |
| CreatePermissionQuery(Uri, FeedOptions) |
Extension method to create a query for permissions in the Azure Cosmos DB service. |
| CreatePermissionQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for permissions in the Azure Cosmos DB service. |
| CreatePermissionQuery(Uri, String, FeedOptions) |
Extension method to create a query for permissions in the Azure Cosmos DB service. |
| CreateStoredProcedureAsync(String, StoredProcedure, RequestOptions) |
Creates a stored procedure as an asychronous operation in the Azure Cosmos DB service. |
| CreateStoredProcedureAsync(Uri, StoredProcedure, RequestOptions) |
Creates a stored procedure as an asychronous operation in the Azure Cosmos DB service. |
| CreateStoredProcedureQuery(String, FeedOptions) |
Overloaded. This method creates a query for stored procedures under a collection in an Azure Cosmos DB service. It returns An IOrderedQueryable{StoredProcedure}. |
| CreateStoredProcedureQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for stored procedures under a collection in an Azure Cosmos DB 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. |
| CreateStoredProcedureQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for stored procedures under a collection in an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{dynamic}. |
| CreateStoredProcedureQuery(Uri, FeedOptions) |
Extension method to create query for stored procedures in the Azure Cosmos DB service. |
| CreateStoredProcedureQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create query for stored procedures in the Azure Cosmos DB service. |
| CreateStoredProcedureQuery(Uri, String, FeedOptions) |
Extension method to create query for stored procedures in the Azure Cosmos DB service. |
| CreateTriggerAsync(String, Trigger, RequestOptions) |
Creates a trigger as an asychronous operation in the Azure Cosmos DB service. |
| CreateTriggerAsync(Uri, Trigger, RequestOptions) |
Creates a trigger as an asychronous operation in the Azure Cosmos DB service. |
| CreateTriggerQuery(String, FeedOptions) |
Overloaded. This method creates a query for triggers under a collection in an Azure Cosmos DB service. It returns An IOrderedQueryable{Trigger}. |
| CreateTriggerQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for triggers under a collection in an Azure Cosmos DB 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. |
| CreateTriggerQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for triggers under a collection in an Azure Cosmos DB service. It returns an IQueryable{dynamic}. |
| CreateTriggerQuery(Uri, FeedOptions) |
Extension method to create query for triggers in the Azure Cosmos DB service. |
| CreateTriggerQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create query for triggers in the Azure Cosmos DB service. |
| CreateTriggerQuery(Uri, String, FeedOptions) |
Extension method to create query for triggers in the Azure Cosmos DB service. |
| CreateUserAsync(String, User, RequestOptions) |
Creates a user object as an asychronous operation in the Azure Cosmos DB service. |
| CreateUserAsync(Uri, User, RequestOptions) |
Creates a user as an asychronous operation in the Azure Cosmos DB service. |
| CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions) |
Creates a user defined function as an asychronous operation in the Azure Cosmos DB service. |
| CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions) |
Creates a user defined function as an asychronous operation in the Azure Cosmos DB service. |
| CreateUserDefinedFunctionQuery(String, FeedOptions) |
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB service. It returns An IOrderedQueryable{UserDefinedFunction}. |
| CreateUserDefinedFunctionQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB database with parameterized values. It returns an IQueryable{dynamic}. For more information on preparing SQL statements with parameterized values, please see SqlQuerySpec. |
| CreateUserDefinedFunctionQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for udfs under a collection in an Azure Cosmos DB database using a SQL statement. It returns an IQueryable{dynamic}. |
| CreateUserDefinedFunctionQuery(Uri, FeedOptions) |
Extension method to create a query for user-defined functions in the Azure Cosmos DB service. |
| CreateUserDefinedFunctionQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for user-defined functions in the Azure Cosmos DB service. |
| CreateUserDefinedFunctionQuery(Uri, String, FeedOptions) |
Extension method to create a query for user-defined functions in the Azure Cosmos DB service. |
| CreateUserQuery(String, FeedOptions) |
Overloaded. This method creates a query for users under an Azure Cosmos DB service. It returns IOrderedQueryable{User}. |
| CreateUserQuery(String, SqlQuerySpec, FeedOptions) |
Overloaded. This method creates a query for users under an Azure Cosmos DB 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. |
| CreateUserQuery(String, String, FeedOptions) |
Overloaded. This method creates a query for users under an Azure Cosmos DB service. It returns IQueryable{dynamic}. |
| CreateUserQuery(Uri, FeedOptions) |
Extension method to create a query for users in the Azure Cosmos DB service. |
| CreateUserQuery(Uri, SqlQuerySpec, FeedOptions) |
Extension method to create a query for users in the Azure Cosmos DB service. |
| CreateUserQuery(Uri, String, FeedOptions) |
Extension method to create a query for users in the Azure Cosmos DB service. |
| DeleteAttachmentAsync(String, RequestOptions, CancellationToken) |
Delete an Attachment from the the Azure Cosmos DB service as an asynchronous operation. |
| DeleteAttachmentAsync(Uri, RequestOptions, CancellationToken) |
Delete an attachment as an asynchronous operation from the Azure Cosmos DB service. |
| DeleteConflictAsync(String, RequestOptions) |
Delete a Conflict from the Azure Cosmos DB service as an asynchronous operation. |
| DeleteConflictAsync(Uri, RequestOptions) |
Delete a conflict as an asynchronous operation from the Azure Cosmos DB service. |
| DeleteDatabaseAsync(String, RequestOptions) |
Delete a Database from the Azure Cosmos DB service as an asynchronous operation. |
| DeleteDatabaseAsync(Uri, RequestOptions) |
Delete a database as an asynchronous operation from the Azure Cosmos DB service. |
| DeleteDocumentAsync(String, RequestOptions, CancellationToken) |
Delete a Document from the Azure Cosmos DB service as an asynchronous operation. |
| DeleteDocumentAsync(Uri, RequestOptions, CancellationToken) |
Delete a document as an asynchronous operation from the Azure Cosmos DB service. |
| DeleteDocumentCollectionAsync(String, RequestOptions) |
Delete a DocumentCollection from the Azure Cosmos DB service as an asynchronous operation. |
| DeleteDocumentCollectionAsync(Uri, RequestOptions) |
Delete a collection as an asynchronous operation from the Azure Cosmos DB service. |
| DeletePermissionAsync(String, RequestOptions) |
Delete a Permission from the Azure Cosmos DB service as an asynchronous operation. |
| DeletePermissionAsync(Uri, RequestOptions) |
Delete a permission as an asynchronous operation from the Azure Cosmos DB service. |
| DeleteStoredProcedureAsync(String, RequestOptions) |
Delete a StoredProcedure from the Azure Cosmos DB service as an asynchronous operation. |
| DeleteStoredProcedureAsync(Uri, RequestOptions) |
Delete a stored procedure as an asynchronous operation from the Azure Cosmos DB service. |
| DeleteTriggerAsync(String, RequestOptions) |
Delete a Trigger from the Azure Cosmos DB service as an asynchronous operation. |
| DeleteTriggerAsync(Uri, RequestOptions) |
Delete a trigger as an asynchronous operation from the Azure Cosmos DB service. |
| DeleteUserAsync(String, RequestOptions) |
Delete a User from the Azure Cosmos DB service as an asynchronous operation. |
| DeleteUserAsync(Uri, RequestOptions) |
Delete a user as an asynchronous operation from the Azure Cosmos DB service. |
| DeleteUserDefinedFunctionAsync(String, RequestOptions) |
Delete a UserDefinedFunction from the Azure Cosmos DB service as an asynchronous operation. |
| DeleteUserDefinedFunctionAsync(Uri, RequestOptions) |
Delete a user defined function as an asynchronous operation from the Azure Cosmos DB service. |
| Dispose() |
Disposes the client for the Azure Cosmos DB service. |
| ExecuteStoredProcedureAsync<TValue>(String, Object[]) |
Executes a stored procedure against a collection as an asynchronous operation in the Azure Cosmos DB service. |
| ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[]) |
Executes a stored procedure against a partitioned collection in the Azure Cosmos DB service as an asynchronous operation, specifiying a target partition. |
| ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[]) |
Executes a stored procedure against a partitioned collection in the Azure Cosmos DB service as an asynchronous operation, specifiying a target partition. |
| ExecuteStoredProcedureAsync<TValue>(Uri, Object[]) |
Executes a stored procedure against a collection as an asynchronous operation from the Azure Cosmos DB service. |
| ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[]) |
Executes a stored procedure against a collection as an asynchronous operation from the Azure Cosmos DB service. |
| ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[]) |
Executes a stored procedure against a collection as an asynchronous operation from the Azure Cosmos DB service. |
| GetDatabaseAccountAsync() |
Read the DatabaseAccount from the Azure Cosmos DB service as an asynchronous operation. |
| OpenAsync(CancellationToken) |
Open the connection to validate that the client initialization is successful in the Azure Cosmos DB service. |
| ReadAttachmentAsync(String, RequestOptions, CancellationToken) |
Reads an Attachment from the Azure Cosmos DB service as an asynchronous operation. |
| ReadAttachmentAsync(Uri, RequestOptions, CancellationToken) |
Reads an Attachment as an asynchronous operation from the Azure Cosmos DB service. |
| ReadAttachmentFeedAsync(String, FeedOptions, CancellationToken) |
Reads the feed (sequence) of Attachment for a document from the Azure Cosmos DB service as an asynchronous operation. |
| ReadAttachmentFeedAsync(Uri, FeedOptions, CancellationToken) |
Reads the feed (sequence) of attachments for a document as an asynchronous operation from the Azure Cosmos DB service. |
| ReadConflictAsync(String, RequestOptions) |
Reads a Conflict from the Azure Cosmos DB service as an asynchronous operation. |
| ReadConflictAsync(Uri, RequestOptions) |
Reads a Conflict as an asynchronous operation from the Azure Cosmos DB service. |
| ReadConflictFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of Conflict for a collection from the Azure Cosmos DB service as an asynchronous operation. |
| ReadConflictFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of conflicts for a collection as an asynchronous operation from the Azure Cosmos DB service. |
| ReadDatabaseAsync(String, RequestOptions) |
Reads a Database from the Azure Cosmos DB service as an asynchronous operation. |
| ReadDatabaseAsync(Uri, RequestOptions) |
Reads a Database as an asynchronous operation from the Azure Cosmos DB service. |
| ReadDatabaseFeedAsync(FeedOptions) |
Reads the feed (sequence) of Database for a database account from the Azure Cosmos DB service as an asynchronous operation. |
| ReadDocumentAsync(String, RequestOptions, CancellationToken) |
Reads a Document from the Azure Cosmos DB service as an asynchronous operation. |
| ReadDocumentAsync(Uri, RequestOptions, CancellationToken) |
Reads a Document as an asynchronous operation from the Azure Cosmos DB service. |
| ReadDocumentAsync<T>(String, RequestOptions, CancellationToken) |
Reads a Document as a generic type T from the Azure Cosmos DB service as an asynchronous operation. |
| ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken) |
Reads a Document as a generic type T from the Azure Cosmos DB service as an asynchronous operation. |
| ReadDocumentCollectionAsync(String, RequestOptions) |
Reads a DocumentCollection from the Azure Cosmos DB service as an asynchronous operation. |
| ReadDocumentCollectionAsync(Uri, RequestOptions) |
Reads a DocumentCollection as an asynchronous operation from the Azure Cosmos DB service. |
| ReadDocumentCollectionFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of DocumentCollection for a database from the Azure Cosmos DB service as an asynchronous operation. |
| ReadDocumentCollectionFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of collections for a database as an asynchronous operation from the Azure Cosmos DB service. |
| ReadDocumentFeedAsync(String, FeedOptions, CancellationToken) |
Reads the feed (sequence) of documents for a specified collection from the Azure Cosmos DB service. This takes returns a ResourceResponse<TResource> which will contain an enumerable list of dynamic objects. |
| ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken) |
Reads the feed (sequence) of documents for a collection as an asynchronous operation from the Azure Cosmos DB service. |
| ReadMediaAsync(String, CancellationToken) |
Retrieves the specified attachment content (aka media) from the Azure Cosmos DB service. |
| ReadMediaMetadataAsync(String) |
Retrieves the metadata associated with the specified attachment content (aka media) as an asynchronous operation from the Azure Cosmos DB service. |
| ReadOfferAsync(String) |
Reads an Offer from the Azure Cosmos DB service as an asynchronous operation. |
| ReadOffersFeedAsync(FeedOptions) |
Reads the feed (sequence) of Offer for a database account from the Azure Cosmos DB service as an asynchronous operation. |
| ReadPartitionKeyRangeFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of PartitionKeyRange for a database account from the Azure Cosmos DB service as an asynchronous operation. |
| ReadPartitionKeyRangeFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of PartitionKeyRange for a database account from the Azure Cosmos DB service as an asynchronous operation. |
| ReadPermissionAsync(String, RequestOptions) |
Reads a Permission from the Azure Cosmos DB service as an asynchronous operation. |
| ReadPermissionAsync(Uri, RequestOptions) |
Reads a Permission resource as an asynchronous operation from the Azure Cosmos DB service. |
| ReadPermissionFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of Permission for a user from the Azure Cosmos DB service as an asynchronous operation. |
| ReadPermissionFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of permissions for a user as an asynchronous operation from the Azure Cosmos DB service. |
| ReadStoredProcedureAsync(String, RequestOptions) |
Reads a StoredProcedure from the Azure Cosmos DB service as an asynchronous operation. |
| ReadStoredProcedureAsync(Uri, RequestOptions) |
Reads a StoredProcedure as an asynchronous operation from the Azure Cosmos DB service. |
| ReadStoredProcedureFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of StoredProcedure for a collection from the Azure Cosmos DB service as an asynchronous operation. |
| ReadStoredProcedureFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of stored procedures for a collection as an asynchronous operation from the Azure Cosmos DB service. |
| ReadTriggerAsync(String, RequestOptions) |
Reads a Trigger from the Azure Cosmos DB service as an asynchronous operation. |
| ReadTriggerAsync(Uri, RequestOptions) |
Reads a Trigger as an asynchronous operation from the Azure Cosmos DB service. |
| ReadTriggerFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of Trigger for a collection from the Azure Cosmos DB service as an asynchronous operation. |
| ReadTriggerFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of triggers for a collection as an asynchronous operation from the Azure Cosmos DB service. |
| ReadUserAsync(String, RequestOptions) |
Reads a User from the Azure Cosmos DB service as an asynchronous operation. |
| ReadUserAsync(Uri, RequestOptions) |
Reads a User as an asynchronous operation from the Azure Cosmos DB service. |
| ReadUserDefinedFunctionAsync(String, RequestOptions) |
Reads a UserDefinedFunction from the Azure Cosmos DB service as an asynchronous operation. |
| ReadUserDefinedFunctionAsync(Uri, RequestOptions) |
Reads a UserDefinedFunction as an asynchronous operation from the Azure Cosmos DB service. |
| ReadUserDefinedFunctionFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of UserDefinedFunction for a collection from the Azure Cosmos DB service as an asynchronous operation. |
| ReadUserDefinedFunctionFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of user defined functions for a collection as an asynchronous operation from the Azure Cosmos DB service. |
| ReadUserFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of User for a database from the Azure Cosmos DB service as an asynchronous operation. |
| ReadUserFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of users for a database as an asynchronous operation from the Azure Cosmos DB service. |
| ReplaceAttachmentAsync(Attachment, RequestOptions, CancellationToken) |
Replaces a Attachment in the Azure Cosmos DB service as an asynchronous operation. |
| ReplaceAttachmentAsync(Uri, Attachment, RequestOptions, CancellationToken) |
Replaces an attachment as an asynchronous operation in the Azure Cosmos DB service. |
| ReplaceDocumentAsync(Document, RequestOptions, CancellationToken) |
Replaces a Document in the Azure Cosmos DB service as an asynchronous operation. |
| ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken) |
Replaces a Document in the Azure Cosmos DB service as an asynchronous operation. |
| ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken) |
Replaces a document as an asynchronous operation in the Azure Cosmos DB service. |
| ReplaceDocumentCollectionAsync(DocumentCollection, RequestOptions) |
Replaces a document collection in the Azure Cosmos DB service as an asynchronous operation. |
| ReplaceDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions) |
Replaces a document collection as an asynchronous operation in the Azure Cosmos DB service. |
| ReplaceOfferAsync(Offer) |
Replaces a Offer in the Azure Cosmos DB service as an asynchronous operation. |
| ReplacePermissionAsync(Permission, RequestOptions) |
Replaces a Permission in the Azure Cosmos DB service as an asynchronous operation. |
| ReplacePermissionAsync(Uri, Permission, RequestOptions) |
Replaces a permission as an asynchronous operation in the Azure Cosmos DB service. |
| ReplaceStoredProcedureAsync(StoredProcedure, RequestOptions) |
Replaces a StoredProcedure in the Azure Cosmos DB service as an asynchronous operation. |
| ReplaceStoredProcedureAsync(Uri, StoredProcedure, RequestOptions) |
Replace the specified stored procedure in the Azure Cosmos DB service. |
| ReplaceTriggerAsync(Trigger, RequestOptions) |
Replaces a Trigger in the Azure Cosmos DB service as an asynchronous operation. |
| ReplaceTriggerAsync(Uri, Trigger, RequestOptions) |
Replaces a trigger as an asynchronous operation in the Azure Cosmos DB service. |
| ReplaceUserAsync(Uri, User, RequestOptions) |
Replaces a user as an asynchronous operation in the Azure Cosmos DB service. |
| ReplaceUserAsync(User, RequestOptions) |
Replaces a User in the Azure Cosmos DB service as an asynchronous operation. |
| ReplaceUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions) |
Replaces a user defined function as an asynchronous operation in the Azure Cosmos DB service. |
| ReplaceUserDefinedFunctionAsync(UserDefinedFunction, RequestOptions) |
Replaces a UserDefinedFunction in the Azure Cosmos DB service as an asynchronous operation. |
| UpdateMediaAsync(String, Stream, MediaOptions, CancellationToken) |
Replaces the specified media's content as an asynchronous operation in the Azure Cosmos DB service. |
| UpsertAttachmentAsync(String, Object, RequestOptions, CancellationToken) |
Upserts an attachment as an asychronous operation in the Azure Cosmos DB service. |
| UpsertAttachmentAsync(String, Stream, MediaOptions, RequestOptions, CancellationToken) |
Upserts an Attachment with the contents of the provided |
| UpsertAttachmentAsync(Uri, Object, RequestOptions, CancellationToken) |
Upserts an attachment as an asynchronous operation in the Azure Cosmos DB service. |
| UpsertAttachmentAsync(Uri, Stream, MediaOptions, RequestOptions, CancellationToken) |
Upserts an attachment as an asynchronous operation in the Azure Cosmos DB service. |
| UpsertDocumentAsync(String, Object, RequestOptions, Boolean, CancellationToken) |
Upserts a Document as an asychronous operation in the Azure Cosmos DB service. |
| UpsertDocumentAsync(Uri, Object, RequestOptions, Boolean, CancellationToken) |
Upserts a document as an asynchronous operation in the Azure Cosmos DB service. |
| UpsertPermissionAsync(String, Permission, RequestOptions) |
Upserts a permission on a user object in the Azure Cosmos DB service as an asychronous operation. |
| UpsertPermissionAsync(Uri, Permission, RequestOptions) |
Upserts a permission as an asynchronous operation in the Azure Cosmos DB service. |
| UpsertStoredProcedureAsync(String, StoredProcedure, RequestOptions) |
Upserts a stored procedure as an asychronous operation in the Azure Cosmos DB service. |
| UpsertStoredProcedureAsync(Uri, StoredProcedure, RequestOptions) |
Upserts a stored procedure as an asynchronous operation in the Azure Cosmos DB service. |
| UpsertTriggerAsync(String, Trigger, RequestOptions) |
Upserts a trigger as an asychronous operation in the Azure Cosmos DB service. |
| UpsertTriggerAsync(Uri, Trigger, RequestOptions) |
Upserts a trigger as an asynchronous operation in the Azure Cosmos DB service. |
| UpsertUserAsync(String, User, RequestOptions) |
Upserts a permission on a user object in the Azure Cosmos DB service as an asychronous operation. |
| UpsertUserAsync(Uri, User, RequestOptions) |
Upserts a user as an asynchronous operation in the Azure Cosmos DB service. |
| UpsertUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions) |
Upserts a user defined function as an asychronous operation in the Azure Cosmos DB service. |
| UpsertUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions) |
Upserts a user defined function as an asynchronous operation in the Azure Cosmos DB service. |
