ConnectionPolicy interface

Paquet:

@azure/cosmos

Représente la stratégie de connexion associée à un CosmosClient dans le service de base de données Azure Cosmos DB.

Propriétés

connectionMode	Détermine le mode avec lequel se connecter à Cosmos. (Actuellement, prend uniquement en charge l’option passerelle)
enableBackgroundEndpointRefreshing	Indicateur pour activer/désactiver l’actualisation en arrière-plan des points de terminaison. La valeur par défaut est true. La découverte de points de terminaison à l’aide de enableEndpointsDiscovery fonctionne toujours pour les demandes ayant échoué.
enableEndpointDiscovery	Indicateur permettant d’activer/désactiver la redirection automatique des requêtes en fonction des opérations de lecture/écriture. Valeur true par défaut. Obligatoire pour appeler client.dispose() quand cette valeur est définie sur true après avoir détruit CosmosClient à l’intérieur d’un autre processus ou dans le navigateur.
enablePartitionLevelCircuitBreaker	Indicateur pour activer/désactiver le disjoncteur par niveau de partition (PPCB). La valeur par défaut est false. Remarque : Nécessite enableEndpointDiscovery d’être true. Si la découverte des points de terminaison est désactivée, ce paramètre n’a aucun effet.
enablePartitionLevelFailover	Indicateur permettant d’activer/désactiver le basculement par niveau de partition (PPAF). La valeur par défaut est true. Bascule automatiquement vers d’autres partitions disponibles lorsqu’une partition devient indisponible. Lorsqu’il est activé, enablePartitionLevelCircuitBreaker est également défini sur true. Remarque : L’activation dynamique exige que et enableEndpointDiscoveryenableBackgroundEndpointRefreshing soit .true Si la découverte des points de terminaison est désactivée, ce paramètre n’a aucun effet.
endpointRefreshRateInMs	Taux en millisecondes au niveau duquel le client actualise la liste des points de terminaison en arrière-plan
preferredLocations	Liste des régions Azure à utiliser comme emplacements préférés pour les demandes de lecture.
requestTimeout	Délai d’expiration de la demande (délai d’attente de la réponse de l’homologue réseau). Représenté en millisecondes.
retryOptions	Objet RetryOptions qui définit plusieurs propriétés configurables utilisées lors de la nouvelle tentative.
useMultipleWriteLocations	Indicateur qui active les écritures sur tous les emplacements (régions) pour les comptes de base de données géorépliqués dans le service Azure Cosmos DB. La valeur par défaut est true.

Détails de la propriété

connectionMode

Détermine le mode avec lequel se connecter à Cosmos. (Actuellement, prend uniquement en charge l’option passerelle)

connectionMode?: Gateway

Valeur de propriété

Gateway

enableBackgroundEndpointRefreshing

Indicateur pour activer/désactiver l’actualisation en arrière-plan des points de terminaison. La valeur par défaut est true. La découverte de points de terminaison à l’aide de enableEndpointsDiscovery fonctionne toujours pour les demandes ayant échoué.

enableBackgroundEndpointRefreshing?: boolean

Valeur de propriété

boolean

enableEndpointDiscovery

Indicateur permettant d’activer/désactiver la redirection automatique des requêtes en fonction des opérations de lecture/écriture. Valeur true par défaut. Obligatoire pour appeler client.dispose() quand cette valeur est définie sur true après avoir détruit CosmosClient à l’intérieur d’un autre processus ou dans le navigateur.

enableEndpointDiscovery?: boolean

Valeur de propriété

boolean

enablePartitionLevelCircuitBreaker

Indicateur pour activer/désactiver le disjoncteur par niveau de partition (PPCB). La valeur par défaut est false. Remarque : Nécessite enableEndpointDiscovery d’être true. Si la découverte des points de terminaison est désactivée, ce paramètre n’a aucun effet.

enablePartitionLevelCircuitBreaker?: boolean

Valeur de propriété

boolean

enablePartitionLevelFailover

Indicateur permettant d’activer/désactiver le basculement par niveau de partition (PPAF). La valeur par défaut est true. Bascule automatiquement vers d’autres partitions disponibles lorsqu’une partition devient indisponible. Lorsqu’il est activé, enablePartitionLevelCircuitBreaker est également défini sur true. Remarque : L’activation dynamique exige que et enableEndpointDiscoveryenableBackgroundEndpointRefreshing soit .true Si la découverte des points de terminaison est désactivée, ce paramètre n’a aucun effet.

enablePartitionLevelFailover?: boolean

Valeur de propriété

boolean

endpointRefreshRateInMs

Taux en millisecondes au niveau duquel le client actualise la liste des points de terminaison en arrière-plan

endpointRefreshRateInMs?: number

Valeur de propriété

number

preferredLocations

Liste des régions Azure à utiliser comme emplacements préférés pour les demandes de lecture.

preferredLocations?: string[]

Valeur de propriété

string[]

requestTimeout

Délai d’expiration de la demande (délai d’attente de la réponse de l’homologue réseau). Représenté en millisecondes.

requestTimeout?: number

Valeur de propriété

number

retryOptions

Objet RetryOptions qui définit plusieurs propriétés configurables utilisées lors de la nouvelle tentative.

retryOptions?: RetryOptions

Valeur de propriété

RetryOptions

useMultipleWriteLocations

Indicateur qui active les écritures sur tous les emplacements (régions) pour les comptes de base de données géorépliqués dans le service Azure Cosmos DB. La valeur par défaut est true.

useMultipleWriteLocations?: boolean

Valeur de propriété

boolean