IDocumentClient.CreateDocumentCollectionIfNotExistsAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.Documents

Ensamblados:

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

Paquetes:

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

Sobrecargas

CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)	Crea (si no existe) u obtiene (si ya existe) una colección como una operación asincrónica en el servicio Azure Cosmos DB. Puede comprobar el código de estado de la respuesta para determinar si la colección se creó recientemente (201) o se devolvió la colección existente (200).
CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)	Crea (si no existe) u obtiene (si ya existe) una colección como una operación asincrónica en el servicio Azure Cosmos DB.

CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)

Crea (si no existe) u obtiene (si ya existe) una colección como una operación asincrónica en el servicio Azure Cosmos DB. Puede comprobar el código de estado de la respuesta para determinar si la colección se creó recientemente (201) o se devolvió la colección existente (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

Vínculo de la base de datos en la que se va a crear la colección. Por ejemplo, dbs/db_rid/.

documentCollection

DocumentCollection

Objeto DocumentCollection.

options

RequestOptions

(Opcional) Cualquier RequestOptions elemento que desee proporcionar al crear una colección. Por ejemplo, RequestOptions.OfferThroughput = 400.

Devoluciones

Task<ResourceResponse<DocumentCollection>>

objeto DocumentCollection que se creó dentro de un Task objeto que representa la respuesta del servicio para la operación asincrónica.

Excepciones

ArgumentNullException

Si se establece o databaseLinkdocumentCollection no.

AggregateException

Representa una consolidación de errores que se produjeron durante el procesamiento asincrónico. Busque en InnerExceptions para buscar las excepciones reales.

DocumentClientException

Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear una DocumentCollection son:

StatusCode	Motivo de la excepción
400	BadRequest: esto significa que algo estaba mal con la solicitud proporcionada. Es probable que no se haya proporcionado un identificador para la nueva colección.
403	Prohibido: esto significa que intentó superar la cuota de las colecciones. Póngase en contacto con el soporte técnico para aumentar esta cuota.

Ejemplos

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

Consulte también

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

CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)

Crea (si no existe) u obtiene (si ya existe) una colección como una operación asincrónica en el servicio 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

el URI de la base de datos en el que se va a crear la colección.

documentCollection

DocumentCollection

Objeto DocumentCollection.

options

RequestOptions

(Opcional) Cualquier RequestOptions elemento que desee proporcionar al crear una colección. Por ejemplo, RequestOptions.OfferThroughput = 400.

Devoluciones

Task<ResourceResponse<DocumentCollection>>

objeto DocumentCollection que se creó dentro de un Task objeto que representa la respuesta del servicio para la operación asincrónica.