RequestOptions interface

Paket:

@azure/cosmos

Optionen, die für eine angeforderte Ausgabe für die Azure Cosmos DB-Server angegeben werden können.=

Extends

SharedOptions

Eigenschaften

accessCondition	Bedingungen, die der Anforderung zugeordnet sind.
consistencyLevel	Vom Client erforderliche Konsistenzebene.
disableAutomaticIdGeneration	Deaktivieren der automatischen ID-Generierung (führt dazu, dass die Erstellung fehlschlägt, wenn die ID nicht in der Definition enthalten ist)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage wird verwendet, um Anforderungseinheiten(RUs)/Minutenkapazität zu aktivieren/zu deaktivieren, um die Anforderung zu bedienen, wenn die regulären bereitgestellten RUs/Sekunde erschöpft sind.
enableScriptLogging	Aktiviert oder deaktiviert die Protokollierung in gespeicherten JavaScript-Prozeduren.
indexingDirective	Gibt Indizierungsdirektiven an (Index, nicht indizieren usw.).
offerThroughput	Der Angebotsdurchsatz, der für einen Container in der Messung von Anforderungen pro Einheit bereitgestellt wird.
offerType	Angebotstyp beim Erstellen von Dokumentcontainern. Diese Option ist nur beim Erstellen eines Dokumentcontainers gültig.
populateQuotaInfo	Aktiviert/deaktiviert das Abrufen von Dokumentcontainerkontingentstatistiken für Dokumentcontainer-Leseanforderungen.
postTriggerInclude	Gibt an, was der Posttrigger ist, der nach dem Vorgang aufgerufen werden soll.
preTriggerInclude	Gibt an, welcher Prätrigger vor dem Vorgang aufgerufen werden soll.
resourceTokenExpirySeconds	Ablaufzeit (in Sekunden) für Ressourcentoken, das der Berechtigung zugeordnet ist (gilt nur für Anforderungen für Berechtigungen).
urlConnection	(Erweiterter Anwendungsfall) Die URL, mit der eine Verbindung hergestellt werden soll.

Geerbte Eigenschaften

abortSignal	abortSignal, um an alle zugrunde liegenden Netzwerkanforderungen zu übergeben, die durch diesen Methodenaufruf erstellt wurden. Siehe https://developer.mozilla.org/en-US/docs/Web/API/AbortController. Beispiel Abbrechen einer Leseanforderung const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
initialHeaders	(Erweiterter Anwendungsfall) Anfangsheader beim Senden von Anforderungen an Cosmos
maxIntegratedCacheStalenessInMs	Legt den Wert der Veraltung fest, der der Anforderung im Azure CosmosDB-Dienst zugeordnet ist. Für Anforderungen, bei denen oder <xref:com.azure.cosmos.ConsistencyLevel> ist, werden <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL><xref:com.azure.cosmos.ConsistencyLevel%23SESSION>Antworten aus dem integrierten Cache garantiert nicht staler als der wert sein, der von dieser maxIntegratedCacheStaleness angegeben wird. Wenn die Konsistenzebene nicht festgelegt ist, wird diese Eigenschaft ignoriert. Der Standardwert ist NULL. Cache-Staleness wird in Millisekunden granular unterstützt. Alles, was kleiner als Millisekunden ist, wird ignoriert.
priorityLevel	Prioritätsebene (Niedrig/Hoch) für jede Anforderung. Anforderungen mit niedriger Priorität werden immer vor Anforderungen mit hoher Priorität gedrosselt. Der Standardwert ist null. Standardmäßig haben alle Anforderungen hohe Priorität.
sessionToken	Aktiviert/deaktiviert das Abrufen von Dokumentcontainerkontingentstatistiken für Dokumentcontainer-Leseanforderungen.

Details zur Eigenschaft

accessCondition

Bedingungen, die der Anforderung zugeordnet sind.

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

Eigenschaftswert

{ condition: string, type: string }

consistencyLevel

Vom Client erforderliche Konsistenzebene.

consistencyLevel?: string

Eigenschaftswert

string

disableAutomaticIdGeneration

Deaktivieren der automatischen ID-Generierung (führt dazu, dass die Erstellung fehlschlägt, wenn die ID nicht in der Definition enthalten ist)

disableAutomaticIdGeneration?: boolean

Eigenschaftswert

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage wird verwendet, um Anforderungseinheiten(RUs)/Minutenkapazität zu aktivieren/zu deaktivieren, um die Anforderung zu bedienen, wenn die regulären bereitgestellten RUs/Sekunde erschöpft sind.

disableRUPerMinuteUsage?: boolean

Eigenschaftswert

boolean

enableScriptLogging

Aktiviert oder deaktiviert die Protokollierung in gespeicherten JavaScript-Prozeduren.

enableScriptLogging?: boolean

Eigenschaftswert

boolean

indexingDirective

Gibt Indizierungsdirektiven an (Index, nicht indizieren usw.).

indexingDirective?: string

Eigenschaftswert

string

offerThroughput

Der Angebotsdurchsatz, der für einen Container in der Messung von Anforderungen pro Einheit bereitgestellt wird.

offerThroughput?: number

Eigenschaftswert

number

offerType

Angebotstyp beim Erstellen von Dokumentcontainern.

Diese Option ist nur beim Erstellen eines Dokumentcontainers gültig.

offerType?: string

Eigenschaftswert

string

populateQuotaInfo

Aktiviert/deaktiviert das Abrufen von Dokumentcontainerkontingentstatistiken für Dokumentcontainer-Leseanforderungen.

populateQuotaInfo?: boolean

Eigenschaftswert

boolean

postTriggerInclude

Gibt an, was der Posttrigger ist, der nach dem Vorgang aufgerufen werden soll.

postTriggerInclude?: string | string[]

Eigenschaftswert

string | string[]

preTriggerInclude

Gibt an, welcher Prätrigger vor dem Vorgang aufgerufen werden soll.

preTriggerInclude?: string | string[]

Eigenschaftswert

string | string[]

resourceTokenExpirySeconds

Ablaufzeit (in Sekunden) für Ressourcentoken, das der Berechtigung zugeordnet ist (gilt nur für Anforderungen für Berechtigungen).

resourceTokenExpirySeconds?: number

Eigenschaftswert

number

urlConnection

(Erweiterter Anwendungsfall) Die URL, mit der eine Verbindung hergestellt werden soll.

urlConnection?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

abortSignal

abortSignal, um an alle zugrunde liegenden Netzwerkanforderungen zu übergeben, die durch diesen Methodenaufruf erstellt wurden. Siehe https://developer.mozilla.org/en-US/docs/Web/API/AbortController.

Beispiel

Abbrechen einer Leseanforderung

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

abortSignal?: AbortSignal

Eigenschaftswert

AbortSignal

Geerbt vonSharedOptions.abortSignal

initialHeaders

(Erweiterter Anwendungsfall) Anfangsheader beim Senden von Anforderungen an Cosmos

initialHeaders?: CosmosHeaders

Eigenschaftswert

CosmosHeaders

Geerbt vonSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Legt den Wert der Veraltung fest, der der Anforderung im Azure CosmosDB-Dienst zugeordnet ist. Für Anforderungen, bei denen oder <xref:com.azure.cosmos.ConsistencyLevel> ist, werden <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL><xref:com.azure.cosmos.ConsistencyLevel%23SESSION>Antworten aus dem integrierten Cache garantiert nicht staler als der wert sein, der von dieser maxIntegratedCacheStaleness angegeben wird. Wenn die Konsistenzebene nicht festgelegt ist, wird diese Eigenschaft ignoriert.

Der Standardwert ist NULL.

Cache-Staleness wird in Millisekunden granular unterstützt. Alles, was kleiner als Millisekunden ist, wird ignoriert.

maxIntegratedCacheStalenessInMs?: number

Eigenschaftswert

number

Geerbt vonSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Prioritätsebene (Niedrig/Hoch) für jede Anforderung. Anforderungen mit niedriger Priorität werden immer vor Anforderungen mit hoher Priorität gedrosselt.

Der Standardwert ist null. Standardmäßig haben alle Anforderungen hohe Priorität.

priorityLevel?: PriorityLevel

Eigenschaftswert

PriorityLevel

Geerbt vonSharedOptions.priorityLevel

sessionToken

Aktiviert/deaktiviert das Abrufen von Dokumentcontainerkontingentstatistiken für Dokumentcontainer-Leseanforderungen.

sessionToken?: string

Eigenschaftswert

string

Geerbt vonSharedOptions.sessionToken