你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ServiceClientOptions interface
创建客户端时要提供的选项。
属性
| agent |
HTTP 和 HTTPS 代理，将用于每个 HTTP 请求（仅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
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