RequestOptions interface

Pakket:

@azure/cosmos

Opties die kunnen worden opgegeven voor een aangevraagde die is uitgegeven aan de Azure Cosmos DB-servers.=

Extends

SharedOptions

Eigenschappen

accessCondition	Voorwaarden die zijn gekoppeld aan de aanvraag.
consistencyLevel	Consistentieniveau vereist door de client.
disableAutomaticIdGeneration	Schakel het automatisch genereren van id's uit (zorgt ervoor dat het maken mislukt als de id niet op de definitie staat)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage wordt gebruikt om aanvraageenheden (RU's)/minuutcapaciteit in te schakelen/uit te schakelen voor het verwerken van de aanvraag als de reguliere ingerichte RU's/seconde is uitgeput.
enableScriptLogging	Hiermee schakelt u logboekregistratie in opgeslagen JavaScript-procedures in of uit.
indexingDirective	Hiermee geeft u indexeringsrichtlijnen op (index, niet indexeren enz.).
offerThroughput	De aanbiedingsdoorvoer die is ingericht voor een container bij het meten van Aanvragen per eenheid.
offerType	Type aanbieding bij het maken van documentcontainers. Deze optie is alleen geldig bij het maken van een documentcontainer.
populateQuotaInfo	Hiermee schakelt u het ophalen van statistieken over het quotum voor documentcontainers in of uit voor leesaanvragen voor documentcontainers.
postTriggerInclude	Hiermee wordt aangegeven wat de trigger is die na de bewerking moet worden aangeroepen.
preTriggerInclude	Hiermee wordt aangegeven wat de trigger vooraf is die vóór de bewerking moet worden aangeroepen.
resourceTokenExpirySeconds	Verlooptijd (in seconden) voor resourcetoken dat is gekoppeld aan machtiging (alleen van toepassing op aanvragen voor machtigingen).
urlConnection	(Geavanceerde use-case) De URL waarmee u verbinding wilt maken.

Overgenomen eigenschappen

abortSignal	abortSignal om door te geven aan alle onderliggende netwerkaanvragen die door deze methodeaanroep zijn gemaakt. Zie https://developer.mozilla.org/en-US/docs/Web/API/AbortController Voorbeeld Een leesaanvraag annuleren const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
initialHeaders	(Geavanceerde use-case) Eerste headers om mee te beginnen bij het verzenden van aanvragen naar Cosmos
maxIntegratedCacheStalenessInMs	Hiermee stelt u de staleness-waarde in die is gekoppeld aan de aanvraag in de Azure CosmosDB-service. Voor aanvragen waarbij de <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> of <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, worden antwoorden van de geïntegreerde cache gegarandeerd niet verlopen dan de waarde aangegeven door deze maxIntegratedCacheStaleness. Wanneer het consistentieniveau niet is ingesteld, wordt deze eigenschap genegeerd. Standaardwaarde is null Cache Staleness wordt ondersteund in milliseconden granulariteit. Alles wat kleiner is dan milliseconden wordt genegeerd.
priorityLevel	Prioriteitsniveau (laag/hoog) voor elke aanvraag. Aanvragen met een lage prioriteit worden altijd beperkt vóór aanvragen met hoge prioriteit. De standaardwaarde is null. Standaard hebben alle aanvragen een hoge prioriteit
sessionToken	Hiermee schakelt u het ophalen van statistieken over het quotum voor documentcontainers in of uit voor leesaanvragen voor documentcontainers.

Eigenschapdetails

accessCondition

Voorwaarden die zijn gekoppeld aan de aanvraag.

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

Waarde van eigenschap

{ condition: string, type: string }

consistencyLevel

Consistentieniveau vereist door de client.

consistencyLevel?: string

Waarde van eigenschap

string

disableAutomaticIdGeneration

Schakel het automatisch genereren van id's uit (zorgt ervoor dat het maken mislukt als de id niet op de definitie staat)

disableAutomaticIdGeneration?: boolean

Waarde van eigenschap

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage wordt gebruikt om aanvraageenheden (RU's)/minuutcapaciteit in te schakelen/uit te schakelen voor het verwerken van de aanvraag als de reguliere ingerichte RU's/seconde is uitgeput.

disableRUPerMinuteUsage?: boolean

Waarde van eigenschap

boolean

enableScriptLogging

Hiermee schakelt u logboekregistratie in opgeslagen JavaScript-procedures in of uit.

enableScriptLogging?: boolean

Waarde van eigenschap

boolean

indexingDirective

Hiermee geeft u indexeringsrichtlijnen op (index, niet indexeren enz.).

indexingDirective?: string

Waarde van eigenschap

string

offerThroughput

De aanbiedingsdoorvoer die is ingericht voor een container bij het meten van Aanvragen per eenheid.

offerThroughput?: number

Waarde van eigenschap

number

offerType

Type aanbieding bij het maken van documentcontainers.

Deze optie is alleen geldig bij het maken van een documentcontainer.

offerType?: string

Waarde van eigenschap

string

populateQuotaInfo

Hiermee schakelt u het ophalen van statistieken over het quotum voor documentcontainers in of uit voor leesaanvragen voor documentcontainers.

populateQuotaInfo?: boolean

Waarde van eigenschap

boolean

postTriggerInclude

Hiermee wordt aangegeven wat de trigger is die na de bewerking moet worden aangeroepen.

postTriggerInclude?: string | string[]

Waarde van eigenschap

string | string[]

preTriggerInclude

Hiermee wordt aangegeven wat de trigger vooraf is die vóór de bewerking moet worden aangeroepen.

preTriggerInclude?: string | string[]

Waarde van eigenschap

string | string[]

resourceTokenExpirySeconds

Verlooptijd (in seconden) voor resourcetoken dat is gekoppeld aan machtiging (alleen van toepassing op aanvragen voor machtigingen).

resourceTokenExpirySeconds?: number

Waarde van eigenschap

number

urlConnection

(Geavanceerde use-case) De URL waarmee u verbinding wilt maken.

urlConnection?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

abortSignal

abortSignal om door te geven aan alle onderliggende netwerkaanvragen die door deze methodeaanroep zijn gemaakt. Zie https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Voorbeeld

Een leesaanvraag annuleren

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

abortSignal?: AbortSignal

Waarde van eigenschap

AbortSignal

Overgenomen vanSharedOptions.abortSignal

initialHeaders

(Geavanceerde use-case) Eerste headers om mee te beginnen bij het verzenden van aanvragen naar Cosmos

initialHeaders?: CosmosHeaders

Waarde van eigenschap

CosmosHeaders

Overgenomen vanSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Hiermee stelt u de staleness-waarde in die is gekoppeld aan de aanvraag in de Azure CosmosDB-service. Voor aanvragen waarbij de <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> of <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, worden antwoorden van de geïntegreerde cache gegarandeerd niet verlopen dan de waarde aangegeven door deze maxIntegratedCacheStaleness. Wanneer het consistentieniveau niet is ingesteld, wordt deze eigenschap genegeerd.

Standaardwaarde is null

Cache Staleness wordt ondersteund in milliseconden granulariteit. Alles wat kleiner is dan milliseconden wordt genegeerd.

maxIntegratedCacheStalenessInMs?: number

Waarde van eigenschap

number

Overgenomen vanSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Prioriteitsniveau (laag/hoog) voor elke aanvraag. Aanvragen met een lage prioriteit worden altijd beperkt vóór aanvragen met hoge prioriteit.

De standaardwaarde is null. Standaard hebben alle aanvragen een hoge prioriteit

priorityLevel?: PriorityLevel

Waarde van eigenschap

PriorityLevel

Overgenomen vanSharedOptions.priorityLevel

sessionToken

Hiermee schakelt u het ophalen van statistieken over het quotum voor documentcontainers in of uit voor leesaanvragen voor documentcontainers.

sessionToken?: string

Waarde van eigenschap

string

Overgenomen vanSharedOptions.sessionToken