DocumentClient.ReplaceDocumentAsync Methode

Definition

Namespace:

Microsoft.Azure.Documents.Client

Assemblys:

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

Pakete:

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

Überlädt

ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)	Ersetzt ein Document im Azure Cosmos DB-Dienst als asynchroner Vorgang.
ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)	Ersetzt ein Document im Azure Cosmos DB-Dienst als asynchroner Vorgang.
ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)	Ersetzt ein Dokument als asynchroner Vorgang im Azure Cosmos DB-Dienst.

ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)

Ersetzt ein Document im Azure Cosmos DB-Dienst als asynchroner Vorgang.

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

Parameter

document

Document

Die wurde aktualisiert Document , um die vorhandene Ressource durch zu ersetzen.

options

RequestOptions

(Optional) Die Anforderungsoptionen für die Anforderung.

cancellationToken

CancellationToken

(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.

Gibt zurück

Task<ResourceResponse<Document>>

Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält, das einen Document umschließt, der den aktualisierten Ressourcendatensatz enthält.

Implementiert

ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)

Ausnahmen

ArgumentNullException

Wenn document nicht festgelegt ist.

DocumentClientException

Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten, sind:

StatusCode	Ausnahmegrund
404	NotFound– Dies bedeutet, dass die Ressource, die Sie löschen möchten, nicht vorhanden war.

Beispiele

Dieses Beispiel verwendet Document und nutzt die Tatsache, dass es sich um ein dynamisches Objekt handelt, und verwendet SetProperty, um Eigenschaften für das Dokument dynamisch zu aktualisieren.

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

Weitere Informationen

• Document
• RequestOptions
• ResourceResponse<TResource>
• Task

ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)

Ersetzt ein Document im Azure Cosmos DB-Dienst als asynchroner Vorgang.

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

Parameter

documentLink

String

Der Link des zu aktualisierenden Dokuments. Beispiel: dbs/db_rid/colls/col_rid/docs/doc_rid/

document

Object

Die wurde aktualisiert Document , um die vorhandene Ressource durch zu ersetzen.

options

RequestOptions

(Optional) Die Anforderungsoptionen für die Anforderung.

cancellationToken

CancellationToken

(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.

Gibt zurück

Task<ResourceResponse<Document>>

Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält, das einen Document umschließt, der den aktualisierten Ressourcendatensatz enthält.

Implementiert

ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)

Ausnahmen

ArgumentNullException

Wenn entweder documentLink oder document nicht festgelegt ist.

DocumentClientException

Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten, sind:

StatusCode	Ausnahmegrund
404	NotFound– Dies bedeutet, dass die Ressource, die Sie löschen möchten, nicht vorhanden war.

Beispiele

In diesem Beispiel arbeiten wir nicht mit einem stark typisierten Document, sondern mit unserem eigenen POCO-Objekt und verlassen uns nicht auf die dynamische Natur der Document-Klasse.

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

Weitere Informationen

• Document
• RequestOptions
• ResourceResponse<TResource>
• Task

ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)

Ersetzt ein Dokument als asynchroner Vorgang im Azure Cosmos DB-Dienst.

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

Parameter

documentUri

Uri

der URI des zu aktualisierenden Dokuments.

document

Object

das aktualisierte Dokument.

options

RequestOptions

Die Anforderungsoptionen für die Anforderung.

cancellationToken

CancellationToken

(Optional) CancellationToken stellt die Anforderungsabbruch dar.

Gibt zurück

Task<ResourceResponse<Document>>

Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)