CosmosClientOptions クラス

定義

名前空間:

Azure.Cosmos

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

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

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonCosmosClientOptionsConverter))]
public class CosmosClientOptions : Azure.Core.ClientOptions

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonCosmosClientOptionsConverter))>]
type CosmosClientOptions = class
    inherit ClientOptions

Public Class CosmosClientOptions
Inherits ClientOptions

継承

Object

ClientOptions

CosmosClientOptions

属性

JsonConverterAttribute

例

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

CosmosClient クライアント = 新しい CosmosClient("endpoint", "key", clientOptions);

コンストラクター

CosmosClientOptions()

新しい CosmosClientOptions を作成します

プロパティ

ApplicationName	Azure Cosmos DB サービスのすべての操作に含めるユーザー エージェント サフィックスを取得または設定します。
ApplicationRegion	Azure Cosmos DB サービスの操作に使用する優先 geo レプリケート リージョンを取得または設定します。
ConnectionMode	Azure Cosmos DB サービスに接続するときにクライアントによって使用される接続モードを取得または設定します。
ConsistencyLevel	これは、読み取り操作のデータベース アカウントの整合性レベルを弱めるために使用できます。 これが設定されていない場合は、データベース アカウントの整合性レベルがすべての要求に使用されます。
Diagnostics	クライアント診断オプションを取得します。 (継承元 ClientOptions)
GatewayModeMaxConnectionLimit	Azure Cosmos DB サービスのターゲット サービス エンドポイントに対して許可される同時接続の最大数を取得または設定します。
IdleTcpConnectionTimeout	(Direct/TCP)未使用の接続を閉じるアイドル時間を制御します。
LimitToEndpoint	CosmosClient で指定されたエンドポイントに操作を制限します。
MaxRequestsPerTcpConnection	(Direct/TCP)1 つの TCP 接続で同時に許可される要求の数を制御します。 より多くの要求が同時に送信されると、ダイレクト/TCP クライアントは追加の接続を開きます。
MaxRetryAttemptsOnRateLimitedRequests	レート調整された要求でクライアントが再試行する回数を取得または設定します。
MaxRetryWaitTimeOnRateLimitedRequests	レート調整された要求でクライアントが再試行できる最大時間を取得または設定します。
MaxTcpConnectionsPerEndpoint	(Direct/TCP)各 Cosmos DB バックエンドに対して開くことができる TCP 接続の最大数を制御します。 MaxRequestsPerTcpConnection と共に、この設定では、1 つの Cosmos DB バックエンドに同時に送信される要求の数を制限します (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint)。
OpenTcpConnectionTimeout	(Direct/TCP)接続の確立に許可される時間を制御します。
RequestTimeout	Azure Cosmos DB サービスに接続するときの要求タイムアウトを秒単位で取得します。 この数値は、ネットワーク ピアから応答が返されるのを待つ時間を指定します。
Retry	クライアントの再試行オプションを取得します。 (継承元 ClientOptions)
RetryPolicy	再試行に使用するポリシーを取得または設定します。 ポリシーが指定されている場合は、 プロパティの Retry 代わりに使用されます。 型を RetryPolicy から派生して、再試行ロジックを完全に実装しなくても、既定の動作を変更できます。 がオーバーライドされるか、カスタムHttpPipelinePolicyが指定されている場合Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>)、値を更新するのは実装者のProcessingContext責任です。 (継承元 ClientOptions)
Serializer	省略可能な JSON シリアライザーを設定するために取得します。 クライアントはそれを使用して、ユーザーの cosmos 要求/応答をシリアル化またはシリアル化解除します。 DatabaseProperties や ContainerProperties などの SDK 所有型では、常に SDK の既定のシリアライザーが使用されます。
SerializerOptions	オプションのシリアライザー オプションを設定するために取得します。
Transport	HttpPipelineTransportこのクライアントに使用する 。 既定値は の HttpClientTransportインスタンスです。 (継承元 ClientOptions)
WebProxy	(ゲートウェイ/Https)Web 要求に使用されるプロキシ情報を取得または設定します。

メソッド

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

クライアント パイプラインに HttpPipeline ポリシーを追加します。 パイプライン内のポリシーの位置は、 パラメーターによって position 制御されます。 ポリシーをクライアント要求ごとに 1 回実行する場合は、 を使用PerCallPerRetryして再試行ごとにポリシーを実行します。 の同じインスタンス policy は、この ClientOptions オブジェクトを使用して構築されたクライアントのすべてのパイプラインに追加されることに注意してください。 (継承元 ClientOptions)