Freigeben über

RequestOptions interface

Paket:
@azure/cosmos

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

Extends
SharedOptions

Eigenschaften

accessCondition

Bedingungen, die der Anforderung zugeordnet sind.
contentResponseOnWriteEnabled

Wenn dieser Wert auf "false" festgelegt ist, gibt der Dienst keine Nutzlast in der Antwort zurück. Es reduziert die Netzwerk- und CPU-Last, indem die Nutzlast nicht über das Netzwerk zurückgesendet wird. Der Standardwert ist wahr.

HINWEIS: Derzeit wird diese Option nur für Massen- und Batch-Vorgänge unterstützt.
disableAutomaticIdGeneration

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

Aktiviert oder deaktiviert die Protokollierung in gespeicherten JavaScript-Prozeduren.
indexingDirective

Gibt Indizierungsdirektiven an (Index, nicht index .. usw.).
offerThroughput

Der Angebotsdurchsatz, der für einen Container bereitgestellt wird, der anforderungen pro Einheit gemessen wird.The offer throughput provisioned for a container in measurement of Requests-per-Unit.
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 Dokumentcontainerleseanforderungen.
postTriggerInclude

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

Gibt an, was der pre-Trigger ist, der vor dem Vorgang aufgerufen werden soll.
resourceTokenExpirySeconds

Ablaufzeit (in Sekunden) für Ressourcentoken, das der Berechtigung zugeordnet ist (gilt nur für Anforderungen an 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 von diesem Methodenaufruf erstellt wurden. Siehe https://developer.mozilla.org/en-US/docs/Web/API/AbortController.

Beispiel

Abbrechen einer Leseanforderung

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

Legt fest, ob der integrierte Cache für die Anforderung im Azure CosmosDB-Dienst umgangen oder aktiviert werden soll.

Der Standardwert ist "false". Standardmäßig ist der integrierte Cache aktiviert.
consistencyLevel

Konsistenzstufe, die vom Client benötigt wird.
disableRUPerMinuteUsage

DisableRUPerMinuteUsage wird verwendet, um Anforderungseinheiten(RUs)/Minute-Kapazität für die Anforderung zu aktivieren/zu deaktivieren, wenn reguläre bereitgestellte RUs/Sekunde erschöpft sind.
excludedLocations

Schließt eine oder mehrere Azure-Regionen für den Vorgang aus.

Diese Option wird nur angewendet, wenn enableEndPointDiscovery auf true festgelegt ist.
initialHeaders

(Erweiterter Anwendungsfall) Anfängliche Kopfzeilen, die beim Senden von Anforderungen an Cosmos beginnen sollen
maxIntegratedCacheStalenessInMs

Legt den Veraltetkeitswert fest, der der Anforderung im Azure CosmosDB-Dienst zugeordnet ist. Bei Anforderungen, bei denen die <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> oder <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>ist, sind Antworten aus dem integrierten Cache garantiert kein Staler als der wert, der durch diese maxIntegratedCacheStaleness angegeben ist. Wenn die Konsistenzstufe nicht festgelegt ist, wird diese Eigenschaft ignoriert.

Standardwert ist NULL

Die Cache-Veraltetkeit wird in Millisekunden Granularität unterstützt. Alles, was kleiner als Millisekunden ist, wird ignoriert.
priorityLevel

Prioritätsstufe (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 sind alle Anforderungen von hoher Priorität
sessionToken

Aktiviert/deaktiviert das Abrufen von Dokumentcontainerkontingentstatistiken für Dokumentcontainerleseanforderungen.
throughputBucket

Durchsatz-Bucket für eine Anforderung.

Der Standardwert ist NULL. In diesem Fall kann die Anforderung 100% des Partitionsdurchsatzes verwenden.

Weitere Informationen finden Sie unter [Bucketing des Cosmos DB-Durchsatzes](https://aka.ms/cosmsodb-bucketing).

Details zur Eigenschaft

accessCondition

Bedingungen, die der Anforderung zugeordnet sind.

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

Eigenschaftswert

{ condition: string, type: string }

contentResponseOnWriteEnabled

Wenn dieser Wert auf "false" festgelegt ist, gibt der Dienst keine Nutzlast in der Antwort zurück. Es reduziert die Netzwerk- und CPU-Last, indem die Nutzlast nicht über das Netzwerk zurückgesendet wird. Der Standardwert ist wahr.

HINWEIS: Derzeit wird diese Option nur für Massen- und Batch-Vorgänge unterstützt.

contentResponseOnWriteEnabled?: boolean

Eigenschaftswert

boolean

disableAutomaticIdGeneration

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

disableAutomaticIdGeneration?: boolean

Eigenschaftswert

boolean

enableScriptLogging

Aktiviert oder deaktiviert die Protokollierung in gespeicherten JavaScript-Prozeduren.

enableScriptLogging?: boolean

Eigenschaftswert

boolean

indexingDirective

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

indexingDirective?: string

Eigenschaftswert

string

offerThroughput

Der Angebotsdurchsatz, der für einen Container bereitgestellt wird, der anforderungen pro Einheit gemessen wird.The offer throughput provisioned for a container in measurement of Requests-per-Unit.

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 Dokumentcontainerleseanforderungen.

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, was der pre-Trigger ist, der 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 an 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 von diesem Methodenaufruf erstellt wurden. Siehe https://developer.mozilla.org/en-US/docs/Web/API/AbortController.

Beispiel

Abbrechen einer Leseanforderung

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

Eigenschaftswert

AbortSignal

geerbt vonSharedOptions.abortSignal

bypassIntegratedCache

Legt fest, ob der integrierte Cache für die Anforderung im Azure CosmosDB-Dienst umgangen oder aktiviert werden soll.

Der Standardwert ist "false". Standardmäßig ist der integrierte Cache aktiviert.

bypassIntegratedCache?: boolean

Eigenschaftswert

boolean

geerbt vonSharedOptions.bypassIntegratedCache-

consistencyLevel

Konsistenzstufe, die vom Client benötigt wird.

consistencyLevel?: string

Eigenschaftswert

string

Geerbt vonSharedOptions.consistencyLevel

disableRUPerMinuteUsage

DisableRUPerMinuteUsage wird verwendet, um Anforderungseinheiten(RUs)/Minute-Kapazität für die Anforderung zu aktivieren/zu deaktivieren, wenn reguläre bereitgestellte RUs/Sekunde erschöpft sind.

disableRUPerMinuteUsage?: boolean

Eigenschaftswert

boolean

Geerbt vonSharedOptions.disableRUPerMinuteUsage

excludedLocations

Schließt eine oder mehrere Azure-Regionen für den Vorgang aus.

Diese Option wird nur angewendet, wenn enableEndPointDiscovery auf true festgelegt ist.

excludedLocations?: string[]

Eigenschaftswert

string[]

Geerbt vonSharedOptions.excludedLocations

initialHeaders

(Erweiterter Anwendungsfall) Anfängliche Kopfzeilen, die beim Senden von Anforderungen an Cosmos beginnen sollen

initialHeaders?: CosmosHeaders

Eigenschaftswert

CosmosHeaders

vonSharedOptions.initialHeaders geerbt

maxIntegratedCacheStalenessInMs

Legt den Veraltetkeitswert fest, der der Anforderung im Azure CosmosDB-Dienst zugeordnet ist. Bei Anforderungen, bei denen die <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> oder <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>ist, sind Antworten aus dem integrierten Cache garantiert kein Staler als der wert, der durch diese maxIntegratedCacheStaleness angegeben ist. Wenn die Konsistenzstufe nicht festgelegt ist, wird diese Eigenschaft ignoriert.

Standardwert ist NULL

Die Cache-Veraltetkeit wird in Millisekunden Granularität unterstützt. Alles, was kleiner als Millisekunden ist, wird ignoriert.

maxIntegratedCacheStalenessInMs?: number

Eigenschaftswert

number

VonSharedOptions.maxIntegratedCacheStalenessInMs geerbt

priorityLevel

Prioritätsstufe (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 sind alle Anforderungen von hoher Priorität

priorityLevel?: PriorityLevel

Eigenschaftswert

PriorityLevel

geerbt vonSharedOptions.priorityLevel

sessionToken

Aktiviert/deaktiviert das Abrufen von Dokumentcontainerkontingentstatistiken für Dokumentcontainerleseanforderungen.

sessionToken?: string

Eigenschaftswert

string

geerbt vonSharedOptions.sessionToken

throughputBucket

Durchsatz-Bucket für eine Anforderung.

Der Standardwert ist NULL. In diesem Fall kann die Anforderung 100% des Partitionsdurchsatzes verwenden.

Weitere Informationen finden Sie unter [Bucketing des Cosmos DB-Durchsatzes](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Eigenschaftswert

number

Geerbt vonSharedOptions.throughputBucket