RequestOptions interface

  • Referens
Paket:
@azure/cosmos

Alternativ som kan anges för en begärd som utfärdats till Azure Cosmos DB-servrarna.=

Extends
SharedOptions

Egenskaper

accessCondition

Villkor som är associerade med begäran.
consistencyLevel

Konsekvensnivå som krävs av klienten.
disableAutomaticIdGeneration

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

DisableRUPerMinuteUsage används för att aktivera/inaktivera enheter för programbegäran(RU:er)/minutkapacitet för att hantera begäran om vanliga etablerade RU:er/sekund är slut.
enableScriptLogging

Aktiverar eller inaktiverar loggning i JavaScript-lagrade procedurer.
indexingDirective

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

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

Erbjudandetyp när du skapar dokumentcontainrar.

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

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

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

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

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

(Avancerat användningsfall) URL:en som du vill ansluta till.

Ärvda egenskaper

abortSignal

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

Avbryta en läsbegäran

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()
initialHeaders

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

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 föråldrade än det värde som anges av denna 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.
priorityLevel

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

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

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

Egenskapsinformation

accessCondition

Villkor som är associerade med begäran.

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

Egenskapsvärde

{ condition: string, type: string }

consistencyLevel

Konsekvensnivå som krävs av klienten.

consistencyLevel?: string

Egenskapsvärde

string

disableAutomaticIdGeneration

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

disableAutomaticIdGeneration?: boolean

Egenskapsvärde

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage används för att aktivera/inaktivera enheter för programbegäran(RU:er)/minutkapacitet för att hantera begäran om vanliga etablerade RU:er/sekund är slut.

disableRUPerMinuteUsage?: boolean

Egenskapsvärde

boolean

enableScriptLogging

Aktiverar eller inaktiverar loggning i JavaScript-lagrade procedurer.

enableScriptLogging?: boolean

Egenskapsvärde

boolean

indexingDirective

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

indexingDirective?: string

Egenskapsvärde

string

offerThroughput

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

offerThroughput?: number

Egenskapsvärde

number

offerType

Erbjudandetyp när du skapar dokumentcontainrar.

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

offerType?: string

Egenskapsvärde

string

populateQuotaInfo

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

populateQuotaInfo?: boolean

Egenskapsvärde

boolean

postTriggerInclude

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

postTriggerInclude?: string | string[]

Egenskapsvärde

string | string[]

preTriggerInclude

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

preTriggerInclude?: string | string[]

Egenskapsvärde

string | string[]

resourceTokenExpirySeconds

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

number

urlConnection

(Avancerat användningsfall) URL:en som du vill ansluta till.

urlConnection?: string

Egenskapsvärde

string

Information om ärvda egenskaper

abortSignal

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

Avbryta en läsbegäran

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

abortSignal?: AbortSignal

Egenskapsvärde

AbortSignal

Ärvd frånSharedOptions.abortSignal

initialHeaders

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

initialHeaders?: CosmosHeaders

Egenskapsvärde

CosmosHeaders

Ärvd frånSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

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 föråldrade än det värde som anges av denna 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

number

Ärvd frånSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

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

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

priorityLevel?: PriorityLevel

Egenskapsvärde

PriorityLevel

Ärvd frånSharedOptions.priorityLevel

sessionToken

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

sessionToken?: string

Egenskapsvärde

string

Ärvd frånSharedOptions.sessionToken