通过

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

IotHubClientOptionalParams interface

  • 参考
包:
@azure/arm-iothub

可选参数。

Extends
ServiceClientOptions

属性

$host

服务器参数
apiVersion

API 版本
endpoint

替代客户端终结点。

继承属性

additionalPolicies

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

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

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

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

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

将用于发送 HTTP 请求的 HttpClient。
pipeline

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

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

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

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

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

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

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

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

属性详细信息

$host

服务器参数

$host?: string

属性值

string

apiVersion

API 版本

apiVersion?: string

属性值

string

endpoint

替代客户端终结点。

endpoint?: string

属性值

string

继承属性详细信息

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

属性值

AdditionalPolicyConfig[]

继承自 coreClient.ServiceClientOptions.additionalPolicies

allowInsecureConnection

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

allowInsecureConnection?: boolean

属性值

boolean

继承自 coreClient.ServiceClientOptions.allowInsecureConnection

baseUri

警告

现已弃用此 API。

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

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

baseUri?: string

属性值

string

继承自 coreClient.ServiceClientOptions.baseUri

credential

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

credential?: TokenCredential

属性值

TokenCredential

继承自 coreClient.ServiceClientOptions.credential

credentialScopes

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

credentialScopes?: string | string[]

属性值

string | string[]

继承自 coreClient.ServiceClientOptions.credentialScopes

httpClient

将用于发送 HTTP 请求的 HttpClient。

httpClient?: HttpClient

属性值

HttpClient

继承自 coreClient.ServiceClientOptions.httpClient

pipeline

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

pipeline?: Pipeline

属性值

Pipeline

继承自 coreClient.ServiceClientOptions.pipeline

proxyOptions

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

proxyOptions?: ProxySettings

属性值

ProxySettings

继承自 coreClient.ServiceClientOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

属性值

RedirectPolicyOptions

继承自 coreClient.ServiceClientOptions.redirectOptions

requestContentType

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

requestContentType?: string

属性值

string

继承自 coreClient.ServiceClientOptions.requestContentType

retryOptions

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

retryOptions?: PipelineRetryOptions

属性值

PipelineRetryOptions

继承自 coreClient.ServiceClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

属性值

TelemetryOptions

继承自 coreClient.ServiceClientOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

属性值

TlsSettings

继承自 coreClient.ServiceClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

属性值

UserAgentPolicyOptions

继承自 coreClient.ServiceClientOptions.userAgentOptions