Share via

ServiceClientOptions interface

  • リファレンス
パッケージ:
@azure/ms-rest-js

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

プロパティ

agentSettings

すべての HTTP 要求に使用される HTTP エージェントと HTTPS エージェント (Node.jsのみ)。
baseUri

指定した場合:

  • これは baseUri 、この ServiceClient に対して要求が行われるベース URI になります。
  • が baseUri 既知のリソース マネージャー エンドポイントと一致し、 がコンストラクターを介して渡された場合 TokenCredential 、これは baseUri スコープを getToken に ${options.baseUri}/.default定義します。 それ以外の場合、スコープは既定で "https://management.azure.com/.default"" になります。

指定されていない場合:

  • すべての OperationSpecs には baseUrl プロパティが含まれている必要があります。
  • TokenCredentialがコンストラクターを介して渡された場合、getTokenスコープは "https://management.azure.com/.default"" に設定されます。
clientRequestIdHeaderName

指定すると、GenerateRequestIdPolicy が HTTP パイプラインに追加されます。これにより、このヘッダー名とランダム UUID を要求 ID として持つすべての送信要求にヘッダーが追加されます。
deserializationContentTypes

JSON または XML シリアル化に関連付けられるコンテンツタイプ。
generateClientRequestIdHeader

HTTP 要求ごとにクライアント要求 ID ヘッダーを生成するかどうか。
httpClient

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

HTTP パイプライン内で RequestPolicies をデバッグするために使用できる HttpPipelineLogger。
noRetryPolicy

true に設定されている場合は、既定の再試行ポリシーをオフにします。
proxySettings

すべての HTTP 要求に使用されるプロキシ設定 (Node.jsのみ)。
redirectOptions

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

ワイヤで HTTP 要求を送信するために使用される RequestPolicy パイプラインを作成するために呼び出されるファクトリの配列、または defaultRequestPolicyFactories を受け取って使用される requestPolicyFactories を返す関数。
rpRegistrationRetryTimeout

AutomaticRPRegistration の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。
userAgent

要求の送信中にテレメトリ ヘッダーに設定される文字列、または既定のユーザー エージェント文字列を受け取り、使用されるユーザー エージェント文字列を返す関数。
userAgentHeaderName

要求の送信時にテレメトリ ヘッダーに使用するヘッダー名。 これを指定しない場合は、Node.jsで実行するときに "User-Agent" が使用され、ブラウザーで実行するときに "x-ms-command-name" が使用されます。
withCredentials

ブラウザーの CORS 要求に資格情報を含めるかどうか。 詳細については、「https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials」を参照してください。

プロパティの詳細

agentSettings

すべての HTTP 要求に使用される HTTP エージェントと HTTPS エージェント (Node.jsのみ)。

agentSettings?: AgentSettings

プロパティ値

AgentSettings

baseUri

指定した場合:

  • これは baseUri 、この ServiceClient に対して要求が行われるベース URI になります。
  • が baseUri 既知のリソース マネージャー エンドポイントと一致し、 がコンストラクターを介して渡された場合 TokenCredential 、これは baseUri スコープを getToken に ${options.baseUri}/.default定義します。 それ以外の場合、スコープは既定で "https://management.azure.com/.default"" になります。

指定されていない場合:

  • すべての OperationSpecs には baseUrl プロパティが含まれている必要があります。
  • TokenCredentialがコンストラクターを介して渡された場合、getTokenスコープは "https://management.azure.com/.default"" に設定されます。
baseUri?: string

プロパティ値

string

clientRequestIdHeaderName

指定すると、GenerateRequestIdPolicy が HTTP パイプラインに追加されます。これにより、このヘッダー名とランダム UUID を要求 ID として持つすべての送信要求にヘッダーが追加されます。

clientRequestIdHeaderName?: string

プロパティ値

string

deserializationContentTypes

JSON または XML シリアル化に関連付けられるコンテンツタイプ。

deserializationContentTypes?: DeserializationContentTypes

プロパティ値

DeserializationContentTypes

generateClientRequestIdHeader

HTTP 要求ごとにクライアント要求 ID ヘッダーを生成するかどうか。

generateClientRequestIdHeader?: boolean

プロパティ値

boolean

httpClient

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

httpClient?: HttpClient

プロパティ値

HttpClient

httpPipelineLogger

HTTP パイプライン内で RequestPolicies をデバッグするために使用できる HttpPipelineLogger。

httpPipelineLogger?: HttpPipelineLogger

プロパティ値

HttpPipelineLogger

noRetryPolicy

true に設定されている場合は、既定の再試行ポリシーをオフにします。

noRetryPolicy?: boolean

プロパティ値

boolean

proxySettings

すべての HTTP 要求に使用されるプロキシ設定 (Node.jsのみ)。

proxySettings?: ProxySettings

プロパティ値

ProxySettings

redirectOptions

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

redirectOptions?: RedirectOptions

プロパティ値

RedirectOptions

requestPolicyFactories

ワイヤで HTTP 要求を送信するために使用される RequestPolicy パイプラインを作成するために呼び出されるファクトリの配列、または defaultRequestPolicyFactories を受け取って使用される requestPolicyFactories を返す関数。

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

プロパティ値

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

rpRegistrationRetryTimeout

AutomaticRPRegistration の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。

rpRegistrationRetryTimeout?: number

プロパティ値

number

userAgent

要求の送信中にテレメトリ ヘッダーに設定される文字列、または既定のユーザー エージェント文字列を受け取り、使用されるユーザー エージェント文字列を返す関数。

userAgent?: string | (defaultUserAgent: string) => string

プロパティ値

string | (defaultUserAgent: string) => string

userAgentHeaderName

要求の送信時にテレメトリ ヘッダーに使用するヘッダー名。 これを指定しない場合は、Node.jsで実行するときに "User-Agent" が使用され、ブラウザーで実行するときに "x-ms-command-name" が使用されます。

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

プロパティ値

string | (defaultUserAgentHeaderName: string) => string

withCredentials

ブラウザーの CORS 要求に資格情報を含めるかどうか。 詳細については、「https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials」を参照してください。

withCredentials?: boolean

プロパティ値

boolean