DocumentClient.CreateDocumentAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| CreateDocumentAsync(String, Object, RequestOptions, Boolean, CancellationToken) |
Crea un documento como una operación asincrónica en el servicio Azure Cosmos DB. |
| CreateDocumentAsync(Uri, Object, RequestOptions, Boolean, CancellationToken) |
Crea un documento como una operación asincrónica en el servicio Azure Cosmos DB. |
CreateDocumentAsync(String, Object, RequestOptions, Boolean, CancellationToken)
Crea un documento 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.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))Parámetros
- documentsFeedOrDatabaseLink
- String
Vínculo del objeto en el que DocumentCollection se va a crear el documento. Por ejemplo, dbs/db_rid/colls/coll_rid/
- document
- Object
Objeto de documento que se va a crear.
- options
- RequestOptions
(Opcional) Cualquier opción de solicitud que desee establecer. Por ejemplo, especificar un desencadenador que se va a ejecutar al crear el documento. RequestOptions
- disableAutomaticIdGeneration
- Boolean
(Opcional) Deshabilita la generación automática de identificadores, si es True, el sistema producirá una excepción si falta la propiedad id del documento.
- cancellationToken
- CancellationToken
(Opcional) que CancellationToken pueden ser utilizados por otros objetos o subprocesos para recibir aviso de cancelación.
Devoluciones
objeto Document que se creó dentro de un Task objeto que representa la respuesta del servicio para la operación asincrónica.
Implementaciones
Excepciones
Si se establece o documentsFeedOrDatabaseLinkdocument no.
Representa una consolidación de errores que se produjeron durante el procesamiento asincrónico. Busque en InnerExceptions para buscar las excepciones reales.
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 un documento son:
| StatusCode | Motivo de la excepción |
|---|---|
| 400 | BadRequest: esto significa que algo estaba mal con el documento proporcionado. Es probable que disableAutomaticIdGeneration sea true y no se proporcionó un identificador. |
| 403 | Prohibido: esto probablemente significa que la colección en la que estaba intentando crear el documento está llena. |
| 409 | Conflicto: esto significa que un Document elemento con un identificador que coincide con el campo id de document ya existe. |
| 413 | RequestEntityTooLarge: esto significa que Document supera el tamaño máximo de entidad actual. Consulte la documentación para conocer los límites y las cuotas. |
| 429 | TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación. |
Ejemplos
Azure Cosmos DB admite varias maneras diferentes de trabajar con documentos. Un documento puede extenderse 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 documento puede ser cualquier objeto POCO que se pueda serializar en JSON, incluso si no se extiende desde 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" });
}
Por último, un documento también puede ser un objeto dinámico.
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" } );
}
Crear un documento y ejecutar un desencadenador previo y posterior
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" }
});
}
Consulte también
Se aplica a
CreateDocumentAsync(Uri, Object, RequestOptions, Boolean, CancellationToken)
Crea un documento 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.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))Parámetros
- documentCollectionUri
- Uri
el URI de la colección de documentos en el que se va a crear el documento.
- document
- Object
el objeto de documento.
- options
- RequestOptions
Opciones de solicitud para la solicitud.
- disableAutomaticIdGeneration
- Boolean
Deshabilita la generación automática de identificadores, producirá una excepción si falta el identificador.
- cancellationToken
- CancellationToken
(Opcional) CancellationToken que representa la cancelación de la solicitud.
Devoluciones
Objeto de tarea que representa la respuesta del servicio para la operación asincrónica.
Implementaciones
Se aplica a
Azure SDK for .NET
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de