Container.PatchItemStreamAsync メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.39.0

ソース:

Container.cs

非同期操作として Azure Cosmos サービス内の項目にパッチを適用します。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage> PatchItemStreamAsync (string id, Microsoft.Azure.Cosmos.PartitionKey partitionKey, System.Collections.Generic.IReadOnlyList<Microsoft.Azure.Cosmos.PatchOperation> patchOperations, Microsoft.Azure.Cosmos.PatchItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PatchItemStreamAsync : string * Microsoft.Azure.Cosmos.PartitionKey * System.Collections.Generic.IReadOnlyList<Microsoft.Azure.Cosmos.PatchOperation> * Microsoft.Azure.Cosmos.PatchItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>

Public MustOverride Function PatchItemStreamAsync (id As String, partitionKey As PartitionKey, patchOperations As IReadOnlyList(Of PatchOperation), Optional requestOptions As PatchItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)

パラメーター

id

String

Cosmos アイテム ID

partitionKey

PartitionKey

項目のパーティション キー。

patchOperations

IReadOnlyList<PatchOperation>

参照される Cosmos アイテムに順次適用される操作の一覧を表します。

requestOptions

PatchItemRequestOptions

(省略可能)アイテム要求のオプション。

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<ResponseMessage>

Task修正プログラムが適用されたリソース レコードをResponseMessage含む をStreamラップする を含む 。

例

PatchItemAsync<T>(String, PartitionKey, IReadOnlyList<PatchOperation>, PatchItemRequestOptions, CancellationToken)

注釈

項目のパーティション キー値は変更できません。 項目のパーティション キー値を変更するには、元の項目を削除し、新しい項目を挿入する必要があります。 パッチ操作はアトミックであり、順番に実行されます。 既定では、リソース本文は応答の一部として返されます。 ユーザーは、フラグを false に設定 EnableContentResponseOnWrite することで、コンテンツを要求できません。