SharedOptions interface

abandonnerSignal pour passer à toutes les demandes réseau sous-jacentes créées par cet appel de méthode. Voir https://developer.mozilla.org/en-US/docs/Web/API/AbortController

exemple

Annuler une demande de lecture

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

Valeur de propriété

Définit si le cache intégré doit être contourné ou activé pour la requête dans le service Azure CosmosDB.

La valeur par défaut est false. Par défaut, le cache intégré est activé

bypassIntegratedCache?: boolean

Valeur de propriété

Niveau de cohérence requis par le client.

consistencyLevel?: string

Valeur de propriété

DisableRUPerMinuteUsage est utilisé pour activer/désactiver la capacité des unités de requête(RU)/minute pour traiter la requête si des unités de requête approvisionnées/seconde régulières sont épuisées.

disableRUPerMinuteUsage?: boolean

Valeur de propriété

Exclut une ou plusieurs régions Azure pour l’opération.

Cette option n’est appliquée que lorsque enableEndPointDiscovery est défini sur true.

excludedLocations?: string[]

Valeur de propriété

(Cas d’usage avancé) En-têtes initiaux à démarrer lors de l’envoi de requêtes à Cosmos

initialHeaders?: CosmosHeaders

Valeur de propriété

Définit la valeur d’obsolescence associée à la requête dans le service Azure CosmosDB. Pour les demandes où l'<xref:com.azure.cosmos.ConsistencyLevel> est <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, les réponses du cache intégré ne sont pas garanties d’être plus staler que la valeur indiquée par ce maxIntegratedCacheStaleness. Lorsque le niveau de cohérence n’est pas défini, cette propriété est ignorée.

La valeur par défaut est Null

L’obsolescence du cache est prise en charge en millisecondes de granularité. Tout ce qui est inférieur à millisecondes est ignoré.

maxIntegratedCacheStalenessInMs?: number

Valeur de propriété

Niveau de priorité (faible/élevé) pour chaque requête. Les requêtes de faible priorité sont toujours limitées avant toutes les demandes de priorité élevée.

La valeur par défaut est Null. Par défaut, toutes les requêtes sont de priorité élevée

priorityLevel?: PriorityLevel

Valeur de propriété

Active/désactive l’obtention des statistiques relatives au quota de conteneurs de documents pour les demandes de lecture de conteneur de documents.

sessionToken?: string

Valeur de propriété

Débit Bucket pour une demande.

La valeur par défaut est Null. Dans ce cas, la demande peut utiliser 100% du débit de la partition.

Pour plus d’informations, consultez [Bucketing de débit Cosmos DB](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Valeur de propriété