ItemRequestOptions Class

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

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

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: ItemRequestOptions.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.

Cosmos item request options

public class ItemRequestOptions : Microsoft.Azure.Cosmos.RequestOptions

type ItemRequestOptions = class
    inherit RequestOptions

Public Class ItemRequestOptions
Inherits RequestOptions

Inheritance: Object

RequestOptions
ItemRequestOptions

Derived: Microsoft.Azure.Cosmos.PatchItemRequestOptions

Constructors

ItemRequestOptions()

Properties

AddRequestHeaders	Gets or sets a delegate which injects/appends a custom header in the request. (Inherited from RequestOptions)
ConsistencyLevel	Gets or sets the consistency level required for the request in the Azure Cosmos DB service.
CosmosThresholdOptions	Threshold values for Distributed Tracing. These values decides whether to generate operation level EventSource with request diagnostics or not. (Inherited from RequestOptions)
DedicatedGatewayRequestOptions	Gets or sets the DedicatedGatewayRequestOptions for requests against the dedicated gateway. These options are only exercised when ConnectionMode is set to ConnectionMode.Gateway and the dedicated gateway endpoint is used for sending requests.
EnableContentResponseOnWrite	Gets or sets the boolean to only return the headers and status code in the Cosmos DB response for write item operation like Create, Upsert, Patch and Replace. Setting the option to false will cause the response to have a null resource. This reduces networking and CPU load by not sending the resource back over the network and serializing it on the client.
ExcludeRegions	List of regions to be excluded routing the request to. This can be used to route a request to a specific region by excluding all other regions. If all regions are excluded, then the request will be routed to the primary/hub region. (Inherited from RequestOptions)
IfMatchEtag	Gets or sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. (Inherited from RequestOptions)
IfNoneMatchEtag	Gets or sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. (Inherited from RequestOptions)
IndexingDirective	Gets or sets the indexing directive (Include or Exclude) for the request in the Azure Cosmos DB service.
PostTriggers	Gets or sets the trigger to be invoked after the operation in the Azure Cosmos DB service.
PreTriggers	Gets or sets the trigger to be invoked before the operation in the Azure Cosmos DB service.
PriorityLevel	Gets or sets the priority level for a request. (Inherited from RequestOptions)
Properties	Application opted Cosmos request context that flow through with the RequestMessage. Context will be available through handlers. (Inherited from RequestOptions)
SessionToken	Gets or sets the token for use with session consistency in the Azure Cosmos DB service.

Methods

ShallowCopy()

Clone RequestOptions.

(Inherited from RequestOptions)

Applies to

Dela via