RequestOptions interface

Villkor som är associerade med begäran.

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

Egenskapsvärde

Om värdet är falskt returnerar tjänsten inte nyttolasten i svaret. Det minskar nätverks- och CPU-belastningen genom att inte skicka tillbaka nyttolasten över nätverket. Standardvärdet är sant.

OBS: För närvarande stöds det här alternativet endast för bulk- och batchåtgärder.

contentResponseOnWriteEnabled?: boolean

Egenskapsvärde

Inaktivera automatisk ID-generering (leder till att skaparen misslyckas om ID inte finns i definitionen)

disableAutomaticIdGeneration?: boolean

Egenskapsvärde

Aktiverar eller inaktiverar loggning i JavaScript-lagrade procedurer.

enableScriptLogging?: boolean

Egenskapsvärde

Anger indexeringsdirektiv (index, indexera inte .. osv.).

indexingDirective?: string

Egenskapsvärde

Erbjudandets dataflöde har etablerats för en container i mätning av Begäranden per enhet.

offerThroughput?: number

Egenskapsvärde

Erbjudandetyp när du skapar dokumentcontainrar.

Det här alternativet är endast giltigt när du skapar en dokumentcontainer.

offerType?: string

Egenskapsvärde

Aktiverar/inaktiverar hämtar dokumentcontainerkvotrelaterad statistik för läsbegäranden för dokumentcontainer.

populateQuotaInfo?: boolean

Egenskapsvärde

Anger vilken postutlösare som ska anropas efter åtgärden.

postTriggerInclude?: string | string[]

Egenskapsvärde

Anger vad som är den förutlösare som ska anropas före åtgärden.

preTriggerInclude?: string | string[]

Egenskapsvärde

Förfallotid (i sekunder) för resurstoken som är associerad med behörighet (gäller endast för begäranden om behörigheter).

resourceTokenExpirySeconds?: number

Egenskapsvärde

(Avancerat användningsfall) Url:en som ska anslutas till.

urlConnection?: string

Egenskapsvärde

abortSignal för att skicka till alla underliggande nätverksbegäranden som skapats av det här metodanropet. Se https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exempel

Avbryt en läsbegäran

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

Egenskapsvärde

ärvd frånSharedOptions.abortSignal

Anger om integrerad cache ska kringgås eller aktiveras för begäran i Azure CosmosDB-tjänsten.

Standardvärdet är falskt. Som standard är integrerad cache aktiverad

bypassIntegratedCache?: boolean

Egenskapsvärde

ärvd frånSharedOptions.bypassIntegratedCache

Konsekvensnivå som krävs av klienten.

consistencyLevel?: string

Egenskapsvärde

Ärvd frånSharedOptions.consistencyLevel

DisableRUPerMinuteUsage används för att aktivera/inaktivera kapacitet för begärandeenheter/minutkapacitet för att hantera begäran om regelbundna etablerade RU:er/sekund är slut.

disableRUPerMinuteUsage?: boolean

Egenskapsvärde

Ärvd frånSharedOptions.disableRUPerMinuteUsage

Exkluderar en eller flera Azure-regioner för åtgärden.

Det här alternativet tillämpas endast när enableEndPointDiscovery är inställt på true.

excludedLocations?: string[]

Egenskapsvärde

Ärvd frånSharedOptions.excludedLocations

(Avancerat användningsfall) Inledande rubriker att börja med när begäranden skickas till Cosmos

initialHeaders?: CosmosHeaders

Egenskapsvärde

ärvs frånSharedOptions.initialHeaders

Anger det föråldringsvärde som är associerat med begäran i Azure CosmosDB-tjänsten. För begäranden där <xref:com.azure.cosmos.ConsistencyLevel> är <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> eller <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>är svaren från den integrerade cachen garanterat inte inaktuella än det värde som anges av den här maxIntegratedCacheStaleness. När konsekvensnivån inte har angetts ignoreras den här egenskapen.

Standardvärdet är null

Cacheföråldring stöds i millisekunders kornighet. Allt som är mindre än millisekunder ignoreras.

maxIntegratedCacheStalenessInMs?: number

Egenskapsvärde

ärvd frånSharedOptions.maxIntegratedCacheStalenessInMs

Prioritetsnivå (låg/hög) för varje begäran. Begäranden med låg prioritet begränsas alltid före alla begäranden med hög prioritet.

Standardvärdet är null. Som standard har alla begäranden hög prioritet

priorityLevel?: PriorityLevel

Egenskapsvärde

ärvs frånSharedOptions.priorityLevel

Aktiverar/inaktiverar hämtar dokumentcontainerkvotrelaterad statistik för läsbegäranden för dokumentcontainer.

sessionToken?: string

Egenskapsvärde

ärvd frånSharedOptions.sessionToken

Dataflödesbucket för en begäran.

Standardvärdet är null. I det här fallet kan begäran använda 100% av partitionens dataflöde.

Mer information finns i [Cosmos DB dataput Bucketing](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Egenskapsvärde

Ärvd frånSharedOptions.throughputBucket