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

ServiceClientOptions interface

包:

@azure/core-client

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

Extends

CommonClientOptions

属性

baseUri	如果指定，则这是将针对此 ServiceClient 发出请求的基 URI。 如果未指定，则所有 OperationSpecs 都必须包含 baseUrl 属性。
credential	用于对请求进行身份验证的凭据。
credentialScopes	如果指定， 将用于生成 BearerTokenAuthenticationPolicy。
endpoint	如果指定，则这是将针对此 ServiceClient 发出请求的终结点。 如果未指定，则所有 OperationSpecs 都必须包含 baseUrl 属性。 为了鼓励客户使用终结点，我们将 baseUri 标记为已弃用。
pipeline	要使用的自定义管道，否则将创建默认管道。
requestContentType	服务的默认请求内容类型。 在 OperationSpec 上不存在 requestContentType 时使用。

继承属性

additionalPolicies	要包含在 HTTP 管道中的其他策略。
allowInsecureConnection	如果请求是通过 HTTP 而不是 HTTPS 发送的，则设置为 true
httpClient	将用于发送 HTTP 请求的 HttpClient。
proxyOptions	用于为传出请求配置代理的选项。
redirectOptions	有关如何处理重定向响应的选项。
retryOptions	用于控制如何重试失败请求的选项。
telemetryOptions	用于将常见遥测和跟踪信息设置为传出请求的选项。
tlsOptions	用于配置 TLS 身份验证的选项
userAgentOptions	用于将用户代理详细信息添加到传出请求的选项。

属性详细信息

baseUri

警告

现已弃用此 API。

This property is deprecated and will be removed soon, please use endpoint instead

如果指定，则这是将针对此 ServiceClient 发出请求的基 URI。 如果未指定，则所有 OperationSpecs 都必须包含 baseUrl 属性。

baseUri?: string

属性值

string

credential

用于对请求进行身份验证的凭据。

credential?: TokenCredential

属性值

TokenCredential

credentialScopes

如果指定， 将用于生成 BearerTokenAuthenticationPolicy。

credentialScopes?: string | string[]

属性值

string | string[]

endpoint

如果指定，则这是将针对此 ServiceClient 发出请求的终结点。 如果未指定，则所有 OperationSpecs 都必须包含 baseUrl 属性。 为了鼓励客户使用终结点，我们将 baseUri 标记为已弃用。

endpoint?: string

属性值

string

pipeline

要使用的自定义管道，否则将创建默认管道。

pipeline?: Pipeline

属性值

Pipeline

requestContentType

服务的默认请求内容类型。 在 OperationSpec 上不存在 requestContentType 时使用。

requestContentType?: string

属性值

string

继承属性详细信息

additionalPolicies

要包含在 HTTP 管道中的其他策略。

additionalPolicies?: AdditionalPolicyConfig[]

属性值

AdditionalPolicyConfig[]

继承自CommonClientOptions.additionalPolicies

allowInsecureConnection

如果请求是通过 HTTP 而不是 HTTPS 发送的，则设置为 true

allowInsecureConnection?: boolean

属性值

boolean

继承自CommonClientOptions.allowInsecureConnection

httpClient

将用于发送 HTTP 请求的 HttpClient。

httpClient?: HttpClient

属性值

HttpClient

继承自CommonClientOptions.httpClient

proxyOptions

用于为传出请求配置代理的选项。

proxyOptions?: ProxySettings

属性值

ProxySettings

继承自CommonClientOptions.proxyOptions

redirectOptions

有关如何处理重定向响应的选项。

redirectOptions?: RedirectPolicyOptions

属性值

RedirectPolicyOptions

继承自CommonClientOptions.redirectOptions

retryOptions

用于控制如何重试失败请求的选项。

retryOptions?: PipelineRetryOptions

属性值

PipelineRetryOptions

继承自CommonClientOptions.retryOptions

telemetryOptions

用于将常见遥测和跟踪信息设置为传出请求的选项。

telemetryOptions?: TelemetryOptions

属性值

TelemetryOptions

继承自CommonClientOptions.telemetryOptions

tlsOptions

用于配置 TLS 身份验证的选项

tlsOptions?: TlsSettings

属性值

TlsSettings

继承自CommonClientOptions.tlsOptions

userAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

userAgentOptions?: UserAgentPolicyOptions

属性值

UserAgentPolicyOptions

继承自CommonClientOptions.userAgentOptions