RequestOptions.PriorityLevel Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.39.0
Source:
RequestOptions.cs

Gets or sets the priority level for a request.

public Microsoft.Azure.Cosmos.PriorityLevel? PriorityLevel { get; set; }
member this.PriorityLevel : Nullable<Microsoft.Azure.Cosmos.PriorityLevel> with get, set
Public Property PriorityLevel As Nullable(Of PriorityLevel)

Property Value

Nullable<PriorityLevel>

Remarks

Setting priority level only has an effect if Priority Based Execution is enabled. If it is not enabled, the priority level is ignored by the backend. If AllowBulkExecution is set to true on CosmosClient, priority level set in RequestOptions is ignored. Default PriorityLevel for each request is treated as High. It can be explicitly set to Low for some requests. When Priority based execution is enabled, if there are more requests than the configured RU/S in a second, then Cosmos DB will throttle low priority requests to allow high priority requests to execute. This does not limit the throughput available to each priority level. Each priority level can consume the complete provisioned throughput in absence of the other. If both priorities are present and the user goes above the configured RU/s, low priority requests start getting throttled first to allow execution of mission critical workloads.

Applies to