Condividi tramite

RequestOptions interface

Pacchetto:
@azure/cosmos

Opzioni che possono essere specificate per un'emissione richiesta ai server Azure Cosmos DB.=

Extends
SharedOptions

Proprietà

accessCondition

Condizioni associate alla richiesta.
contentResponseOnWriteEnabled

Se impostato su false, il servizio non restituisce il payload nella risposta. Riduce il carico di rete e della CPU non inviando il payload sulla rete. Il valore predefinito è vero.

NOTA: Attualmente, questa opzione è supportata solo per le operazioni bulk e batch.
disableAutomaticIdGeneration

Disabilitare la generazione automatica dell'ID (causerà l'esito negativo delle operazioni di creazione se l'ID non è nella definizione)
enableScriptLogging

Abilita o disabilita la registrazione nelle stored procedure JavaScript.
indexingDirective

Specifica le direttive di indicizzazione (indice, non indicizzare e così via).
offerThroughput

Velocità effettiva offerta di cui è stato effettuato il provisioning per un contenitore nella misura di Requests-per-Unit.
offerType

Tipo di offerta durante la creazione di contenitori di documenti.

Questa opzione è valida solo quando si crea un contenitore di documenti.
populateQuotaInfo

Abilita/disabilita il recupero delle statistiche correlate alla quota del contenitore di documenti per le richieste di lettura del contenitore di documenti.
postTriggerInclude

Indica qual è il trigger post da richiamare dopo l'operazione.
preTriggerInclude

Indica qual è il pre trigger da richiamare prima dell'operazione.
resourceTokenExpirySeconds

Ora di scadenza (in secondi) per il token di risorsa associato all'autorizzazione (applicabile solo per le richieste per le autorizzazioni).
urlConnection

(Caso d'uso avanzato) URL a cui connettersi.

Proprietà ereditate

abortSignal

abortSignal per passare a tutte le richieste di rete sottostanti create da questa chiamata al metodo. Fare riferimento a https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Esempio

Annullare una richiesta di lettura

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

Imposta se la cache integrata deve essere ignorata o abilitata per la richiesta nel servizio Azure CosmosDB.

Il valore predefinito è false. Per impostazione predefinita, la cache integrata è abilitata
consistencyLevel

Livello di coerenza richiesto dal client.
disableRUPerMinuteUsage

DisableRUPerMinuteUsage viene usato per abilitare/disabilitare la capacità delle unità richiesta (UR)/minuto per soddisfare la richiesta se le UR con provisioning regolare al secondo sono esaurite.
excludedLocations

Esclude una o più aree di Azure per l'operazione.

Questa opzione viene applicata solo quando enableEndPointDiscovery è impostato su true.
initialHeaders

(Caso d'uso avanzato) Intestazioni iniziali da iniziare con quando si inviano richieste a Cosmos
maxIntegratedCacheStalenessInMs

Imposta il valore di decadimento associato alla richiesta nel servizio Azure CosmosDB. Per le richieste in cui il <xref:com.azure.cosmos.ConsistencyLevel> è <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> o <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, le risposte dalla cache integrata non sono necessariamente diverse dal valore indicato da questo valore maxIntegratedCacheStaleness. Quando il livello di coerenza non è impostato, questa proprietà viene ignorata.

Il valore predefinito è Null

La granularità della cache è supportata in millisecondi di granularità. Qualsiasi valore inferiore a millisecondi verrà ignorato.
priorityLevel

Livello di priorità (basso/alto) per ogni richiesta. Le richieste con priorità bassa vengono sempre limitate prima di qualsiasi richiesta con priorità alta.

Il valore predefinito è Null. Per impostazione predefinita, tutte le richieste hanno priorità alta
sessionToken

Abilita/disabilita il recupero delle statistiche correlate alla quota del contenitore di documenti per le richieste di lettura del contenitore di documenti.
throughputBucket

Bucket di velocità effettiva per una richiesta.

Il valore predefinito è Null. In questo caso, la richiesta può utilizzare 100% della velocità effettiva della partizione.

Per altre informazioni, visitare [Bucket della velocità effettiva di Cosmos DB](https://aka.ms/cosmsodb-bucketing).

Dettagli proprietà

accessCondition

Condizioni associate alla richiesta.

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

Valore della proprietà

{ condition: string, type: string }

contentResponseOnWriteEnabled

Se impostato su false, il servizio non restituisce il payload nella risposta. Riduce il carico di rete e della CPU non inviando il payload sulla rete. Il valore predefinito è vero.

NOTA: Attualmente, questa opzione è supportata solo per le operazioni bulk e batch.

contentResponseOnWriteEnabled?: boolean

Valore della proprietà

boolean

disableAutomaticIdGeneration

Disabilitare la generazione automatica dell'ID (causerà l'esito negativo delle operazioni di creazione se l'ID non è nella definizione)

disableAutomaticIdGeneration?: boolean

Valore della proprietà

boolean

enableScriptLogging

Abilita o disabilita la registrazione nelle stored procedure JavaScript.

enableScriptLogging?: boolean

Valore della proprietà

boolean

indexingDirective

Specifica le direttive di indicizzazione (indice, non indicizzare e così via).

indexingDirective?: string

Valore della proprietà

string

offerThroughput

Velocità effettiva offerta di cui è stato effettuato il provisioning per un contenitore nella misura di Requests-per-Unit.

offerThroughput?: number

Valore della proprietà

number

offerType

Tipo di offerta durante la creazione di contenitori di documenti.

Questa opzione è valida solo quando si crea un contenitore di documenti.

offerType?: string

Valore della proprietà

string

populateQuotaInfo

Abilita/disabilita il recupero delle statistiche correlate alla quota del contenitore di documenti per le richieste di lettura del contenitore di documenti.

populateQuotaInfo?: boolean

Valore della proprietà

boolean

postTriggerInclude

Indica qual è il trigger post da richiamare dopo l'operazione.

postTriggerInclude?: string | string[]

Valore della proprietà

string | string[]

preTriggerInclude

Indica qual è il pre trigger da richiamare prima dell'operazione.

preTriggerInclude?: string | string[]

Valore della proprietà

string | string[]

resourceTokenExpirySeconds

Ora di scadenza (in secondi) per il token di risorsa associato all'autorizzazione (applicabile solo per le richieste per le autorizzazioni).

resourceTokenExpirySeconds?: number

Valore della proprietà

number

urlConnection

(Caso d'uso avanzato) URL a cui connettersi.

urlConnection?: string

Valore della proprietà

string

Dettagli proprietà ereditate

abortSignal

abortSignal per passare a tutte le richieste di rete sottostanti create da questa chiamata al metodo. Fare riferimento a https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Esempio

Annullare una richiesta di lettura

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

Valore della proprietà

AbortSignal

ereditato daSharedOptions.abortSignal

bypassIntegratedCache

Imposta se la cache integrata deve essere ignorata o abilitata per la richiesta nel servizio Azure CosmosDB.

Il valore predefinito è false. Per impostazione predefinita, la cache integrata è abilitata

bypassIntegratedCache?: boolean

Valore della proprietà

boolean

Ereditato daSharedOptions.bypassIntegratedCache

consistencyLevel

Livello di coerenza richiesto dal client.

consistencyLevel?: string

Valore della proprietà

string

Ereditato daSharedOptions.consistencyLevel

disableRUPerMinuteUsage

DisableRUPerMinuteUsage viene usato per abilitare/disabilitare la capacità delle unità richiesta (UR)/minuto per soddisfare la richiesta se le UR con provisioning regolare al secondo sono esaurite.

disableRUPerMinuteUsage?: boolean

Valore della proprietà

boolean

Ereditato daSharedOptions.disableRUPerMinuteUsage

excludedLocations

Esclude una o più aree di Azure per l'operazione.

Questa opzione viene applicata solo quando enableEndPointDiscovery è impostato su true.

excludedLocations?: string[]

Valore della proprietà

string[]

Ereditato daSharedOptions.excludedLocations

initialHeaders

(Caso d'uso avanzato) Intestazioni iniziali da iniziare con quando si inviano richieste a Cosmos

initialHeaders?: CosmosHeaders

Valore della proprietà

CosmosHeaders

ereditato daSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Imposta il valore di decadimento associato alla richiesta nel servizio Azure CosmosDB. Per le richieste in cui il <xref:com.azure.cosmos.ConsistencyLevel> è <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> o <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, le risposte dalla cache integrata non sono necessariamente diverse dal valore indicato da questo valore maxIntegratedCacheStaleness. Quando il livello di coerenza non è impostato, questa proprietà viene ignorata.

Il valore predefinito è Null

La granularità della cache è supportata in millisecondi di granularità. Qualsiasi valore inferiore a millisecondi verrà ignorato.

maxIntegratedCacheStalenessInMs?: number

Valore della proprietà

number

Ereditato daSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Livello di priorità (basso/alto) per ogni richiesta. Le richieste con priorità bassa vengono sempre limitate prima di qualsiasi richiesta con priorità alta.

Il valore predefinito è Null. Per impostazione predefinita, tutte le richieste hanno priorità alta

priorityLevel?: PriorityLevel

Valore della proprietà

PriorityLevel

ereditato daSharedOptions.priorityLevel

sessionToken

Abilita/disabilita il recupero delle statistiche correlate alla quota del contenitore di documenti per le richieste di lettura del contenitore di documenti.

sessionToken?: string

Valore della proprietà

string

ereditato daSharedOptions.sessionToken

throughputBucket

Bucket di velocità effettiva per una richiesta.

Il valore predefinito è Null. In questo caso, la richiesta può utilizzare 100% della velocità effettiva della partizione.

Per altre informazioni, visitare [Bucket della velocità effettiva di Cosmos DB](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Valore della proprietà

number

Ereditato daSharedOptions.throughputBucket