ServiceClientOptions interface
クライアントの作成時に指定するオプション。
プロパティ
| agent |
すべての HTTP 要求に使用される HTTP および HTTPS エージェント (Node.js のみ)。 |
| base |
指定した場合:
指定されていない場合:
|
| client |
指定すると、GenerateRequestIdPolicy が HTTP パイプラインに追加され、このヘッダー名とランダム UUID を要求 ID として持つすべての送信要求にヘッダーが追加されます。 |
| deserialization |
JSON または XML シリアル化に関連付けられるコンテンツ タイプ。 |
| generate |
各 HTTP 要求のクライアント要求 ID ヘッダーを生成するかどうか。 |
| http |
HTTP 要求の送信に使用される HttpClient。 |
| http |
HTTP パイプライン内で RequestPolicies をデバッグするために使用できる HttpPipelineLogger。 |
| no |
true に設定した場合は、既定の再試行ポリシーをオフにします。 |
| proxy |
すべての HTTP 要求に使用されるプロキシ設定 (Node.js のみ)。 |
| redirect |
リダイレクト応答の処理方法のオプション。 |
| request |
ネットワーク上で HTTP 要求を送信するために使用される RequestPolicy パイプラインを作成するために呼び出されるファクトリの配列、または defaultRequestPolicyFactories を受け取って使用される requestPolicyFactories を返す関数。 |
| rp |
AutomaticRPRegistration の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。 |
| user |
要求の送信中にテレメトリ ヘッダーに設定する文字列、または既定のユーザー エージェント文字列を受け取り、使用されるユーザー エージェント文字列を返す関数。 |
| user |
要求の送信時にテレメトリ ヘッダーに使用するヘッダー名。 これを指定しない場合は、Node.js で実行するときに "User-Agent" が使用され、ブラウザーで実行するときに "x-ms-command-name" が使用されます。 |
| with |
ブラウザーの CORS 要求に資格情報を含めるかどうか。 詳細については、https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials を参照してください。 |
プロパティの詳細
agentSettings
すべての HTTP 要求に使用される HTTP および HTTPS エージェント (Node.js のみ)。
agentSettings?: AgentSettingsプロパティ値
baseUri
指定した場合:
- この
baseUriは、この ServiceClient に対して要求が行われるベース URI になります。 -
baseUriが既知のリソース マネージャー エンドポイントと一致し、TokenCredentialがコンストラクターを介して渡された場合、このbaseUriは${options.baseUri}/.defaultするgetTokenスコープを定義します。 それ以外の場合、スコープは既定で "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プロパティ値
generateClientRequestIdHeader
各 HTTP 要求のクライアント要求 ID ヘッダーを生成するかどうか。
generateClientRequestIdHeader?: booleanプロパティ値
boolean
httpClient
httpPipelineLogger
HTTP パイプライン内で RequestPolicies をデバッグするために使用できる HttpPipelineLogger。
httpPipelineLogger?: HttpPipelineLoggerプロパティ値
noRetryPolicy
true に設定した場合は、既定の再試行ポリシーをオフにします。
noRetryPolicy?: booleanプロパティ値
boolean
proxySettings
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