Compartir a través de

SharedOptions interface

Paquete:
@azure/cosmos

Opciones que se pueden especificar para una solicitud emitida a los servidores de Azure Cosmos DB.=

Propiedades

abortSignal

abortSignal para pasar a todas las solicitudes de red subyacentes creadas por esta llamada de método. Vea https://developer.mozilla.org/en-US/docs/Web/API/AbortController.

Ejemplo

Cancelación de una solicitud de lectura

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

Establece si se debe omitir o habilitar la caché integrada para la solicitud en el servicio Azure CosmosDB.

El valor predeterminado es false. De forma predeterminada, la caché integrada está habilitada
consistencyLevel

Nivel de coherencia requerido por el cliente.
disableRUPerMinuteUsage

DisableRUPerMinuteUsage se usa para habilitar o deshabilitar la capacidad de unidades de solicitud(RU)/minuto para atender la solicitud si se agotan las RU aprovisionadas normales por segundo.
excludedLocations

Excluye una o varias regiones de Azure para la operación.

Esta opción solo se aplica cuando enableEndPointDiscovery se establece en true.
initialHeaders

(Caso de uso avanzado) Encabezados iniciales con los que empezar al enviar solicitudes a Cosmos
maxIntegratedCacheStalenessInMs

Establece el valor de obsolescencia asociado a la solicitud en el servicio Azure CosmosDB. En el caso de las solicitudes en las que el <xref:com.azure.cosmos.ConsistencyLevel> es <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> o <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, se garantiza que las respuestas de la caché integrada no sean obsoletas que el valor indicado por este maxIntegratedCacheStaleness. Cuando no se establece el nivel de coherencia, esta propiedad se omite.

El valor predeterminado es NULL

La obsolescencia de caché se admite en granularidad de milisegundos. Se omitirá cualquier cosa menor que milisegundos.
priorityLevel

Nivel de prioridad (bajo/alto) para cada solicitud. Las solicitudes de prioridad baja siempre se limitan antes de las solicitudes de prioridad alta.

El valor predeterminado es NULL. De forma predeterminada, todas las solicitudes son de prioridad alta
sessionToken

Habilita o deshabilita la obtención de estadísticas relacionadas con la cuota de contenedor de documentos para las solicitudes de lectura del contenedor de documentos.
throughputBucket

Bucket de rendimiento para una solicitud.

El valor predeterminado es NULL. En este caso, la solicitud puede usar el 100% del rendimiento de la partición.

Para obtener más información, visite [Cubo de rendimiento de Cosmos DB](https://aka.ms/cosmsodb-bucketing).

Detalles de las propiedades

abortSignal

abortSignal para pasar a todas las solicitudes de red subyacentes creadas por esta llamada de método. Vea https://developer.mozilla.org/en-US/docs/Web/API/AbortController.

Ejemplo

Cancelación de una solicitud de lectura

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 de propiedad

AbortSignal

bypassIntegratedCache

Establece si se debe omitir o habilitar la caché integrada para la solicitud en el servicio Azure CosmosDB.

El valor predeterminado es false. De forma predeterminada, la caché integrada está habilitada

bypassIntegratedCache?: boolean

Valor de propiedad

boolean

consistencyLevel

Nivel de coherencia requerido por el cliente.

consistencyLevel?: string

Valor de propiedad

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage se usa para habilitar o deshabilitar la capacidad de unidades de solicitud(RU)/minuto para atender la solicitud si se agotan las RU aprovisionadas normales por segundo.

disableRUPerMinuteUsage?: boolean

Valor de propiedad

boolean

excludedLocations

Excluye una o varias regiones de Azure para la operación.

Esta opción solo se aplica cuando enableEndPointDiscovery se establece en true.

excludedLocations?: string[]

Valor de propiedad

string[]

initialHeaders

(Caso de uso avanzado) Encabezados iniciales con los que empezar al enviar solicitudes a Cosmos

initialHeaders?: CosmosHeaders

Valor de propiedad

CosmosHeaders

maxIntegratedCacheStalenessInMs

Establece el valor de obsolescencia asociado a la solicitud en el servicio Azure CosmosDB. En el caso de las solicitudes en las que el <xref:com.azure.cosmos.ConsistencyLevel> es <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> o <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, se garantiza que las respuestas de la caché integrada no sean obsoletas que el valor indicado por este maxIntegratedCacheStaleness. Cuando no se establece el nivel de coherencia, esta propiedad se omite.

El valor predeterminado es NULL

La obsolescencia de caché se admite en granularidad de milisegundos. Se omitirá cualquier cosa menor que milisegundos.

maxIntegratedCacheStalenessInMs?: number

Valor de propiedad

number

priorityLevel

Nivel de prioridad (bajo/alto) para cada solicitud. Las solicitudes de prioridad baja siempre se limitan antes de las solicitudes de prioridad alta.

El valor predeterminado es NULL. De forma predeterminada, todas las solicitudes son de prioridad alta

priorityLevel?: PriorityLevel

Valor de propiedad

PriorityLevel

sessionToken

Habilita o deshabilita la obtención de estadísticas relacionadas con la cuota de contenedor de documentos para las solicitudes de lectura del contenedor de documentos.

sessionToken?: string

Valor de propiedad

string

throughputBucket

Bucket de rendimiento para una solicitud.

El valor predeterminado es NULL. En este caso, la solicitud puede usar el 100% del rendimiento de la partición.

Para obtener más información, visite [Cubo de rendimiento de Cosmos DB](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Valor de propiedad

number