TransactionalBatch.ReplaceItem<T> Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: TransactionalBatch.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds an operation to replace an item into the batch.

public abstract Microsoft.Azure.Cosmos.TransactionalBatch ReplaceItem<T> (string id, T item, Microsoft.Azure.Cosmos.TransactionalBatchItemRequestOptions requestOptions = default);

abstract member ReplaceItem : string * 'T * Microsoft.Azure.Cosmos.TransactionalBatchItemRequestOptions -> Microsoft.Azure.Cosmos.TransactionalBatch

Public MustOverride Function ReplaceItem(Of T) (id As String, item As T, Optional requestOptions As TransactionalBatchItemRequestOptions = Nothing) As TransactionalBatch

Type Parameters

T

The type of item to be created.

Parameters

id: String

The unique id of the item.

item: T

A JSON serializable object that must contain an id property. See CosmosSerializer to implement a custom serializer.

requestOptions: TransactionalBatchItemRequestOptions

(Optional) The options for the item request.

Returns

TransactionalBatch

The transactional batch instance with the operation added.

Applies to