RequestOptions interface

Pacote:

@azure/cosmos

Opções que podem ser especificadas para um pedido emitido para os servidores do Azure Cosmos DB.=

Extends

SharedOptions

Propriedades

accessCondition	Condições Associadas ao pedido.
consistencyLevel	Nível de consistência exigido pelo cliente.
disableAutomaticIdGeneration	Desativar a geração automática de IDs (fará com que as criações falhem se o ID não estiver na definição)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage é utilizado para ativar/desativar a capacidade de Unidades de Pedido (RUs)/minuto para servir o pedido se as RUs/segundo aprovisionadas regulares estiverem esgotadas.
enableScriptLogging	Ativa ou desativa o registo nos procedimentos armazenados em JavaScript.
indexingDirective	Especifica diretivas de indexação (índice, não indexar ., etc.).
offerThroughput	O débito da oferta aprovisionado para um contentor na medição de Pedidos por Unidade.
offerType	Tipo de oferta ao criar contentores de documentos. Esta opção só é válida ao criar um contentor de documentos.
populateQuotaInfo	Ativa/desativa a obtenção de estatísticas relacionadas com a quota de contentor de documentos para pedidos de leitura de contentores de documentos.
postTriggerInclude	Indica o que é o acionador post a ser invocado após a operação.
preTriggerInclude	Indica qual é o pré-acionador a ser invocado antes da operação.
resourceTokenExpirySeconds	Tempo de expiração (em segundos) do token de recurso associado à permissão (aplicável apenas para pedidos de permissões).
urlConnection	(Caso de utilização avançado) O URL ao qual ligar.

Propriedades Herdadas

abortSignal	abortSignal para transmitir a todos os pedidos de rede subjacentes criados por esta chamada de método. Veja https://developer.mozilla.org/en-US/docs/Web/API/AbortController Exemplo Cancelar um pedido de leitura const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
initialHeaders	(Caso de utilização avançado) Cabeçalhos iniciais para começar quando enviar pedidos para o Cosmos
maxIntegratedCacheStalenessInMs	Define o valor de estagnação associado ao pedido no serviço Azure CosmosDB. Para pedidos em que as <xref:com.azure.cosmos.ConsistencyLevel> respostas is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, da cache integrada não são garantidas como obsoletas do que o valor indicado por este maxIntegratedCacheStaleness. Quando o nível de consistência não está definido, esta propriedade é ignorada. O valor predefinido é nulo A Estagnação da Cache é suportada em milissegundos de granularidade. Qualquer coisa menor que milissegundos será ignorada.
priorityLevel	Nível de Prioridade (Baixo/Alto) para cada pedido. Os pedidos de baixa prioridade são sempre limitados antes de quaisquer pedidos de alta prioridade. O valor predefinido é nulo. Por predefinição, todos os pedidos são de Alta prioridade
sessionToken	Ativa/desativa a obtenção de estatísticas relacionadas com a quota de contentor de documentos para pedidos de leitura de contentores de documentos.

Detalhes de Propriedade

accessCondition

Condições Associadas ao pedido.

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

Valor de Propriedade

{ condition: string, type: string }

consistencyLevel

Nível de consistência exigido pelo cliente.

consistencyLevel?: string

Valor de Propriedade

string

disableAutomaticIdGeneration

Desativar a geração automática de IDs (fará com que as criações falhem se o ID não estiver na definição)

disableAutomaticIdGeneration?: boolean

Valor de Propriedade

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage é utilizado para ativar/desativar a capacidade de Unidades de Pedido (RUs)/minuto para servir o pedido se as RUs/segundo aprovisionadas regulares estiverem esgotadas.

disableRUPerMinuteUsage?: boolean

Valor de Propriedade

boolean

enableScriptLogging

Ativa ou desativa o registo nos procedimentos armazenados em JavaScript.

enableScriptLogging?: boolean

Valor de Propriedade

boolean

indexingDirective

Especifica diretivas de indexação (índice, não indexar ., etc.).

indexingDirective?: string

Valor de Propriedade

string

offerThroughput

O débito da oferta aprovisionado para um contentor na medição de Pedidos por Unidade.

offerThroughput?: number

Valor de Propriedade

number

offerType

Tipo de oferta ao criar contentores de documentos.

Esta opção só é válida ao criar um contentor de documentos.

offerType?: string

Valor de Propriedade

string

populateQuotaInfo

Ativa/desativa a obtenção de estatísticas relacionadas com a quota de contentor de documentos para pedidos de leitura de contentores de documentos.

populateQuotaInfo?: boolean

Valor de Propriedade

boolean

postTriggerInclude

Indica o que é o acionador post a ser invocado após a operação.

postTriggerInclude?: string | string[]

Valor de Propriedade

string | string[]

preTriggerInclude

Indica qual é o pré-acionador a ser invocado antes da operação.

preTriggerInclude?: string | string[]

Valor de Propriedade

string | string[]

resourceTokenExpirySeconds

Tempo de expiração (em segundos) do token de recurso associado à permissão (aplicável apenas para pedidos de permissões).

resourceTokenExpirySeconds?: number

Valor de Propriedade

number

urlConnection

(Caso de utilização avançado) O URL ao qual ligar.

urlConnection?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

abortSignal para transmitir a todos os pedidos de rede subjacentes criados por esta chamada de método. Veja https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exemplo

Cancelar um pedido de leitura

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

abortSignal?: AbortSignal

Valor de Propriedade

AbortSignal

Herdado deSharedOptions.abortSignal

initialHeaders

(Caso de utilização avançado) Cabeçalhos iniciais para começar quando enviar pedidos para o Cosmos

initialHeaders?: CosmosHeaders

Valor de Propriedade

CosmosHeaders

Herdado deSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Define o valor de estagnação associado ao pedido no serviço Azure CosmosDB. Para pedidos em que as <xref:com.azure.cosmos.ConsistencyLevel> respostas is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, da cache integrada não são garantidas como obsoletas do que o valor indicado por este maxIntegratedCacheStaleness. Quando o nível de consistência não está definido, esta propriedade é ignorada.

O valor predefinido é nulo

A Estagnação da Cache é suportada em milissegundos de granularidade. Qualquer coisa menor que milissegundos será ignorada.

maxIntegratedCacheStalenessInMs?: number

Valor de Propriedade

number

Herdado deSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Nível de Prioridade (Baixo/Alto) para cada pedido. Os pedidos de baixa prioridade são sempre limitados antes de quaisquer pedidos de alta prioridade.

O valor predefinido é nulo. Por predefinição, todos os pedidos são de Alta prioridade

priorityLevel?: PriorityLevel

Valor de Propriedade

PriorityLevel

Herdado deSharedOptions.priorityLevel

sessionToken

Ativa/desativa a obtenção de estatísticas relacionadas com a quota de contentor de documentos para pedidos de leitura de contentores de documentos.

sessionToken?: string

Valor de Propriedade

string

Herdado deSharedOptions.sessionToken