你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
IDocumentClient.DeleteDocumentCollectionAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
重载
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>>
Public Function DeleteDocumentCollectionAsync (documentCollectionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))
参数
- options
- RequestOptions
(可选) 请求的请求选项。
返回
一 System.Threading.Tasks 个 , ResourceResponse<TResource> 它包含有关发出的请求的信息。
例外
如果未 documentCollectionLink
设置 。
此异常可以封装许多不同类型的错误。 若要确定特定错误,请始终查看 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);
另请参阅
适用于
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>>
Public Function DeleteDocumentCollectionAsync (documentCollectionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))
参数
- documentCollectionUri
- Uri
要删除的文档集合的 URI。
- options
- RequestOptions
(可选的) RequestOptions 请求的 。
返回
表示异步操作的服务响应的任务对象。