你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
DocumentClient.CreateDocumentCollectionAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
重载
CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions) |
在 Azure Cosmos DB 服务中将集合创建为异步操作。 |
CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions) |
在 Azure Cosmos DB 服务中将集合创建为异步操作。 |
CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions)
在 Azure Cosmos DB 服务中将集合创建为异步操作。
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionAsync (string databaseLink, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member CreateDocumentCollectionAsync : string * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.CreateDocumentCollectionAsync : string * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
Public Function CreateDocumentCollectionAsync (databaseLink As String, documentCollection As DocumentCollection, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))
参数
- databaseLink
- String
要创建集合的数据库的链接。 例如 dbs/db_rid/。
- documentCollection
- DocumentCollection
- options
- RequestOptions
(可选) 创建集合时要提供的任何 RequestOptions 选项。 例如,RequestOptions.OfferThroughput = 400。
返回
DocumentCollection创建的 包含在 表示异步操作的服务响应的 对象中Task。
实现
例外
databaseLink
如果未设置 或 documentCollection
。
表示异步处理期间发生的故障的合并。 在 InnerExceptions 中查找实际异常 () 。
此异常可以封装许多不同类型的错误。 若要确定特定错误,请始终查看 StatusCode 属性。 创建集合时可能会获取的一些常见代码包括:
StatusCode | 异常原因 |
---|---|
400 | BadRequest - 这意味着所提供的请求出现问题。 很可能没有为新集合提供 ID。 |
403 | 禁止 - 这意味着你尝试超过集合配额。 请联系支持人员以增加此配额。 |
409 | 冲突 - 这表示 DocumentCollection ID 与所提供的 ID 匹配的 已存在。 |
示例
using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
//Create a new collection with an OfferThroughput set to 10000
//Not passing in RequestOptions.OfferThroughput will result in a collection with the default OfferThroughput set.
DocumentCollection coll = await client.CreateDocumentCollectionAsync(databaseLink,
new DocumentCollection { Id = "My Collection" },
new RequestOptions { OfferThroughput = 10000} );
}
另请参阅
适用于
CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions)
在 Azure Cosmos DB 服务中将集合创建为异步操作。
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionAsync (Uri databaseUri, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member CreateDocumentCollectionAsync : Uri * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.CreateDocumentCollectionAsync : Uri * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
Public Function CreateDocumentCollectionAsync (databaseUri As Uri, documentCollection As DocumentCollection, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))
参数
- databaseUri
- Uri
要创建集合的数据库的 URI。
- documentCollection
- DocumentCollection
Microsoft.Azure.Documents.DocumentCollection 对象。
- options
- RequestOptions
请求的请求选项。
返回
表示异步操作的服务响应的任务对象。