ConnectionPolicy interface

Пакет:

@azure/cosmos

Представляет политику подключения, связанную с CosmosClient в службе базы данных Azure Cosmos DB.

Свойства

connectionMode	Определяет режим подключения к Cosmos. (Сейчас поддерживается только параметр шлюза)
enableBackgroundEndpointRefreshing	Пометка для включения или отключения фонового обновления конечных точек. Значение по умолчанию — false. Обнаружение конечных точек с помощью enableEndpointsDiscovery по-прежнему будет работать для неудачных запросов.
enableEndpointDiscovery	Флаг для включения или отключения автоматического перенаправления запросов на основе операций чтения и записи. Значение по умолчанию — true. Требуется для вызова client.dispose(), если для параметра задано значение true после удаления CosmosClient в другом процессе или в браузере.
endpointRefreshRateInMs	Частота в миллисекундах, с которой клиент будет обновлять список конечных точек в фоновом режиме
preferredLocations	Список регионов Azure, которые будут использоваться в качестве предпочтительных расположений для запросов на чтение.
requestTimeout	Время ожидания запроса (время ожидания ответа от однорангового узла сети). Представлено в миллисекундах.
retryOptions	Объект RetryOptions, который определяет несколько настраиваемых свойств, используемых во время повторных попыток.
useMultipleWriteLocations	Флаг, позволяющий выполнять запись в любых расположениях (регионах) для геореплицированных учетных записей баз данных в службе Azure Cosmos DB. По умолчанию — false.

Сведения о свойстве

connectionMode

Определяет режим подключения к Cosmos. (Сейчас поддерживается только параметр шлюза)

connectionMode?: Gateway

Значение свойства

Gateway

enableBackgroundEndpointRefreshing

Пометка для включения или отключения фонового обновления конечных точек. Значение по умолчанию — false. Обнаружение конечных точек с помощью enableEndpointsDiscovery по-прежнему будет работать для неудачных запросов.

enableBackgroundEndpointRefreshing?: boolean

Значение свойства

boolean

enableEndpointDiscovery

Флаг для включения или отключения автоматического перенаправления запросов на основе операций чтения и записи. Значение по умолчанию — true. Требуется для вызова client.dispose(), если для параметра задано значение true после удаления CosmosClient в другом процессе или в браузере.

enableEndpointDiscovery?: boolean

Значение свойства

boolean

endpointRefreshRateInMs

Частота в миллисекундах, с которой клиент будет обновлять список конечных точек в фоновом режиме

endpointRefreshRateInMs?: number

Значение свойства

number

preferredLocations

Список регионов Azure, которые будут использоваться в качестве предпочтительных расположений для запросов на чтение.

preferredLocations?: string[]

Значение свойства

string[]

requestTimeout

Время ожидания запроса (время ожидания ответа от однорангового узла сети). Представлено в миллисекундах.

requestTimeout?: number

Значение свойства

number

retryOptions

Объект RetryOptions, который определяет несколько настраиваемых свойств, используемых во время повторных попыток.

retryOptions?: RetryOptions

Значение свойства

RetryOptions

useMultipleWriteLocations

Флаг, позволяющий выполнять запись в любых расположениях (регионах) для геореплицированных учетных записей баз данных в службе Azure Cosmos DB. По умолчанию — false.

useMultipleWriteLocations?: boolean

Значение свойства

boolean