IDocumentClient.CreateDocumentCollectionIfNotExistsAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions) |
Cria (se não existir) ou obtém (se já existir) uma coleção como uma operação assíncrona no serviço do Azure Cosmos DB. Você pode marcar o código status da resposta para determinar se a coleção foi criada recentemente (201) ou se a coleção existente foi retornada (200). |
| CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions) |
Cria (se não existir) ou obtém (se já existir) uma coleção como uma operação assíncrona no serviço do Azure Cosmos DB. |
CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)
Cria (se não existir) ou obtém (se já existir) uma coleção como uma operação assíncrona no serviço do Azure Cosmos DB. Você pode marcar o código status da resposta para determinar se a coleção foi criada recentemente (201) ou se a coleção existente foi retornada (200).
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionIfNotExistsAsync (string databaseLink, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member CreateDocumentCollectionIfNotExistsAsync : 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 CreateDocumentCollectionIfNotExistsAsync (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ê queira fornecer ao criar uma Coleção. Por exemplo, RequestOptions.OfferThroughput = 400.
Retornos
O DocumentCollection que foi criado contido em um Task objeto que representa a resposta de serviço para a operação assíncrona.
Exceções
Se ou databaseLinkdocumentCollection não estiver definido.
Representa uma consolidação de falhas que ocorreram durante o processamento assíncrono. Procure em InnerExceptions para encontrar as exceções reais.
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 um DocumentCollection 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. |
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.CreateDocumentCollectionIfNotExistsAsync(databaseLink,
new DocumentCollection { Id = "My Collection" },
new RequestOptions { OfferThroughput = 10000} );
}
Confira também
Aplica-se a
CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)
Cria (se não existir) ou obtém (se já existir) 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>> CreateDocumentCollectionIfNotExistsAsync (Uri databaseUri, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member CreateDocumentCollectionIfNotExistsAsync : 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 CreateDocumentCollectionIfNotExistsAsync (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 DocumentCollection.
- options
- RequestOptions
(Opcional) Qualquer um RequestOptions que você queira fornecer ao criar uma Coleção. Por exemplo, RequestOptions.OfferThroughput = 400.
Retornos
O DocumentCollection que foi criado contido em um Task objeto que representa a resposta de serviço para a operação assíncrona.
Aplica-se a
Azure SDK for .NET