DocumentClient.ReplaceDocumentAsync 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
ReplaceDocumentAsync(Document, RequestOptions, CancellationToken) |
Remplace un Document dans le service Azure Cosmos DB en tant qu’opération asynchrone. |
ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken) |
Remplace un Document dans le service Azure Cosmos DB en tant qu’opération asynchrone. |
ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken) |
Remplace un document en tant qu’opération asynchrone dans le service Azure Cosmos DB. |
ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)
Remplace un Document dans le service Azure Cosmos DB en tant qu’opération asynchrone.
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))
Paramètres
- options
- RequestOptions
(Facultatif) Options de demande pour la demande.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.
Retours
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Document contenant l’enregistrement de ressource mis à jour.
Implémente
Exceptions
Si document
n’est pas défini.
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 |
---|---|
404 | NotFound : cela signifie que la ressource que vous avez tenté de supprimer n’existait pas. |
Exemples
Cet exemple utilise Document et tire parti du fait qu’il s’agit d’un objet dynamique et utilise SetProperty pour mettre à jour dynamiquement les propriétés du document
//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);
Voir aussi
S’applique à
ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)
Remplace un Document dans le service Azure Cosmos DB en tant qu’opération asynchrone.
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))
Paramètres
- documentLink
- String
Lien du document à mettre à jour. Par exemple, dbs/db_rid/colls/col_rid/docs/doc_rid/
- options
- RequestOptions
(Facultatif) Options de demande pour la demande.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.
Retours
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Document contenant l’enregistrement de ressource mis à jour.
Implémente
Exceptions
Si ou documentLink
document
n’est pas défini.
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 |
---|---|
404 | NotFound : cela signifie que la ressource que vous avez tenté de supprimer n’existait pas. |
Exemples
Dans cet exemple, au lieu d’utiliser un fortement typé Document, nous allons travailler avec notre propre objet POCO et ne pas nous appuyer sur la nature dynamique de la classe 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);
Voir aussi
S’applique à
ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)
Remplace un document en tant qu’opération asynchrone dans le service 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))
Paramètres
- documentUri
- Uri
URI du document à mettre à jour.
- document
- Object
le document mis à jour.
- options
- RequestOptions
Options de demande pour la demande.
- 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