SearchClientOptions クラス

定義

名前空間:

Azure.Search.Documents

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

ソース:

SearchClientOptions.cs

Azure Cognitive Searchに接続するためのクライアント構成オプションを提供します。

public class SearchClientOptions : Azure.Core.ClientOptions

type SearchClientOptions = class
    inherit ClientOptions

Public Class SearchClientOptions
Inherits ClientOptions

継承

Object

ClientOptions

SearchClientOptions

コンストラクター

SearchClientOptions(SearchClientOptions+ServiceVersion)

SearchClientOptions クラスの新しいインスタンスを初期化します。

プロパティ

Audience	Azure Active Directory (AAD) での認証に使用する対象ユーザーを取得または設定します。 共有キーを使用する場合、対象ユーザーは考慮されません。
Diagnostics	クライアント診断オプションを取得します。 (継承元 ClientOptions)
Retry	クライアントの再試行オプションを取得します。 (継承元 ClientOptions)
RetryPolicy	再試行に使用するポリシーを取得または設定します。 ポリシーが指定されている場合は、 プロパティの Retry 代わりに使用されます。 型を RetryPolicy から派生して、再試行ロジックを完全に実装しなくても、既定の動作を変更できます。 がオーバーライドされるか、カスタムHttpPipelinePolicyが指定されている場合Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>)、値を更新するのは実装者のProcessingContext責任です。 (継承元 ClientOptions)
Serializer	厳密に型指定されたモデルのシリアル化をカスタマイズするために使用できる を取得または設定 ObjectSerializer します。 シリアライザーは JSON をサポートする必要があり、 JsonObjectSerializer 値が指定されていない場合は使用されます。
Transport	HttpPipelineTransportこのクライアントに使用する 。 既定値は の HttpClientTransportインスタンスです。 (継承元 ClientOptions)
Version	SearchClientOptions.ServiceVersion要求を行うときに使用されるサービス API の を取得します。 詳細については、次を参照してください。 Azure Cognitive Searchの API バージョン。

メソッド

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

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