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

DocumentClient.DeleteDocumentCollectionAsync 方法

定义

命名空间:

Microsoft.Azure.Documents.Client

程序集:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

包:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

重载

DeleteDocumentCollectionAsync(String, RequestOptions)	DocumentCollection从 Azure Cosmos DB 服务中删除 作为异步操作。
DeleteDocumentCollectionAsync(Uri, RequestOptions)	从 Azure Cosmos DB 服务中删除作为异步操作的集合。

DeleteDocumentCollectionAsync(String, RequestOptions)

DocumentCollection从 Azure Cosmos DB 服务中删除 作为异步操作。

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

abstract member DeleteDocumentCollectionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.DeleteDocumentCollectionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>

Public Function DeleteDocumentCollectionAsync (documentCollectionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

参数

documentCollectionLink

String

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

options

RequestOptions

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

返回

Task<ResourceResponse<DocumentCollection>>

一个 System.Threading.TasksResourceResponse<TResource> ，它包含有关发出的请求的信息。

实现

DeleteDocumentCollectionAsync(String, RequestOptions)

例外

ArgumentNullException

如果未 documentCollectionLink 设置 。

DocumentClientException

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

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

示例

//Delete a collection using its selfLink property
//To get the collectionLink you would have to query for the Collection, using CreateDocumentCollectionQuery(),  and then refer to its .SelfLink property
await client.DeleteDocumentCollectionAsync(collectionLink);

另请参阅

• DocumentCollection
• RequestOptions
• ResourceResponse<TResource>
• Task

DeleteDocumentCollectionAsync(Uri, RequestOptions)

从 Azure Cosmos DB 服务中删除作为异步操作的集合。

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

abstract member DeleteDocumentCollectionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.DeleteDocumentCollectionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>

Public Function DeleteDocumentCollectionAsync (documentCollectionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

参数

documentCollectionUri

Uri

要删除的文档集合的 URI。

options

RequestOptions

请求的请求选项。

返回

Task<ResourceResponse<DocumentCollection>>

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

实现

DeleteDocumentCollectionAsync(Uri, RequestOptions)