DocumentClient.CreateDocumentCollectionAsync Método

Definição

Namespace:

Microsoft.Azure.Documents.Client

Assemblies:

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

Pacotes:

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

Sobrecargas

CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions)	Cria uma coleção como uma operação assíncrona no serviço do Azure Cosmos DB.
CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions)	Cria uma coleção como uma operação assíncrona no serviço do Azure Cosmos DB.

CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions)

Cria uma coleção como uma operação assíncrona no serviço do 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))

Parâmetros

databaseLink

String

O link do banco de dados no qual criar a coleção. Por exemplo, dbs/db_rid/.

documentCollection

DocumentCollection

O objeto DocumentCollection.

options

RequestOptions

(Opcional) Qualquer um RequestOptions que você deseje fornecer ao criar uma Coleção. Por exemplo, RequestOptions.OfferThroughput = 400.

Retornos

Task<ResourceResponse<DocumentCollection>>

O DocumentCollection que foi criado contido em um Task objeto que representa a resposta do serviço para a operação assíncrona.

Implementações

CreateDocumentCollectionAsync(String, DocumentCollection, RequestOptions)

Exceções

ArgumentNullException

Se ou databaseLinkdocumentCollection não estiver definido.

AggregateException

Representa uma consolidação de falhas que ocorreram durante o processamento assíncrono. Procure em InnerExceptions para localizar as exceções reais.

DocumentClientException

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar uma coleção são:

StatusCode	Motivo da exceção
400	BadRequest - Isso significa que algo estava errado com a solicitação fornecida. É provável que uma ID não tenha sido fornecida para a nova coleção.
403	Proibido – isso significa que você tentou exceder sua cota de coleções. Entre em contato com o suporte para aumentar essa cota.
409	Conflito – isso significa que um com uma DocumentCollection ID correspondente à ID que você forneceu já existia.

Exemplos

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} );
}

Confira também

• RequestOptions
• ResourceResponse<TResource>
• Task
• DocumentCollection
• OfferV2

CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions)

Cria uma coleção como uma operação assíncrona no serviço do 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))

Parâmetros

databaseUri

Uri

o URI do banco de dados no qual criar a coleção.

documentCollection

DocumentCollection

o objeto Microsoft.Azure.Documents.DocumentCollection.

options

RequestOptions

As opções de solicitação para a solicitação.

Retornos

Task<ResourceResponse<DocumentCollection>>

O objeto de tarefa que representa a resposta do serviço para a operação assíncrona.

Implementações

CreateDocumentCollectionAsync(Uri, DocumentCollection, RequestOptions)