DocumentClient.ReplaceDocumentAsync Método

Referencia

Definición

Espacio de nombres:: Microsoft.Azure.Documents.Client

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

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

ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)	Reemplaza un Document objeto en el servicio Azure Cosmos DB como una operación asincrónica.
ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)	Reemplaza un Document objeto en el servicio Azure Cosmos DB como una operación asincrónica.
ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)	Reemplaza un documento como una operación asincrónica en el servicio Azure Cosmos DB.

ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)

Reemplaza un Document objeto en el servicio Azure Cosmos DB como una operación asincrónica.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReplaceDocumentAsync (Microsoft.Azure.Documents.Document document, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReplaceDocumentAsync : Microsoft.Azure.Documents.Document * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReplaceDocumentAsync : Microsoft.Azure.Documents.Document * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>

Public Function ReplaceDocumentAsync (document As Document, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

Parámetros

document: Document

Actualizado Document por el que se va a reemplazar el recurso existente.

options: RequestOptions

(Opcional) Opciones de solicitud para la solicitud.

cancellationToken: CancellationToken

(Opcional) que CancellationToken pueden ser utilizados por otros objetos o subprocesos para recibir aviso de cancelación.

Devoluciones

Task<ResourceResponse<Document>>

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene Document el registro de recursos actualizado.

Implementaciones

ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)

Excepciones

ArgumentNullException

Si document no se establece.

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 un documento son:

StatusCode	Motivo de la excepción
404	NotFound: significa que el recurso que intentó eliminar no existía.

Ejemplos

En este ejemplo se usa y se aprovecha Document el hecho de que es un objeto dinámico y usa SetProperty para actualizar dinámicamente las propiedades del documento

//Fetch the Document to be updated
Document doc = client.CreateDocumentQuery<Document>(collectionLink)
                            .Where(r => r.Id == "doc id")
                            .AsEnumerable()
                            .SingleOrDefault();

//Update some properties on the found resource
doc.SetPropertyValue("MyProperty", "updated value");

//Now persist these changes to the database by replacing the original resource
Document updated = await client.ReplaceDocumentAsync(doc);

Consulte también

Se aplica a

ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)

Reemplaza un Document objeto en el servicio Azure Cosmos DB como una operación asincrónica.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReplaceDocumentAsync (string documentLink, object document, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReplaceDocumentAsync : string * obj * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReplaceDocumentAsync : string * obj * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>

Public Function ReplaceDocumentAsync (documentLink As String, document As Object, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

Parámetros

documentLink: String

Vínculo del documento que se va a actualizar. Por ejemplo, dbs/db_rid/colls/col_rid/docs/doc_rid/

document: Object

Actualizado Document por el que se va a reemplazar el recurso existente.

options: RequestOptions

(Opcional) Opciones de solicitud para la solicitud.

cancellationToken: CancellationToken

(Opcional) que CancellationToken pueden ser utilizados por otros objetos o subprocesos para recibir aviso de cancelación.

Devoluciones

Task<ResourceResponse<Document>>

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene Document el registro de recursos actualizado.

Implementaciones

ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)

Excepciones

ArgumentNullException

Si se establece o documentLinkdocument no.

DocumentClientException

StatusCode	Motivo de la excepción
404	NotFound: significa que el recurso que intentó eliminar no existía.

Ejemplos

En este ejemplo, en lugar de usar un fuertemente tipado Document, trabajaremos con nuestro propio objeto POCO y no confiaremos en la naturaleza dinámica de la clase Document.

public class MyPoco
{
    public string Id {get; set;}
    public string MyProperty {get; set;}
}

//Get the doc back as a Document so you have access to doc.SelfLink
Document doc = client.CreateDocumentQuery<Document>(collectionLink)
                       .Where(r => r.Id == "doc id")
                       .AsEnumerable()
                       .SingleOrDefault();

//Now dynamically cast doc back to your MyPoco
MyPoco poco = (dynamic)doc;

//Update some properties of the poco object
poco.MyProperty = "updated value";

//Now persist these changes to the database using doc.SelLink and the update poco object
Document updated = await client.ReplaceDocumentAsync(doc.SelfLink, poco);

Consulte también

Se aplica a

ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)

Reemplaza 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>> ReplaceDocumentAsync (Uri documentUri, object document, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReplaceDocumentAsync : Uri * obj * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReplaceDocumentAsync : Uri * obj * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>

Public Function ReplaceDocumentAsync (documentUri As Uri, document As Object, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

Parámetros

documentUri: Uri

el URI del documento que se va a actualizar.

document: Object

el documento actualizado.

options: RequestOptions

Opciones de solicitud para la solicitud.

cancellationToken: CancellationToken

(Opcional) CancellationToken que representa la cancelación de la solicitud.

Devoluciones

Task<ResourceResponse<Document>>

Objeto de tarea que representa la respuesta del servicio para la operación asincrónica.

Implementaciones

ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)

Se aplica a

DocumentClient.ReplaceDocumentAsync Método

Definición

Sobrecargas

ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)

Parámetros

Devoluciones

Implementaciones

Excepciones

Ejemplos

Consulte también

Se aplica a

ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)

Parámetros

Devoluciones

Implementaciones

Excepciones

Ejemplos

Consulte también

Se aplica a

ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)

Parámetros

Devoluciones

Implementaciones

Se aplica a

Comentarios

Recursos adicionales