ServiceClientOptions interface
クライアントの作成時に指定するオプション。
プロパティ
client |
指定した場合、GenerateRequestIdPolicy は HTTP パイプラインに追加され、このヘッダー名とランダム UUID を要求 ID として持つすべての送信要求にヘッダーが追加されます。 |
credential |
指定した場合は、 を使用して BearerTokenAuthenticationPolicy をビルドします。 |
deserialization |
JSON または XML シリアル化に関連付けられるコンテンツ タイプ。 |
generate |
HTTP 要求ごとにクライアント要求 ID ヘッダーを生成するかどうか。 |
http |
HTTP 要求の送信に使用される HttpClient。 |
http |
HTTP パイプライン内で RequestPolicies をデバッグするために使用できる HttpPipelineLogger。 |
no |
true に設定されている場合は、既定の再試行ポリシーをオフにします。 |
proxy |
すべての HTTP 要求に使用されるプロキシ設定 (Node.jsのみ)。 |
request |
ネットワーク上で HTTP 要求を送信するために使用される RequestPolicy パイプラインを作成するために呼び出されるファクトリの配列、または defaultRequestPolicyFactories を受け取って使用される requestPolicyFactories を返す関数。 |
rp |
AutomaticRPRegistration の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。 |
user |
要求の送信中にテレメトリ ヘッダーに設定される文字列、または既定のユーザー エージェント文字列を受け取り、使用されるユーザー エージェント文字列を返す関数。 |
user |
要求の送信中にテレメトリ ヘッダーに使用するヘッダー名。 これが指定されていない場合は、Node.jsで実行するときに "User-Agent" が使用され、ブラウザーで実行するときに "x-ms-useragent" が使用されます。 |
with |
ブラウザーの CORS 要求に資格情報を含めるかどうか。 詳細については、「 https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials 」を参照してください。 |
プロパティの詳細
clientRequestIdHeaderName
指定した場合、GenerateRequestIdPolicy は HTTP パイプラインに追加され、このヘッダー名とランダム UUID を要求 ID として持つすべての送信要求にヘッダーが追加されます。
clientRequestIdHeaderName?: string
プロパティ値
string
credentialScopes
指定した場合は、 を使用して BearerTokenAuthenticationPolicy をビルドします。
credentialScopes?: string | string[]
プロパティ値
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
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-useragent" が使用されます。
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