DocumentClient.CreateDocumentAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| CreateDocumentAsync(String, Object, RequestOptions, Boolean, CancellationToken) |
Crée un document en tant qu’opération asychrone dans le service Azure Cosmos DB. |
| CreateDocumentAsync(Uri, Object, RequestOptions, Boolean, CancellationToken) |
Crée un document en tant qu’opération asychrone dans le service Azure Cosmos DB. |
CreateDocumentAsync(String, Object, RequestOptions, Boolean, CancellationToken)
Crée un document 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.Document>> CreateDocumentAsync (string documentsFeedOrDatabaseLink, object document, Microsoft.Azure.Documents.Client.RequestOptions options = default, bool disableAutomaticIdGeneration = false, System.Threading.CancellationToken cancellationToken = default);abstract member CreateDocumentAsync : string * obj * Microsoft.Azure.Documents.Client.RequestOptions * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.CreateDocumentAsync : string * obj * Microsoft.Azure.Documents.Client.RequestOptions * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function CreateDocumentAsync (documentsFeedOrDatabaseLink As String, document As Object, Optional options As RequestOptions = Nothing, Optional disableAutomaticIdGeneration As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Paramètres
- documentsFeedOrDatabaseLink
- String
Lien du DocumentCollection dans lequel créer le document. Par exemple, dbs/db_rid/colls/coll_rid/
- document
- Object
Objet document à créer.
- options
- RequestOptions
(Facultatif) Toutes les options de demande que vous souhaitez définir. Par exemple, spécification d’un déclencheur à exécuter lors de la création du document. RequestOptions
- disableAutomaticIdGeneration
- Boolean
(Facultatif) Désactive la génération automatique de l’id. Si cette valeur est True, le système lève une exception si la propriété id est manquante dans le document.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.
Retours
Document qui a été créé dans un Task objet représentant la réponse du service pour l’opération asynchrone.
Implémente
Exceptions
Si ou documentsFeedOrDatabaseLinkdocument n’est pas défini.
Représente une consolidation des échecs qui se sont produits pendant le traitement asynchrone. Recherchez la ou les exceptions réelles dans InnerExceptions
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 document :
| StatusCode | Raison de l’exception |
|---|---|
| 400 | BadRequest : cela signifie qu’il y a eu un problème avec le document fourni. Il est probable que c’était vrai et qu’un disableAutomaticIdGeneration ID n’a pas été fourni |
| 403 | Interdit : cela signifie probablement que la collection dans laquelle vous essayez de créer le document est complète. |
| 409 | Conflit : cela signifie qu’un Document avec un ID correspondant au champ id de document déjà existant |
| 413 | RequestEntityTooLarge : cela signifie que dépasse la Document taille maximale d’entité actuelle. Consultez la documentation pour connaître les limites et les quotas. |
| 429 | TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour savoir combien de temps vous devez attendre avant de réessayer cette opération. |
Exemples
Azure Cosmos DB prend en charge différentes façons d’utiliser des documents. Un document peut être étendu Resource
public class MyObject : Resource
{
public string MyProperty {get; set;}
}
using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
Document doc = await client.CreateDocumentAsync("dbs/db_rid/colls/coll_rid/", new MyObject { MyProperty = "A Value" });
}
Un document peut être n’importe quel objet POCO qui peut être sérialisé au format JSON, même s’il ne s’étend pas à partir de Resource
public class MyPOCO
{
public string MyProperty {get; set;}
}
using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
Document doc = await client.CreateDocumentAsync("dbs/db_rid/colls/coll_rid/", new MyPOCO { MyProperty = "A Value" });
}
Enfin, un document peut également être un objet dynamique
using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
Document doc = await client.CreateDocumentAsync("dbs/db_rid/colls/coll_rid/", new { SomeProperty = "A Value" } );
}
Créer un document et exécuter un pré-déclencheur et un post-déclencheur
using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
Document doc = await client.CreateDocumentAsync(
"dbs/db_rid/colls/coll_rid/",
new { id = "DOC123213443" },
new RequestOptions
{
PreTriggerInclude = new List<string> { "MyPreTrigger" },
PostTriggerInclude = new List<string> { "MyPostTrigger" }
});
}
Voir aussi
S’applique à
CreateDocumentAsync(Uri, Object, RequestOptions, Boolean, CancellationToken)
Crée un document 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.Document>> CreateDocumentAsync (Uri documentCollectionUri, object document, Microsoft.Azure.Documents.Client.RequestOptions options = default, bool disableAutomaticIdGeneration = false, System.Threading.CancellationToken cancellationToken = default);abstract member CreateDocumentAsync : Uri * obj * Microsoft.Azure.Documents.Client.RequestOptions * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.CreateDocumentAsync : Uri * obj * Microsoft.Azure.Documents.Client.RequestOptions * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function CreateDocumentAsync (documentCollectionUri As Uri, document As Object, Optional options As RequestOptions = Nothing, Optional disableAutomaticIdGeneration As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Paramètres
- documentCollectionUri
- Uri
URI de la collection de documents dans laquelle créer le document.
- document
- Object
objet document.
- options
- RequestOptions
Options de demande pour la demande.
- disableAutomaticIdGeneration
- Boolean
Désactive la génération automatique de l’ID, lève une exception si l’ID est manquant.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken représentant l’annulation de la demande.
Retours
Objet de tâche représentant la réponse du service pour l’opération asynchrone.
Implémente
S’applique à
Azure SDK for .NET