CosmosClientBuilder クラス

定義

名前空間:

Microsoft.Azure.Cosmos.Fluent

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.36.0

これは、Cosmos クライアントを作成する Builder クラスです

public class CosmosClientBuilder

type CosmosClientBuilder = class

Public Class CosmosClientBuilder

継承

Object

CosmosClientBuilder

コンストラクター

CosmosClientBuilder(String)	接続文字列からアカウント エンドポイントとキーを抽出します。
CosmosClientBuilder(String, AzureKeyCredential)	アカウント エンドポイント URI 文字列と AzureKeyCredential を使用して、CosmosClient に必要なすべてのプロパティを保持する新しい CosmosConfiguration クラスを初期化します。 AzureKeyCredential を使用すると、CosmosClient がまだ使用されている間に master-key/ResourceToken を変更/更新できます。
CosmosClientBuilder(String, String)	CosmosClient に必要なすべてのプロパティを保持する新しい CosmosConfiguration クラスを初期化します。
CosmosClientBuilder(String, TokenCredential)	インスタンスを使用して新しい CosmosClientBuilder を TokenCredential 初期化します。

メソッド

AddCustomHandlers(RequestHandler[])	カスタム ハンドラーの配列を要求に設定します。 ハンドラーは、一覧表示されている順序でチェーンされます。 パイプラインでハンドラーをチェーンできるようにするには、InvokerHandler.InnerHandler を null にする必要があります。
Build()	Cosmos クライアント CosmosClient を作成するメソッドは、スレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
BuildAndInitializeAsync(IReadOnlyList<ValueTuple<String,String>>, CancellationToken)	Cosmos クライアントを作成し、指定されたコンテナーを初期化するメソッド。 また、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動中の待機時間を短縮します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
WithApplicationName(String)	Azure Cosmos DB サービスの既定のユーザー エージェントに追加するサフィックス。
WithApplicationPreferredRegions(IReadOnlyList<String>)	Azure Cosmos DB サービスで geo レプリケートされたデータベース アカウントの優先リージョンを設定します。
WithApplicationRegion(String)	Azure Cosmos DB サービスで使用する優先 geo レプリケートリージョンを設定します。
WithBulkExecution(Boolean)	サービスへの要求のオプティミスティック バッチ処理を許可します。 このオプションを設定すると、操作の待機時間に影響する可能性があります。 そのため、このオプションは、待機時間に依存しないシナリオでのみ推奨されます。
WithClientTelemetryOptions(CosmosClientTelemetryOptions)	対応するオプションでテレメトリ機能を有効にするには
WithConnectionModeDirect()	接続モードを Direct に設定します。 これは、Azure Cosmos DB サービスに接続するときにクライアントによって使用されます。
WithConnectionModeDirect(Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<PortReuseMode>, Nullable<Boolean>)	接続モードを Direct に設定します。 これは、Azure Cosmos DB サービスに接続するときにクライアントによって使用されます。
WithConnectionModeGateway(Nullable<Int32>, IWebProxy)	接続モードをゲートウェイに設定します。 これは、Azure Cosmos DB サービスに接続するときにクライアントによって使用されます。
WithConsistencyLevel(ConsistencyLevel)	これは、読み取り操作のデータベース アカウントの整合性レベルを弱めるために使用できます。 これが設定されていない場合は、データベース アカウントの整合性レベルがすべての要求に使用されます。
WithContentResponseOnWrite(Boolean)	Create、Upsert、Patch、Replace などの書き込み項目操作の Cosmos DB 応答のヘッダーと状態コードのみを返すブール値を取得または設定します。 オプションを false に設定すると、応答に null リソースが設定されます。 これにより、ネットワーク経由でリソースを返送せず、クライアントでシリアル化することで、ネットワークと CPU の負荷が軽減されます。
WithCustomSerializer(CosmosSerializer)	カスタム JSON シリアライザーを設定します。
WithHttpClientFactory(Func<HttpClient>)	HTTPS 通信に使用する HttpClient インスタンスを取得するために使用するデリゲートを設定します。
WithLimitToEndpoint(Boolean)	CosmosClientBuilder コンストラクターで指定されたエンドポイントに操作を制限します。
WithRequestTimeout(TimeSpan)	Azure Cosmos DB サービスに接続するときの要求タイムアウトを秒単位で設定します。
WithSerializerOptions(CosmosSerializationOptions)	カスタム シリアライザー オプションを設定します。
WithThrottlingRetryOptions(TimeSpan, Int32)	調整された要求で再試行するまでの最大待機時間と再試行の最大回数を設定します。