你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

IDocumentClient.DeleteDocumentAsync 方法

定义

重载

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)

在 Azure Cosmos DB 服务中以异步操作的形式删除文档。

DeleteDocumentAsync(String, RequestOptions, CancellationToken)

Document以异步操作的形式从 Azure Cosmos DB 服务中删除 。

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)

在 Azure Cosmos DB 服务中以异步操作的形式删除文档。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<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.ResourceResponse<Microsoft.Azure.Documents.Document>>
Public Function DeleteDocumentAsync (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

参数

documentUri
Uri

要删除的文档的 URI。

options
RequestOptions

(可选的) RequestOptions 请求的 。

cancellationToken
CancellationToken

(可选) A CancellationToken ,可供其他对象或线程用来接收取消通知。

返回

表示异步操作的服务响应的任务对象。

适用于

DeleteDocumentAsync(String, RequestOptions, CancellationToken)

Document以异步操作的形式从 Azure Cosmos DB 服务中删除 。

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

参数

documentLink
String

要删除的 的链接 Document 。 例如 dbs/db_rid/colls/col_rid/docs/doc_rid/

options
RequestOptions

(可选) 请求的请求选项。

cancellationToken
CancellationToken

(可选) A CancellationToken ,可供其他对象或线程用来接收取消通知。

返回

System.Threading.Tasks 个 , ResourceResponse<TResource> 它包含有关发出的请求的信息。

例外

如果未 documentLink 设置 。

此异常可以封装许多不同类型的错误。 若要确定特定错误,请始终查看 StatusCode 属性。 创建文档时可能会获取的一些常见代码包括:

StatusCode异常原因
404NotFound - 这意味着你尝试删除的资源不存在。

示例

//Delete a document using its selfLink property
//To get the documentLink you would have to query for the Document, using CreateDocumentQuery(),  and then refer to its .SelfLink property
await client.DeleteDocumentAsync(documentLink);

另请参阅

适用于