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