ServiceClientOptions interface
クライアントの作成時に指定するオプション。
- Extends
プロパティ
| base |
指定した場合、これは、この ServiceClient に対して要求が行われるベース URI です。 指定しない場合は、すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。 |
| credential | 要求の認証に使用される資格情報。 |
| credential |
指定した場合は、 を使用して BearerTokenAuthenticationPolicy をビルドします。 |
| endpoint | 指定した場合、これは、この ServiceClient に対して要求が行われるエンドポイントです。 指定しない場合は、すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。 お客様にエンドポイントの使用を促すために、baseUri を非推奨としてマークします。 |
| pipeline | 使用するカスタマイズされたパイプライン。それ以外の場合は、既定のパイプラインが作成されます。 |
| request |
サービスの既定の要求コンテンツ タイプ。 OperationSpec に requestContentType が存在しない場合に使用されます。 |
継承されたプロパティ
| additional |
HTTP パイプラインに含める追加のポリシー。 |
| allow |
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します |
| http |
HTTP 要求の送信に使用される HttpClient。 |
| proxy |
送信要求のプロキシを構成するためのオプション。 |
| redirect |
リダイレクト応答の処理方法のオプション。 |
| retry |
失敗した要求を再試行する方法を制御するオプション。 |
| telemetry |
一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。 |
| tls |
TLS 認証を構成するためのオプション |
| user |
送信要求にユーザー エージェントの詳細を追加するためのオプション。 |
プロパティの詳細
baseUri
警告
この API は非推奨になりました。
This property is deprecated and will be removed soon, please use endpoint instead
指定した場合、これは、この ServiceClient に対して要求が行われるベース URI です。 指定しない場合は、すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。
baseUri?: stringプロパティ値
string
credential
credentialScopes
指定した場合は、 を使用して BearerTokenAuthenticationPolicy をビルドします。
credentialScopes?: string | string[]プロパティ値
string | string[]
endpoint
指定した場合、これは、この ServiceClient に対して要求が行われるエンドポイントです。 指定しない場合は、すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。 お客様にエンドポイントの使用を促すために、baseUri を非推奨としてマークします。
endpoint?: stringプロパティ値
string
pipeline
requestContentType
サービスの既定の要求コンテンツ タイプ。 OperationSpec に requestContentType が存在しない場合に使用されます。
requestContentType?: stringプロパティ値
string
継承されたプロパティの詳細
additionalPolicies
HTTP パイプラインに含める追加のポリシー。
additionalPolicies?: AdditionalPolicyConfig[]プロパティ値
allowInsecureConnection
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
allowInsecureConnection?: booleanプロパティ値
boolean
httpClient
HTTP 要求の送信に使用される HttpClient。
httpClient?: HttpClientプロパティ値
proxyOptions
送信要求のプロキシを構成するためのオプション。
proxyOptions?: ProxySettingsプロパティ値
redirectOptions
リダイレクト応答の処理方法のオプション。
redirectOptions?: RedirectPolicyOptionsプロパティ値
retryOptions
失敗した要求を再試行する方法を制御するオプション。
retryOptions?: PipelineRetryOptionsプロパティ値
telemetryOptions
一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。
telemetryOptions?: TelemetryOptionsプロパティ値
tlsOptions
userAgentOptions
送信要求にユーザー エージェントの詳細を追加するためのオプション。
userAgentOptions?: UserAgentPolicyOptions