你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ServiceClientOptions interface

包:

@azure/core-http

创建客户端时要提供的选项。

属性

clientRequestIdHeaderName	如果指定，则 GenerateRequestIdPolicy 将添加到 HTTP 管道，该管道将向所有传出请求添加标头，并将此标头名称和随机 UUID 作为请求 ID。
credentialScopes	如果指定，则用于生成 BearerTokenAuthenticationPolicy。
deserializationContentTypes	将与 JSON 或 XML 序列化关联的内容类型。
generateClientRequestIdHeader	是否为每个 HTTP 请求生成客户端请求 ID 标头。
httpClient	将用于发送 HTTP 请求的 HttpClient。
httpPipelineLogger	可用于调试 HTTP 管道中的 RequestPolicies 的 HttpPipelineLogger。
noRetryPolicy	如果设置为 true，请关闭默认重试策略。
proxySettings	将用于每个 HTTP 请求 (Node.js 的代理设置仅) 。
requestPolicyFactories	调用的工厂数组创建用于在网络上发送 HTTP 请求的 RequestPolicy 管道，或采用 defaultRequestPolicyFactories 并返回将使用的 requestPolicyFactories 的函数。
rpRegistrationRetryTimeout	获取或设置 AutomaticRPRegistration 的重试超时（以秒为单位）。 默认值为 30。
userAgent	发送请求时要设置为遥测标头的字符串，或采用默认用户代理字符串并返回将使用的用户代理字符串的函数。
userAgentHeaderName	发送请求时要用于遥测标头的标头名称。 如果未指定此项，则在 Node.js 上运行时将使用“User-Agent”，在浏览器中运行时将使用“x-ms-useragent”。
withCredentials	是否在浏览器中的 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

属性值

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

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