ConnectionPolicy interface

パッケージ:

@azure/cosmos

Azure Cosmos DB データベース サービスの CosmosClient に関連付けられている接続ポリシーを表します。

プロパティ

connectionMode	Cosmos に接続するモードを決定します。 (現在、ゲートウェイ オプションのみがサポートされています)
enableBackgroundEndpointRefreshing	エンドポイントのバックグラウンド更新を有効または無効にするフラグ。 既定値は false です。 を使用した enableEndpointsDiscovery エンドポイント検出は、失敗した要求に対して引き続き機能します。
enableEndpointDiscovery	読み取り/書き込み操作に基づいて要求の自動リダイレクトを有効または無効にするフラグ。 既定値は true です。 別のプロセスまたはブラウザー内で CosmosClient を破棄した後、これが true に設定されている場合に client.dispose() を呼び出すために必要です。
endpointRefreshRateInMs	クライアントがバックグラウンドでエンドポイント リストを更新する時間 (ミリ秒単位)
preferredLocations	読み取り要求の推奨される場所として使用される Azure リージョンの一覧。
requestTimeout	要求のタイムアウト (ネットワーク ピアからの応答を待機する時間)。 ミリ秒単位で表されます。
retryOptions	再試行中に使用される構成可能なプロパティをいくつか定義する RetryOptions オブジェクト。
useMultipleWriteLocations	Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) に対する書き込みを有効にするフラグ。 既定値は false です。

プロパティの詳細

connectionMode

Cosmos に接続するモードを決定します。 (現在、ゲートウェイ オプションのみがサポートされています)

connectionMode?: Gateway

プロパティ値

Gateway

enableBackgroundEndpointRefreshing

エンドポイントのバックグラウンド更新を有効または無効にするフラグ。 既定値は false です。 を使用した enableEndpointsDiscovery エンドポイント検出は、失敗した要求に対して引き続き機能します。

enableBackgroundEndpointRefreshing?: boolean

プロパティ値

boolean

enableEndpointDiscovery

読み取り/書き込み操作に基づいて要求の自動リダイレクトを有効または無効にするフラグ。 既定値は true です。 別のプロセスまたはブラウザー内で CosmosClient を破棄した後、これが true に設定されている場合に client.dispose() を呼び出すために必要です。

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 サービス内の geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) に対する書き込みを有効にするフラグ。 既定値は false です。

useMultipleWriteLocations?: boolean

プロパティ値

boolean