TransactionalBatch.DeleteItem Method

  • Reference

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 delete an item into the batch.

public abstract Microsoft.Azure.Cosmos.TransactionalBatch DeleteItem (string id, Microsoft.Azure.Cosmos.TransactionalBatchItemRequestOptions requestOptions = default);
abstract member DeleteItem : string * Microsoft.Azure.Cosmos.TransactionalBatchItemRequestOptions -> Microsoft.Azure.Cosmos.TransactionalBatch
Public MustOverride Function DeleteItem (id As String, Optional requestOptions As TransactionalBatchItemRequestOptions = Nothing) As TransactionalBatch

Parameters

id
String

The unique id of the item.

requestOptions
TransactionalBatchItemRequestOptions

(Optional) The options for the item request.

Returns

TransactionalBatch

The transactional batch instance with the operation added.

Applies to