Share via

IChangeFeedDocumentClient.DeleteDocumentAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents.ChangeFeedProcessor.DataAccess
Assembly:
Microsoft.Azure.Documents.ChangeFeedProcessor.dll
Package:
Microsoft.Azure.DocumentDB.ChangeFeedProcessor v2.4.0

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.IResourceResponse<Microsoft.Azure.Documents.Document>> DeleteDocumentAsync(Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.IResourceResponse<Microsoft.Azure.Documents.Document>>
Public Function DeleteDocumentAsync (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IResourceResponse(Of Document))

Parameters

documentUri
Uri

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

options
RequestOptions

The RequestOptionsfor this request.

cancellationToken
CancellationToken

A CancellationTokenthat can be used by other objects or threads to receive notice of cancellation.

Returns

Task<IResourceResponse<Document>>

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

Applies to