Compartilhar via

RequestOptions interface

  • Referência
Pacote:
@azure/cosmos

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

Extends
SharedOptions

Propriedades

accessCondition

Condições associadas à solicitação.
contentResponseOnWriteEnabled

Se definido como false, o serviço não retornará a carga na resposta. Ele reduz a rede e a carga da CPU ao não enviar a carga útil de volta pela rede. O valor padrão é verdadeiro.

NOTA: Atualmente, essa opção só tem suporte para operações em massa e em lote.
disableAutomaticIdGeneration

Desabilitar a geração automática de ID (fará com que as crias falhem se a ID não estiver na definição)
enableScriptLogging

Habilita ou desabilita o registro em log em procedimentos armazenados do JavaScript.
indexingDirective

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

A taxa de transferência da oferta provisionada para um contêiner na medida de Solicitações por Unidade.
offerType

Tipo de oferta ao criar contêineres de documento.

Essa opção só é válida ao criar um contêiner de documento.
populateQuotaInfo

Habilita/desabilita a obtenção de estatísticas relacionadas à cota de contêiner de documentos para solicitações de leitura de contêiner de documento.
postTriggerInclude

Indica qual é o gatilho de postagem a ser invocado após a operação.
preTriggerInclude

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

Tempo de expiração (em segundos) para o token de recurso associado à permissão (aplicável somente para solicitações em permissões).
urlConnection

(Caso de uso avançado) A URL à qual se conectar.

Propriedades herdadas

abortSignal

abortSignal para passar para todas as solicitações de rede subjacentes criadas por essa chamada de método. Consulte https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exemplo

Cancelar uma solicitação de leitura

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

Define se o cache integrado deve ser ignorado ou habilitado para a solicitação no serviço do Azure CosmosDB.

O valor padrão é falso. Por padrão, o cache integrado está habilitado
consistencyLevel

Nível de consistência exigido pelo cliente.
disableRUPerMinuteUsage

DisableRUPerMinuteUsage é usado para habilitar/desabilitar a capacidade de RUs (Unidades de Solicitação)/minuto para atender à solicitação se RUs/segundo provisionados regulares estiverem esgotados.
initialHeaders

(Caso de uso avançado) Cabeçalhos iniciais a serem iniciados ao enviar solicitações para o Cosmos
maxIntegratedCacheStalenessInMs

Define o valor de desatualização associado à solicitação no serviço do Azure CosmosDB. Para solicitações em que o <xref:com.azure.cosmos.ConsistencyLevel> é <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, as respostas do cache integrado não são mais obsoletas do que o valor indicado por esse maxIntegratedCacheStaleness. Quando o nível de consistência não é definido, essa propriedade é ignorada.

O valor padrão é nulo

Há suporte para desatualização do cache na granularidade de milissegundos. Qualquer coisa menor que milissegundos será ignorada.
priorityLevel

Nível de prioridade (baixo/alto) para cada solicitação. As solicitações de baixa prioridade são sempre limitadas antes de solicitações de alta prioridade.

O valor padrão é nulo. Por padrão, todas as solicitações são de alta prioridade
sessionToken

Habilita/desabilita a obtenção de estatísticas relacionadas à cota de contêiner de documentos para solicitações de leitura de contêiner de documento.
throughputBucket

Bucket de taxa de transferência para uma solicitação.

O valor padrão é nulo. Nesse caso, a solicitação pode usar 100% da taxa de transferência da partição.

Para obter mais informações, visite [Bucketing de taxa de transferência do Cosmos DB](https://aka.ms/cosmsodb-bucketing).

Detalhes da propriedade

accessCondition

Condições associadas à solicitação.

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

Valor da propriedade

{ condition: string, type: string }

contentResponseOnWriteEnabled

Se definido como false, o serviço não retornará a carga na resposta. Ele reduz a rede e a carga da CPU ao não enviar a carga útil de volta pela rede. O valor padrão é verdadeiro.

NOTA: Atualmente, essa opção só tem suporte para operações em massa e em lote.

contentResponseOnWriteEnabled?: boolean

Valor da propriedade

boolean

disableAutomaticIdGeneration

Desabilitar a geração automática de ID (fará com que as crias falhem se a ID não estiver na definição)

disableAutomaticIdGeneration?: boolean

Valor da propriedade

boolean

enableScriptLogging

Habilita ou desabilita o registro em log em procedimentos armazenados do JavaScript.

enableScriptLogging?: boolean

Valor da propriedade

boolean

indexingDirective

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

indexingDirective?: string

Valor da propriedade

string

offerThroughput

A taxa de transferência da oferta provisionada para um contêiner na medida de Solicitações por Unidade.

offerThroughput?: number

Valor da propriedade

number

offerType

Tipo de oferta ao criar contêineres de documento.

Essa opção só é válida ao criar um contêiner de documento.

offerType?: string

Valor da propriedade

string

populateQuotaInfo

Habilita/desabilita a obtenção de estatísticas relacionadas à cota de contêiner de documentos para solicitações de leitura de contêiner de documento.

populateQuotaInfo?: boolean

Valor da propriedade

boolean

postTriggerInclude

Indica qual é o gatilho de postagem a ser invocado após a operação.

postTriggerInclude?: string | string[]

Valor da propriedade

string | string[]

preTriggerInclude

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

preTriggerInclude?: string | string[]

Valor da propriedade

string | string[]

resourceTokenExpirySeconds

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

resourceTokenExpirySeconds?: number

Valor da propriedade

number

urlConnection

(Caso de uso avançado) A URL à qual se conectar.

urlConnection?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

abortSignal para passar para todas as solicitações de rede subjacentes criadas por essa chamada de método. Consulte https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exemplo

Cancelar uma solicitação de leitura

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

Valor da propriedade

AbortSignal

Herdado deSharedOptions.abortSignal

bypassIntegratedCache

Define se o cache integrado deve ser ignorado ou habilitado para a solicitação no serviço do Azure CosmosDB.

O valor padrão é falso. Por padrão, o cache integrado está habilitado

bypassIntegratedCache?: boolean

Valor da propriedade

boolean

herdado deSharedOptions.bypassIntegratedCache

consistencyLevel

Nível de consistência exigido pelo cliente.

consistencyLevel?: string

Valor da propriedade

string

Herdado deSharedOptions.consistencyLevel

disableRUPerMinuteUsage

DisableRUPerMinuteUsage é usado para habilitar/desabilitar a capacidade de RUs (Unidades de Solicitação)/minuto para atender à solicitação se RUs/segundo provisionados regulares estiverem esgotados.

disableRUPerMinuteUsage?: boolean

Valor da propriedade

boolean

Herdado deSharedOptions.disableRUPerMinuteUsage

initialHeaders

(Caso de uso avançado) Cabeçalhos iniciais a serem iniciados ao enviar solicitações para o Cosmos

initialHeaders?: CosmosHeaders

Valor da propriedade

CosmosHeaders

herdado deSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Define o valor de desatualização associado à solicitação no serviço do Azure CosmosDB. Para solicitações em que o <xref:com.azure.cosmos.ConsistencyLevel> é <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, as respostas do cache integrado não são mais obsoletas do que o valor indicado por esse maxIntegratedCacheStaleness. Quando o nível de consistência não é definido, essa propriedade é ignorada.

O valor padrão é nulo

Há suporte para desatualização do cache na granularidade de milissegundos. Qualquer coisa menor que milissegundos será ignorada.

maxIntegratedCacheStalenessInMs?: number

Valor da propriedade

number

Herdado deSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Nível de prioridade (baixo/alto) para cada solicitação. As solicitações de baixa prioridade são sempre limitadas antes de solicitações de alta prioridade.

O valor padrão é nulo. Por padrão, todas as solicitações são de alta prioridade

priorityLevel?: PriorityLevel

Valor da propriedade

PriorityLevel

Herdado deSharedOptions.priorityLevel

sessionToken

Habilita/desabilita a obtenção de estatísticas relacionadas à cota de contêiner de documentos para solicitações de leitura de contêiner de documento.

sessionToken?: string

Valor da propriedade

string

Herdado deSharedOptions.sessionToken

throughputBucket

Bucket de taxa de transferência para uma solicitação.

O valor padrão é nulo. Nesse caso, a solicitação pode usar 100% da taxa de transferência da partição.

Para obter mais informações, visite [Bucketing de taxa de transferência do Cosmos DB](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Valor da propriedade

number

Herdado deSharedOptions.throughputBucket