TransactionalBatch.PatchItem Method

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.45.0

Source:

TransactionalBatch.cs

Adds an operation to patch an item into the batch.

public abstract Microsoft.Azure.Cosmos.TransactionalBatch PatchItem (string id, System.Collections.Generic.IReadOnlyList<Microsoft.Azure.Cosmos.PatchOperation> patchOperations, Microsoft.Azure.Cosmos.TransactionalBatchPatchItemRequestOptions requestOptions = default);

abstract member PatchItem : string * System.Collections.Generic.IReadOnlyList<Microsoft.Azure.Cosmos.PatchOperation> * Microsoft.Azure.Cosmos.TransactionalBatchPatchItemRequestOptions -> Microsoft.Azure.Cosmos.TransactionalBatch

Public MustOverride Function PatchItem (id As String, patchOperations As IReadOnlyList(Of PatchOperation), Optional requestOptions As TransactionalBatchPatchItemRequestOptions = Nothing) As TransactionalBatch

Parameters

id

String

The unique id of the item.

patchOperations

IReadOnlyList<PatchOperation>

Represents a list of operations to be sequentially applied to the referred Cosmos item.

requestOptions

TransactionalBatchPatchItemRequestOptions

(Optional) The options for the item request.

Returns

TransactionalBatch

The transactional batch instance with the operation added.