ServiceClientOptions interface

パッケージ:

@azure/core-client

クライアントの作成時に指定するオプション。

Extends

CommonClientOptions

プロパティ

baseUri	指定した場合、これは、この ServiceClient に対して要求が行われるベース URI です。 指定しない場合、すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。
credential	要求の認証に使用される資格情報。
credentialScopes	指定した場合は、BearerTokenAuthenticationPolicy のビルドに使用されます。
endpoint	指定すると、この ServiceClient に対して要求が行われるエンドポイントになります。 指定しない場合、すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。 お客様にエンドポイントの使用を促すために、baseUri を非推奨としてマークします。
pipeline	使用するカスタマイズされたパイプライン。それ以外の場合は、既定のパイプラインが作成されます。
requestContentType	サービスの既定の要求コンテンツ タイプ。 OperationSpec に requestContentType が存在しない場合に使用されます。

継承されたプロパティ

additionalPolicies	HTTP パイプラインに含める追加のポリシー。
agent	送信要求のエージェント インスタンスを構成するためのオプション
allowInsecureConnection	要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
httpClient	HTTP 要求の送信に使用される HttpClient。
proxyOptions	送信要求のプロキシを構成するためのオプション。
redirectOptions	リダイレクト応答の処理方法のオプション。
retryOptions	失敗した要求を再試行する方法を制御するオプション。
telemetryOptions	一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。
tlsOptions	TLS 認証を構成するためのオプション
userAgentOptions	送信要求にユーザー エージェントの詳細を追加するためのオプション。

プロパティの詳細

baseUri

警告

この API は非推奨になりました。

This property is deprecated and will be removed soon, please use endpoint instead

指定した場合、これは、この ServiceClient に対して要求が行われるベース URI です。 指定しない場合、すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。

baseUri?: string

プロパティ値

string

credential

要求の認証に使用される資格情報。

credential?: TokenCredential

プロパティ値

TokenCredential

credentialScopes

指定した場合は、BearerTokenAuthenticationPolicy のビルドに使用されます。

credentialScopes?: string | string[]

プロパティ値

string | string[]

endpoint

指定すると、この ServiceClient に対して要求が行われるエンドポイントになります。 指定しない場合、すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。 お客様にエンドポイントの使用を促すために、baseUri を非推奨としてマークします。

endpoint?: string

プロパティ値

string

pipeline

使用するカスタマイズされたパイプライン。それ以外の場合は、既定のパイプラインが作成されます。

pipeline?: Pipeline

プロパティ値

Pipeline

requestContentType

サービスの既定の要求コンテンツ タイプ。 OperationSpec に requestContentType が存在しない場合に使用されます。

requestContentType?: string

プロパティ値

string

継承されたプロパティの詳細

additionalPolicies

HTTP パイプラインに含める追加のポリシー。

additionalPolicies?: AdditionalPolicyConfig[]

プロパティ値

AdditionalPolicyConfig[]

継承元CommonClientOptions.additionalPolicies

agent

送信要求のエージェント インスタンスを構成するためのオプション

agent?: Agent

プロパティ値

Agent

継承元CommonClientOptions.agent

allowInsecureConnection

要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します

allowInsecureConnection?: boolean

プロパティ値

boolean

継承元CommonClientOptions.allowInsecureConnection

httpClient

HTTP 要求の送信に使用される HttpClient。

httpClient?: HttpClient

プロパティ値

HttpClient

継承元CommonClientOptions.httpClient

proxyOptions

送信要求のプロキシを構成するためのオプション。

proxyOptions?: ProxySettings

プロパティ値

ProxySettings

継承元CommonClientOptions.proxyOptions

redirectOptions

リダイレクト応答の処理方法のオプション。

redirectOptions?: RedirectPolicyOptions

プロパティ値

RedirectPolicyOptions

継承元CommonClientOptions.redirectOptions

retryOptions

失敗した要求を再試行する方法を制御するオプション。

retryOptions?: PipelineRetryOptions

プロパティ値

PipelineRetryOptions

継承元CommonClientOptions.retryOptions

telemetryOptions

一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。

telemetryOptions?: TelemetryOptions

プロパティ値

TelemetryOptions

継承元CommonClientOptions.telemetryOptions

tlsOptions

TLS 認証を構成するためのオプション

tlsOptions?: TlsSettings

プロパティ値

TlsSettings

継承元CommonClientOptions.tlsOptions

userAgentOptions

送信要求にユーザー エージェントの詳細を追加するためのオプション。

userAgentOptions?: UserAgentPolicyOptions

プロパティ値

UserAgentPolicyOptions

継承元CommonClientOptions.userAgentOptions