SearchClientOptions interface
Cognitive Search API 要求の構成に使用されるクライアント オプション。
- Extends
プロパティ
| api |
サービスと通信するときに使用する API バージョン。 |
| audience | Azure Active Directory (AAD) での認証に使用する対象ユーザー。 共有キーを使用する場合、対象ユーザーは考慮されません。 KnownSearchAudience は、対象ユーザーと同じ意味で使用できます |
| service |
サービスと通信するときに使用するサービスバージョン。 |
継承されたプロパティ
| additional |
HTTP パイプラインに含める追加のポリシー。 |
| allow |
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します |
| http |
HTTP 要求の送信に使用される HttpClient。 |
| keep |
キープアライブを無効にするオプション。 |
| proxy |
送信要求のプロキシを構成するためのオプション。 |
| redirect |
リダイレクト応答の処理方法のオプション。 |
| retry |
失敗した要求を再試行する方法を制御するオプション。 |
| telemetry |
一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。 |
| tls |
TLS 認証を構成するためのオプション |
| user |
送信要求にユーザー エージェントの詳細を追加するためのオプション。 |
プロパティの詳細
apiVersion
サービスと通信するときに使用する API バージョン。
apiVersion?: stringプロパティ値
string
audience
Azure Active Directory (AAD) での認証に使用する対象ユーザー。 共有キーを使用する場合、対象ユーザーは考慮されません。 KnownSearchAudience は、対象ユーザーと同じ意味で使用できます
audience?: stringプロパティ値
string
serviceVersion
サービスと通信するときに使用するサービスバージョン。
serviceVersion?: stringプロパティ値
string
継承されたプロパティの詳細
additionalPolicies
HTTP パイプラインに含める追加のポリシー。
additionalPolicies?: AdditionalPolicyConfig[]プロパティ値
継承元 ExtendedCommonClientOptions.additionalPolicies
allowInsecureConnection
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
allowInsecureConnection?: booleanプロパティ値
boolean
継承元 ExtendedCommonClientOptions.allowInsecureConnection
httpClient
HTTP 要求の送信に使用される HttpClient。
httpClient?: HttpClientプロパティ値
継承元 ExtendedCommonClientOptions.httpClient
keepAliveOptions
キープアライブを無効にするオプション。
keepAliveOptions?: KeepAliveOptionsプロパティ値
継承元 ExtendedCommonClientOptions.keepAliveOptions
proxyOptions
送信要求のプロキシを構成するためのオプション。
proxyOptions?: ProxySettingsプロパティ値
継承元 ExtendedCommonClientOptions.proxyOptions
redirectOptions
リダイレクト応答の処理方法のオプション。
redirectOptions?: RedirectPolicyOptions & RedirectOptionsプロパティ値
継承元 ExtendedCommonClientOptions.redirectOptions
retryOptions
失敗した要求を再試行する方法を制御するオプション。
retryOptions?: PipelineRetryOptionsプロパティ値
継承元 ExtendedCommonClientOptions.retryOptions
telemetryOptions
一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。
telemetryOptions?: TelemetryOptionsプロパティ値
継承元 ExtendedCommonClientOptions.telemetryOptions
tlsOptions
TLS 認証を構成するためのオプション
tlsOptions?: TlsSettingsプロパティ値
継承元 ExtendedCommonClientOptions.tlsOptions
userAgentOptions
送信要求にユーザー エージェントの詳細を追加するためのオプション。
userAgentOptions?: UserAgentPolicyOptionsプロパティ値
継承元 ExtendedCommonClientOptions.userAgentOptions