RequestOptions interface

Pacchetto:

@azure/cosmos

Opzioni che è possibile specificare per un oggetto richiesto inviato ai server Azure Cosmos DB.=

Extends

SharedOptions

Proprietà

accessCondition	Condizioni associate alla richiesta.
consistencyLevel	Livello di coerenza richiesto dal client.
disableAutomaticIdGeneration	Disabilitare la generazione automatica dell'ID (causerà l'esito negativo della creazione se l'ID non è presente nella definizione)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage viene usato per abilitare/disabilitare la capacità delle unità richiesta (UR)/minuto per gestire la richiesta se le UR con provisioning regolare al secondo vengono esaurite.
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 in misura di Richieste 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 trigger preliminare da richiamare prima dell'operazione.
resourceTokenExpirySeconds	Tempo 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. Vedere https://developer.mozilla.org/en-US/docs/Web/API/AbortController Esempio Annullare una richiesta di lettura const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
initialHeaders	(Caso d'uso avanzato) Intestazioni iniziali con cui iniziare quando si inviano richieste a Cosmos
maxIntegratedCacheStalenessInMs	Imposta il valore di decadimento associato alla richiesta nel servizio Azure CosmosDB. Per le richieste in cui <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 più aggiornate del valore indicato da questo maxIntegratedCacheStaleness. Quando il livello di coerenza non è impostato, questa proprietà viene ignorata. Il valore predefinito è Null La decadimento 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à elevata. Il valore predefinito è Null. Per impostazione predefinita, tutte le richieste hanno priorità elevata
sessionToken	Abilita/disabilita il recupero delle statistiche correlate alla quota del contenitore di documenti per le richieste di lettura del contenitore di documenti.

Dettagli proprietà

accessCondition

Condizioni associate alla richiesta.

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

Valore della proprietà

{ condition: string, type: string }

consistencyLevel

Livello di coerenza richiesto dal client.

consistencyLevel?: string

Valore della proprietà

string

disableAutomaticIdGeneration

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

disableAutomaticIdGeneration?: boolean

Valore della proprietà

boolean

disableRUPerMinuteUsage

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

disableRUPerMinuteUsage?: 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 in misura di Richieste 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 trigger preliminare da richiamare prima dell'operazione.

preTriggerInclude?: string | string[]

Valore della proprietà

string | string[]

resourceTokenExpirySeconds

Tempo 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. Vedere https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Esempio

Annullare una richiesta di lettura

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

abortSignal?: AbortSignal

Valore della proprietà

AbortSignal

Ereditato daSharedOptions.abortSignal

initialHeaders

(Caso d'uso avanzato) Intestazioni iniziali con cui iniziare 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 <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 più aggiornate del valore indicato da questo maxIntegratedCacheStaleness. Quando il livello di coerenza non è impostato, questa proprietà viene ignorata.

Il valore predefinito è Null

La decadimento 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à elevata.

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

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