CosmosClientOptions クラス

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.36.0

CosmosClient に必要なすべての構成可能なオプションを定義します。

public class CosmosClientOptions

type CosmosClientOptions = class

Public Class CosmosClientOptions

継承

Object

CosmosClientOptions

例

null 値を無視するようにシリアル化オプションを構成する方法の例。

CosmosClientOptions clientOptions = new CosmosClientOptions()
{
    SerializerOptions = new CosmosSerializationOptions(){
        IgnoreNullValues = true
    },
    ConnectionMode = ConnectionMode.Gateway,
};

CosmosClient client = new CosmosClient("endpoint", "key", clientOptions);

コンストラクター

CosmosClientOptions()

新しい CosmosClientOptions を作成します

プロパティ

AllowBulkExecution	サービスへの要求のオプティミスティック バッチ処理を許可します。 このオプションを設定すると、操作の待機時間に影響する可能性があります。 そのため、このオプションは、待機時間に依存しないシナリオにのみ推奨されます。
ApplicationName	Azure Cosmos DB サービスのすべての対話に含めるユーザー エージェント サフィックスを取得または設定します。
ApplicationPreferredRegions	Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの優先リージョンを取得および設定します。
ApplicationRegion	アプリケーションが実行されている場所を取得または設定します。 これは、Azure Cosmos DB サービスの相互作用に対する SDK の選択に影響します。
ConnectionMode	Azure Cosmos DB サービスに接続するときにクライアントによって使用される接続モードを取得または設定します。
ConsistencyLevel	これは、読み取り操作のデータベース アカウントの整合性レベルを弱めるために使用できます。 これが設定されていない場合、データベース アカウントの整合性レベルはすべての要求に使用されます。
CosmosClientTelemetryOptions	機能フラグや対応するオプションなどのクライアント テレメトリ オプションを取得または設定します
CustomHandlers	プロセスの前に実行されるハンドラーを取得します
EnableContentResponseOnWrite	Create、Upsert、Patch、Replace などの書き込み項目操作の Cosmos DB 応答のヘッダーと状態コードのみを返すブール値を取得または設定します。 オプションを false に設定すると、応答に null リソースが設定されます。 これにより、リソースをネットワーク経由で返送せず、クライアントでシリアル化することで、ネットワークと CPU の負荷が軽減されます。
EnableTcpConnectionEndpointRediscovery	TCP 接続リセット通知でアドレス キャッシュの更新を有効にするフラグを取得または設定します。
GatewayModeMaxConnectionLimit	Azure Cosmos DB サービスのターゲット サービス エンドポイントに対して許可される同時接続の最大数を取得または設定します。
HttpClientFactory	HTTPS 通信に使用する HttpClient インスタンスを取得するために使用するデリゲートを取得または設定します。
IdleTcpConnectionTimeout	(Direct/TCP)未使用の接続を閉じるアイドル時間を制御します。
LimitToEndpoint	CosmosClient で指定されたエンドポイントに操作を制限します。
MaxRequestsPerTcpConnection	(Direct/TCP)1 つの TCP 接続で同時に許可される要求の数を制御します。 さらに多くの要求が同時に送信されると、ダイレクト/TCP クライアントは追加の接続を開きます。
MaxRetryAttemptsOnRateLimitedRequests	Azure Cosmos DB サービスがクライアントにレート制限を適用したために要求が失敗した場合の最大再試行回数を取得または設定します。
MaxRetryWaitTimeOnRateLimitedRequests	Azure Cosmos DB サービスの最大再試行時間を秒単位で取得または設定します。
MaxTcpConnectionsPerEndpoint	(Direct/TCP)各 Cosmos DB バックエンドに対して開くことができる TCP 接続の最大数を制御します。 MaxRequestsPerTcpConnection と合わせて、この設定は、1 つの Cosmos DB バックエンドに同時に送信される要求の数を制限します (MaxRequestsPerTcpConnection と MaxTcpConnectionPerEndpoint の掛け算)。
OpenTcpConnectionTimeout	(Direct/TCP)接続の確立に許容される時間を制御します。
PortReuseMode	(Direct/TCP)トランスポート スタックで使用されるクライアント ポート再利用ポリシーを制御します。
RequestTimeout	Azure Cosmos DB サービスに接続するときの要求タイムアウトを秒単位で取得します。 この数値は、応答がネットワーク ピアから返されるのを待機する時間を指定します。
Serializer	省略可能な JSON シリアライザーを設定する を取得します。 クライアントはそれを使用して、ユーザーの cosmos 要求/応答をシリアル化またはシリアル化解除します。 DatabaseProperties や ContainerProperties などの SDK 所有型は、常に SDK の既定のシリアライザーを使用します。
SerializerOptions	オプションのシリアライザー オプションを設定する を取得します。
ServerCertificateCustomValidationCallback	HTTP と TCP の両方に対してカスタム証明書の検証を行うコールバック デリゲート。
TokenCredentialBackgroundRefreshInterval	SDK は、トークン資格情報を更新するために設定された時間間隔に基づいてバックグラウンド更新を行います。 これにより、新しいトークンが取得されるまで古いトークンが使用されるため、待機時間の問題を回避できます。
WebProxy	(ゲートウェイ/Https)Web 要求に使用されるプロキシ情報を取得または設定します。