RequestOptions interface

Conditions Associated with the request.

accessCondition?: { condition: string, type: string }

Property Value

If set to false, service doesn't return payload in the response. It reduces networking and CPU load by not sending the payload back over the network. Default value is true.

NOTE: Currently, this option is only supported for bulk and batch operations.

contentResponseOnWriteEnabled?: boolean

Property Value

Disable automatic id generation (will cause creates to fail if id isn't on the definition)

disableAutomaticIdGeneration?: boolean

Property Value

Enables or disables logging in JavaScript stored procedures.

enableScriptLogging?: boolean

Property Value

Specifies indexing directives (index, do not index .. etc).

indexingDirective?: string

Property Value

The offer throughput provisioned for a container in measurement of Requests-per-Unit.

offerThroughput?: number

Property Value

Offer type when creating document containers.

This option is only valid when creating a document container.

offerType?: string

Property Value

Enables/disables getting document container quota related stats for document container read requests.

populateQuotaInfo?: boolean

Property Value

Indicates what is the post trigger to be invoked after the operation.

postTriggerInclude?: string | string[]

Property Value

Indicates what is the pre trigger to be invoked before the operation.

preTriggerInclude?: string | string[]

Property Value

Expiry time (in seconds) for resource token associated with permission (applicable only for requests on permissions).

resourceTokenExpirySeconds?: number

Property Value

(Advanced use case) The url to connect to.

urlConnection?: string

Property Value

abortSignal to pass to all underlying network requests created by this method call. See https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Example

Cancel a read request

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

Property Value

Inherited From SharedOptions.abortSignal

Sets if integrated cache should be bypassed or enabled for the request in Azure CosmosDB service.

Default value is false. By default integrated cache is enabled

bypassIntegratedCache?: boolean

Property Value

Inherited From SharedOptions.bypassIntegratedCache

Consistency level required by the client.

consistencyLevel?: string

Property Value

Inherited From SharedOptions.consistencyLevel

DisableRUPerMinuteUsage is used to enable/disable Request Units(RUs)/minute capacity to serve the request if regular provisioned RUs/second is exhausted.

disableRUPerMinuteUsage?: boolean

Property Value

Inherited From SharedOptions.disableRUPerMinuteUsage

Excludes one or more Azure regions for the operation.

This option is only applied when enableEndPointDiscovery is set to true.

excludedLocations?: string[]

Property Value

Inherited From SharedOptions.excludedLocations

(Advanced use case) Initial headers to start with when sending requests to Cosmos

initialHeaders?: CosmosHeaders

Property Value

Inherited From SharedOptions.initialHeaders

Sets the staleness value associated with the request in the Azure CosmosDB service. For requests where the <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> or <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, responses from the integrated cache are guaranteed to be no staler than value indicated by this maxIntegratedCacheStaleness. When the consistency level is not set, this property is ignored.

Default value is null

Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.

maxIntegratedCacheStalenessInMs?: number

Property Value

Inherited From SharedOptions.maxIntegratedCacheStalenessInMs

Priority Level (Low/High) for each request. Low priority requests are always throttled before any high priority requests.

Default value is null. By default all requests are of High priority

priorityLevel?: PriorityLevel

Property Value

Inherited From SharedOptions.priorityLevel

Enables/disables getting document container quota related stats for document container read requests.

sessionToken?: string

Property Value

Inherited From SharedOptions.sessionToken

Throughput Bucket for a request.

Default value is null. In this case, the request can use 100% of the partition throughput.

For more information, visit [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Property Value

Inherited From SharedOptions.throughputBucket