IDocumentClient.ReplaceDocumentAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ReplaceDocumentAsync(Document, RequestOptions, CancellationToken) |
Document Azure Cosmos DB サービスの を非同期操作として置き換えます。 |
| ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken) |
Document Azure Cosmos DB サービスの を非同期操作として置き換えます。 |
| ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken) |
ドキュメントを Azure Cosmos DB サービスの非同期操作として置き換えます。 |
ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)
Document Azure Cosmos DB サービスの を非同期操作として置き換えます。
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>>Public Function ReplaceDocumentAsync (document As Document, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))パラメーター
- options
- RequestOptions
(省略可能)要求の要求オプション。
- cancellationToken
- CancellationToken
(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドで使用できる 。
戻り値
System.Threading.Tasks更新されたリソース レコードをResourceResponse<TResource>含む をDocumentラップする を含む 。
例外
が設定されていない場合 document 。
この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。
| StatusCode | 例外の理由 |
|---|---|
| 404 | NotFound - 削除しようとしたリソースが存在しなかったことを意味します。 |
例
この例では、 を使用 Document し、動的オブジェクトであり、SetProperty を使用してドキュメントのプロパティを動的に更新するという事実を利用しています
//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);
こちらもご覧ください
適用対象
ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)
Document Azure Cosmos DB サービスの を非同期操作として置き換えます。
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>>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))パラメーター
- documentLink
- String
更新するドキュメントのリンク。 例: dbs/db_rid/colls/col_rid/docs/doc_rid/
- options
- RequestOptions
(省略可能)要求の要求オプション。
- cancellationToken
- CancellationToken
(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドで使用できる 。
戻り値
System.Threading.Tasks更新されたリソース レコードをResourceResponse<TResource>含む をDocumentラップする を含む 。
例外
または document がdocumentLink設定されていない場合。
この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。
| StatusCode | 例外の理由 |
|---|---|
| 404 | NotFound - 削除しようとしたリソースが存在しなかったことを意味します。 |
例
この例では、厳密に型指定された Documentを使用する代わりに、独自の POCO オブジェクトを操作し、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);
こちらもご覧ください
適用対象
ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)
ドキュメントを 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>>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))パラメーター
- documentUri
- Uri
更新するドキュメントの URI。
- document
- Object
更新されたドキュメント。
- options
- RequestOptions
(省略可能) RequestOptions 要求の 。
- cancellationToken
- CancellationToken
(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドで使用できる 。
戻り値
非同期操作のサービス応答を表すタスク オブジェクト。
適用対象
Azure SDK for .NET