DocumentClient.DeleteDocumentCollectionAsync Method

Definition

Overloads

DeleteDocumentCollectionAsync(String, RequestOptions)

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

DeleteDocumentCollectionAsync(Uri, RequestOptions)

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

DeleteDocumentCollectionAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> DeleteDocumentCollectionAsync (string documentCollectionLink, Microsoft.Azure.Documents.Client.RequestOptions options = null);
Parameters
documentCollectionLink
String

The link of the Document to delete. E.g. dbs/db_rid/colls/col_rid/

options
RequestOptions

(Optional) The request options for the request.

Returns

A System.Threading.Tasks containing a ResourceResponse<TResource> which will contain information about the request issued.

Exceptions

If documentCollectionLink is not set.

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:

StatusCodeReason for exception
404NotFound - This means the resource you tried to delete did not exist.

DeleteDocumentCollectionAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> DeleteDocumentCollectionAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.RequestOptions options = null);
Parameters
documentCollectionUri
Uri

the URI of the document collection to delete.

options
RequestOptions

The request options for the request.

Returns

The task object representing the service response for the asynchronous operation.