IDocumentClient.CreateDocumentCollectionIfNotExistsAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Documents

Assemblys:

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

Paquets:

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

Surcharges

CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)	Crée (si n’existe pas) ou obtient (si elle existe déjà) une collection en tant qu’opération asychrone dans le service Azure Cosmos DB. Vous pouvez case activée le code status de la réponse pour déterminer si la collection a été créée récemment (201) ou si la collection existante a été retournée (200).
CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)	Crée (si n’existe pas) ou obtient (si elle existe déjà) une collection en tant qu’opération asychrone dans le service Azure Cosmos DB.

CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)

Crée (si n’existe pas) ou obtient (si elle existe déjà) une collection en tant qu’opération asychrone dans le service Azure Cosmos DB. Vous pouvez case activée le code status de la réponse pour déterminer si la collection a été créée récemment (201) ou si la collection existante a été retournée (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))

Paramètres

databaseLink

String

Lien de la base de données dans laquelle créer la collection. Par exemple, dbs/db_rid/.

documentCollection

DocumentCollection

Objet DocumentCollection.

options

RequestOptions

(Facultatif) Tous les éléments RequestOptions que vous souhaitez fournir lors de la création d’une collection. Par exemple, RequestOptions.OfferThroughput = 400.

Retours

Task<ResourceResponse<DocumentCollection>>

DocumentCollection qui a été créé dans un Task objet représentant la réponse du service pour l’opération asynchrone.

Exceptions

ArgumentNullException

Si ou databaseLinkdocumentCollection n’est pas défini.

AggregateException

Représente une consolidation des échecs qui se sont produits pendant le traitement asynchrone. Recherchez la ou les exceptions réelles dans InnerExceptions.

DocumentClientException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un DocumentCollection :

StatusCode	Raison de l’exception
400	BadRequest : cela signifie qu’un problème s’est produit avec la demande fournie. Il est probable qu’aucun ID n’a été fourni pour la nouvelle collection.
403	Interdit : cela signifie que vous avez tenté de dépasser votre quota pour les collections. Contactez le support technique pour augmenter ce quota.

Exemples

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

Voir aussi

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

CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)

Crée (si n’existe pas) ou obtient (si elle existe déjà) une collection en tant qu’opération asychrone dans le service 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))

Paramètres

databaseUri

Uri

URI de la base de données dans laquelle créer la collection.

documentCollection

DocumentCollection

Objet DocumentCollection.

options

RequestOptions

(Facultatif) Tous les éléments RequestOptions que vous souhaitez fournir lors de la création d’une collection. Par exemple, RequestOptions.OfferThroughput = 400.

Retours

Task<ResourceResponse<DocumentCollection>>

DocumentCollection qui a été créé dans un Task objet représentant la réponse du service pour l’opération asynchrone.