RequestOptions interface

Csomag:

@azure/cosmos

Az Azure Cosmos DB-kiszolgálóknak kiadott kért szolgáltatásokhoz megadható beállítások.=

Extends

SharedOptions

Tulajdonságok

accessCondition	A kérelemhez társított feltételek.
contentResponseOnWriteEnabled	Ha hamis értékre van állítva, a szolgáltatás nem ad vissza hasznos adatokat a válaszban. Csökkenti a hálózatot és a CPU-terhelést azáltal, hogy nem küldi vissza a hasznos adatokat a hálózaton keresztül. Az alapértelmezett érték igaz. MEGJEGYZÉS: Jelenleg ez a beállítás csak tömeges és kötegelt műveletek esetén támogatott.
disableAutomaticIdGeneration	Az automatikus azonosítólétrehozás letiltása (a létrehozás sikertelen lesz, ha az azonosító nem szerepel a definícióban)
enableScriptLogging	Engedélyezi vagy letiltja a naplózást a JavaScript által tárolt eljárásokban.
indexingDirective	Indexelési irányelveket határoz meg (indexelés, nem indexelés stb.).
offerThroughput	Egy tárolóhoz kiosztott ajánlat átviteli sebessége a Requests-per-Unit mértékegységben.
offerType	Ajánlat típusa dokumentumtárolók létrehozásakor. Ez a beállítás csak dokumentumtároló létrehozásakor érvényes.
populateQuotaInfo	Engedélyezi/letiltja a dokumentumtárolók kvótával kapcsolatos statisztikáinak lekérését a dokumentumtároló olvasási kérelmeihez.
postTriggerInclude	Azt jelzi, hogy mi az a post trigger, amelyet a művelet után meg kell hívni.
preTriggerInclude	A művelet előtt meghívandó eseményindítót jelzi.
resourceTokenExpirySeconds	Az engedélyhez társított erőforrás-jogkivonat lejárati ideje (másodpercben) (csak az engedélykérésekre vonatkozik).
urlConnection	(Speciális használati eset) A csatlakozáshoz használt URL-cím.

Örökölt tulajdonságok

abortSignal	abortSignal a metódushívás által létrehozott összes mögöttes hálózati kérésnek való továbbításhoz. Lásd: https://developer.mozilla.org/en-US/docs/Web/API/AbortController példa Olvasási kérelem lemondása 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, });
bypassIntegratedCache	Beállítja, ha az integrált gyorsítótárat ki kell kerülni vagy engedélyezni kell a kéréshez az Azure CosmosDB szolgáltatásban. Az alapértelmezett érték hamis. Alapértelmezés szerint az integrált gyorsítótár engedélyezve van
consistencyLevel	Az ügyfél által megkövetelt konzisztenciaszint.
disableRUPerMinuteUsage	A DisableRUPerMinuteUsage a kérelemegységek (kérelemegységek)/perc kapacitás engedélyezésére/letiltására szolgál a kérés kiszolgálásához, ha a rendszeres kiosztott kérelemegységek/másodpercek kimerültek.
excludedLocations	Kizár egy vagy több Azure-régiót a művelethez. Ez a beállítás csak akkor van alkalmazva, ha az enableEndPointDiscovery true (igaz) értékre van állítva.
initialHeaders	(Speciális használati eset) Első fejlécek a Cosmosnak küldött kérések esetén
maxIntegratedCacheStalenessInMs	Beállítja a kéréshez társított elavultsági értéket az Azure CosmosDB szolgáltatásban. Az olyan kérések esetében, amelyekben a <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> vagy <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, az integrált gyorsítótárból érkező válaszok garantáltan nem lesznek elavultak, mint a maxIntegratedCacheStaleness által jelzett érték. Ha a konzisztenciaszint nincs beállítva, a rendszer figyelmen kívül hagyja ezt a tulajdonságot. Az alapértelmezett érték null A gyorsítótár elavultsága ezredmásodpercben támogatott. A rendszer figyelmen kívül hagyja az ezredmásodpercnél kisebbeket.
priorityLevel	Prioritási szint (alacsony/magas) minden kéréshez. Az alacsony prioritású kérelmek mindig szabályozva vannak a magas prioritású kérések előtt. Az alapértelmezett érték null. Alapértelmezés szerint minden kérés magas prioritású
sessionToken	Engedélyezi/letiltja a dokumentumtárolók kvótával kapcsolatos statisztikáinak lekérését a dokumentumtároló olvasási kérelmeihez.
throughputBucket	Átviteli sebesség gyűjtő egy kérelemhez. Az alapértelmezett érték null. Ebben az esetben a kérés a partíció átviteli sebességének 100% át használhatja. További információ: [Cosmos DB átviteli sebesség gyűjtő](https://aka.ms/cosmsodb-bucketing).

Tulajdonság adatai

accessCondition

A kérelemhez társított feltételek.

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

Tulajdonság értéke

{ condition: string, type: string }

contentResponseOnWriteEnabled

Ha hamis értékre van állítva, a szolgáltatás nem ad vissza hasznos adatokat a válaszban. Csökkenti a hálózatot és a CPU-terhelést azáltal, hogy nem küldi vissza a hasznos adatokat a hálózaton keresztül. Az alapértelmezett érték igaz.

MEGJEGYZÉS: Jelenleg ez a beállítás csak tömeges és kötegelt műveletek esetén támogatott.

contentResponseOnWriteEnabled?: boolean

Tulajdonság értéke

boolean

disableAutomaticIdGeneration

Az automatikus azonosítólétrehozás letiltása (a létrehozás sikertelen lesz, ha az azonosító nem szerepel a definícióban)

disableAutomaticIdGeneration?: boolean

Tulajdonság értéke

boolean

enableScriptLogging

Engedélyezi vagy letiltja a naplózást a JavaScript által tárolt eljárásokban.

enableScriptLogging?: boolean

Tulajdonság értéke

boolean

indexingDirective

Indexelési irányelveket határoz meg (indexelés, nem indexelés stb.).

indexingDirective?: string

Tulajdonság értéke

string

offerThroughput

Egy tárolóhoz kiosztott ajánlat átviteli sebessége a Requests-per-Unit mértékegységben.

offerThroughput?: number

Tulajdonság értéke

number

offerType

Ajánlat típusa dokumentumtárolók létrehozásakor.

Ez a beállítás csak dokumentumtároló létrehozásakor érvényes.

offerType?: string

Tulajdonság értéke

string

populateQuotaInfo

Engedélyezi/letiltja a dokumentumtárolók kvótával kapcsolatos statisztikáinak lekérését a dokumentumtároló olvasási kérelmeihez.

populateQuotaInfo?: boolean

Tulajdonság értéke

boolean

postTriggerInclude

Azt jelzi, hogy mi az a post trigger, amelyet a művelet után meg kell hívni.

postTriggerInclude?: string | string[]

Tulajdonság értéke

string | string[]

preTriggerInclude

A művelet előtt meghívandó eseményindítót jelzi.

preTriggerInclude?: string | string[]

Tulajdonság értéke

string | string[]

resourceTokenExpirySeconds

Az engedélyhez társított erőforrás-jogkivonat lejárati ideje (másodpercben) (csak az engedélykérésekre vonatkozik).

resourceTokenExpirySeconds?: number

Tulajdonság értéke

number

urlConnection

(Speciális használati eset) A csatlakozáshoz használt URL-cím.

urlConnection?: string

Tulajdonság értéke

string

Örökölt tulajdonság részletei

abortSignal

abortSignal a metódushívás által létrehozott összes mögöttes hálózati kérésnek való továbbításhoz. Lásd: https://developer.mozilla.org/en-US/docs/Web/API/AbortController

példa

Olvasási kérelem lemondása

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

Tulajdonság értéke

AbortSignal

ÖrököltSharedOptions.abortSignal

bypassIntegratedCache

Beállítja, ha az integrált gyorsítótárat ki kell kerülni vagy engedélyezni kell a kéréshez az Azure CosmosDB szolgáltatásban.

Az alapértelmezett érték hamis. Alapértelmezés szerint az integrált gyorsítótár engedélyezve van

bypassIntegratedCache?: boolean

Tulajdonság értéke

boolean

ÖrököltSharedOptions.bypassIntegratedCache

consistencyLevel

Az ügyfél által megkövetelt konzisztenciaszint.

consistencyLevel?: string

Tulajdonság értéke

string

A SharedOptions.consistencyLevelwebhelyről örökölt

disableRUPerMinuteUsage

A DisableRUPerMinuteUsage a kérelemegységek (kérelemegységek)/perc kapacitás engedélyezésére/letiltására szolgál a kérés kiszolgálásához, ha a rendszeres kiosztott kérelemegységek/másodpercek kimerültek.

disableRUPerMinuteUsage?: boolean

Tulajdonság értéke

boolean

A SharedOptions.disableRUPerMinuteUsagewebhelyről örökölt

excludedLocations

Kizár egy vagy több Azure-régiót a művelethez.

Ez a beállítás csak akkor van alkalmazva, ha az enableEndPointDiscovery true (igaz) értékre van állítva.

excludedLocations?: string[]

Tulajdonság értéke

string[]

A SharedOptions.excludedLocationswebhelyről örökölt

initialHeaders

(Speciális használati eset) Első fejlécek a Cosmosnak küldött kérések esetén

initialHeaders?: CosmosHeaders

Tulajdonság értéke

CosmosHeaders

ÖrököltSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Beállítja a kéréshez társított elavultsági értéket az Azure CosmosDB szolgáltatásban. Az olyan kérések esetében, amelyekben a <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> vagy <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, az integrált gyorsítótárból érkező válaszok garantáltan nem lesznek elavultak, mint a maxIntegratedCacheStaleness által jelzett érték. Ha a konzisztenciaszint nincs beállítva, a rendszer figyelmen kívül hagyja ezt a tulajdonságot.

Az alapértelmezett érték null

A gyorsítótár elavultsága ezredmásodpercben támogatott. A rendszer figyelmen kívül hagyja az ezredmásodpercnél kisebbeket.

maxIntegratedCacheStalenessInMs?: number

Tulajdonság értéke

number

SharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Prioritási szint (alacsony/magas) minden kéréshez. Az alacsony prioritású kérelmek mindig szabályozva vannak a magas prioritású kérések előtt.

Az alapértelmezett érték null. Alapértelmezés szerint minden kérés magas prioritású

priorityLevel?: PriorityLevel

Tulajdonság értéke

PriorityLevel

ÖrököltSharedOptions.priorityLevel

sessionToken

Engedélyezi/letiltja a dokumentumtárolók kvótával kapcsolatos statisztikáinak lekérését a dokumentumtároló olvasási kérelmeihez.

sessionToken?: string

Tulajdonság értéke

string

ÖrököltSharedOptions.sessionToken

throughputBucket

Átviteli sebesség gyűjtő egy kérelemhez.

Az alapértelmezett érték null. Ebben az esetben a kérés a partíció átviteli sebességének 100% át használhatja.

További információ: [Cosmos DB átviteli sebesség gyűjtő](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Tulajdonság értéke

number

A SharedOptions.throughputBucketwebhelyről örökölt