Table of Contents

Class PatchItemRequestOptions

Namespace
Microsoft.Azure.Cosmos
Assembly
Microsoft.Azure.Cosmos.Client.dll

Cosmos Patch request options

public sealed class PatchItemRequestOptions : ItemRequestOptions
Inheritance
PatchItemRequestOptions
Inherited Members
Extension Methods

Constructors

PatchItemRequestOptions()

public PatchItemRequestOptions()

Properties

FilterPredicate

Gets or sets condition to be checked before the patch operations in the Azure Cosmos DB service.

public string FilterPredicate { get; set; }

Property Value

string

The condition to be checked before execution of operations.

Remarks

Condition can only be a from-clause of a sql statement. Creates a conditional SQL argument which is of format "FROM X where CONDITION", the condition has to be within the scope of the document which is supposed to be patched in the particular request. If the condition is satisfied the patch transaction will take place otherwise it will be returned with precondition failed.