Sdílet prostřednictvím

RequestOptions interface

Balíček:
@azure/cosmos

Možnosti, které lze zadat pro požadované vydané servery Azure Cosmos DB.=

Extends
SharedOptions

Vlastnosti

accessCondition

Podmínky přidružené k žádosti.
contentResponseOnWriteEnabled

Pokud je nastavená hodnota false, služba v odpovědi nevrací datovou část. Snižuje zatížení sítě a procesoru tím, že neodesílá datovou část zpět po síti. Výchozí hodnota je true.

POZNÁMKA: V současné době je tato možnost podporována pouze pro hromadné a dávkové operace.
disableAutomaticIdGeneration

Zakázání automatického generování ID (způsobí selhání vytváření, pokud id není v definici)
enableScriptLogging

Povolí nebo zakáže protokolování v uložených procedurách JavaScriptu.
indexingDirective

Určuje direktivy indexování (index, ne index atd.).
offerThroughput

Nabídka propustnosti zřízená pro kontejner v měření požadavků na jednotku.
offerType

Typ nabídky při vytváření kontejnerů dokumentů

Tato možnost je platná pouze při vytváření kontejneru dokumentů.
populateQuotaInfo

Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů.
postTriggerInclude

Označuje, co je trigger post, který se má vyvolat po operaci.
preTriggerInclude

Určuje, co je pre trigger, který se má vyvolat před operací.
resourceTokenExpirySeconds

Doba vypršení platnosti tokenu prostředku přidruženého k oprávnění (platí jenom pro žádosti o oprávnění).
urlConnection

(Případ rozšířeného použití) Adresa URL, ke které se chcete připojit.

Zděděné vlastnosti

abortSignal

abortSignal předat všem podkladovým síťovým požadavkům vytvořeným tímto voláním metody. Podívejte se na https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Příklad

Zrušení žádosti o čtení

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

Nastaví, jestli se má integrovaná mezipaměť obejít nebo povolit pro požadavek ve službě Azure CosmosDB.

Výchozí hodnota je false. Ve výchozím nastavení je povolená integrovaná mezipaměť.
consistencyLevel

Úroveň konzistence vyžadovaná klientem
disableRUPerMinuteUsage

DisableRUPerMinuteUsage se používá k povolení nebo zakázání kapacity jednotek žádostí (RU) nebo minut, aby se žádost obsloužila, pokud dojde k vyčerpání pravidelných zřízených RU za sekundu.
excludedLocations

Vyloučí jednu nebo více oblastí Azure pro operaci.

Tato možnost se použije pouze v případě, že je vlastnost enableEndPointDiscovery nastavena na hodnotu true.
initialHeaders

(Případ rozšířeného použití) Počáteční hlavičky, se kterými začnete při odesílání požadavků do Cosmos
maxIntegratedCacheStalenessInMs

Nastaví hodnotu zastaralosti přidruženou k požadavku ve službě Azure CosmosDB. U požadavků, kde je <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> nebo <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, jsou zaručeny, že odpovědi z integrované mezipaměti nebudou zastaralé než hodnota určená tímto maxIntegratedCacheStaleness. Pokud úroveň konzistence není nastavena, bude tato vlastnost ignorována.

Výchozí hodnota je null

Zastaralost mezipaměti se podporuje v milisekundách členitosti. Bude ignorováno cokoli menšího než milisekundy.
priorityLevel

Úroveň priority (nízká/vysoká) pro každý požadavek. Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou.

Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu.
sessionToken

Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů.
throughputBucket

Kontejner propustnosti pro požadavek.

Výchozí hodnota je null. V takovém případě může požadavek využít 100% propustnosti oddílu.

Další informace naleznete na stránce [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

Podrobnosti vlastnosti

accessCondition

Podmínky přidružené k žádosti.

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

Hodnota vlastnosti

{ condition: string, type: string }

contentResponseOnWriteEnabled

Pokud je nastavená hodnota false, služba v odpovědi nevrací datovou část. Snižuje zatížení sítě a procesoru tím, že neodesílá datovou část zpět po síti. Výchozí hodnota je true.

POZNÁMKA: V současné době je tato možnost podporována pouze pro hromadné a dávkové operace.

contentResponseOnWriteEnabled?: boolean

Hodnota vlastnosti

boolean

disableAutomaticIdGeneration

Zakázání automatického generování ID (způsobí selhání vytváření, pokud id není v definici)

disableAutomaticIdGeneration?: boolean

Hodnota vlastnosti

boolean

enableScriptLogging

Povolí nebo zakáže protokolování v uložených procedurách JavaScriptu.

enableScriptLogging?: boolean

Hodnota vlastnosti

boolean

indexingDirective

Určuje direktivy indexování (index, ne index atd.).

indexingDirective?: string

Hodnota vlastnosti

string

offerThroughput

Nabídka propustnosti zřízená pro kontejner v měření požadavků na jednotku.

offerThroughput?: number

Hodnota vlastnosti

number

offerType

Typ nabídky při vytváření kontejnerů dokumentů

Tato možnost je platná pouze při vytváření kontejneru dokumentů.

offerType?: string

Hodnota vlastnosti

string

populateQuotaInfo

Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů.

populateQuotaInfo?: boolean

Hodnota vlastnosti

boolean

postTriggerInclude

Označuje, co je trigger post, který se má vyvolat po operaci.

postTriggerInclude?: string | string[]

Hodnota vlastnosti

string | string[]

preTriggerInclude

Určuje, co je pre trigger, který se má vyvolat před operací.

preTriggerInclude?: string | string[]

Hodnota vlastnosti

string | string[]

resourceTokenExpirySeconds

Doba vypršení platnosti tokenu prostředku přidruženého k oprávnění (platí jenom pro žádosti o oprávnění).

resourceTokenExpirySeconds?: number

Hodnota vlastnosti

number

urlConnection

(Případ rozšířeného použití) Adresa URL, ke které se chcete připojit.

urlConnection?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

abortSignal

abortSignal předat všem podkladovým síťovým požadavkům vytvořeným tímto voláním metody. Podívejte se na https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Příklad

Zrušení žádosti o čtení

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

Hodnota vlastnosti

AbortSignal

zděděno zeSharedOptions.abortSignal

bypassIntegratedCache

Nastaví, jestli se má integrovaná mezipaměť obejít nebo povolit pro požadavek ve službě Azure CosmosDB.

Výchozí hodnota je false. Ve výchozím nastavení je povolená integrovaná mezipaměť.

bypassIntegratedCache?: boolean

Hodnota vlastnosti

boolean

zděděno zeSharedOptions.bypassIntegratedCache

consistencyLevel

Úroveň konzistence vyžadovaná klientem

consistencyLevel?: string

Hodnota vlastnosti

string

Zděděno zSharedOptions.consistencyLevel

disableRUPerMinuteUsage

DisableRUPerMinuteUsage se používá k povolení nebo zakázání kapacity jednotek žádostí (RU) nebo minut, aby se žádost obsloužila, pokud dojde k vyčerpání pravidelných zřízených RU za sekundu.

disableRUPerMinuteUsage?: boolean

Hodnota vlastnosti

boolean

Zděděno zSharedOptions.disableRUPerMinuteUsage

excludedLocations

Vyloučí jednu nebo více oblastí Azure pro operaci.

Tato možnost se použije pouze v případě, že je vlastnost enableEndPointDiscovery nastavena na hodnotu true.

excludedLocations?: string[]

Hodnota vlastnosti

string[]

Zděděno zSharedOptions.excludedLocations

initialHeaders

(Případ rozšířeného použití) Počáteční hlavičky, se kterými začnete při odesílání požadavků do Cosmos

initialHeaders?: CosmosHeaders

Hodnota vlastnosti

CosmosHeaders

zděděno zeSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Nastaví hodnotu zastaralosti přidruženou k požadavku ve službě Azure CosmosDB. U požadavků, kde je <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> nebo <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, jsou zaručeny, že odpovědi z integrované mezipaměti nebudou zastaralé než hodnota určená tímto maxIntegratedCacheStaleness. Pokud úroveň konzistence není nastavena, bude tato vlastnost ignorována.

Výchozí hodnota je null

Zastaralost mezipaměti se podporuje v milisekundách členitosti. Bude ignorováno cokoli menšího než milisekundy.

maxIntegratedCacheStalenessInMs?: number

Hodnota vlastnosti

number

zděděno zeSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Úroveň priority (nízká/vysoká) pro každý požadavek. Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou.

Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu.

priorityLevel?: PriorityLevel

Hodnota vlastnosti

PriorityLevel

zděděno zeSharedOptions.priorityLevel

sessionToken

Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů.

sessionToken?: string

Hodnota vlastnosti

string

zděděno zeSharedOptions.sessionToken

throughputBucket

Kontejner propustnosti pro požadavek.

Výchozí hodnota je null. V takovém případě může požadavek využít 100% propustnosti oddílu.

Další informace naleznete na stránce [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Hodnota vlastnosti

number

Zděděno zSharedOptions.throughputBucket