DeviceClientOptions interface
Client 对象的选项。 传递给 setOptions 函数。
示例
var options = {
cert: myX509Certificate,
key: myX509Key,
http: {
receivePolicy: {
interval: 10
}
}
}
client.setOptions(options, callback);
- 扩展
-
X509
属性
amqp | 具有特定于 AMQP 传输的选项的可选对象 |
ca | 用于中心服务使用的证书颁发机构的 PEM 形式的公共证书。 这是中心用于保护 TLS 连接的 CA,客户端使用此公共证书验证连接,以验证中心的标识。 如果要连接到 Azure 数据中心内的 Azure IoT 中心,则无需设置此项。 如果要连接到其他一些中心(例如 Edge 中心),则可能需要将此设置为中心用于 TLS 的服务器证书。 |
http | 具有特定于 HTTP 传输的选项的可选对象 |
keepalive | 以数字格式(秒)保持间隔。 这专门控制 MQTT 的 keepalive ping。 如果使用 AMQP 或 HTTP,则不会执行任何作。 |
model |
!!数字孪生仅使用!! MQTT 用户名中使用的字符串设置数字孪生 modelId。 |
mqtt | 具有特定于 MQTT 传输的选项的可选对象 |
product |
要追加到现有用户代理信息的自定义用户定义信息。 用户代理标识信息主要由内部Microsoft用于标识与 Azure IoT 设备客户端使用情况相关的元数据。 |
token |
具有令牌续订值的可选对象。 仅与使用预共享密钥的身份验证一起使用。 |
继承属性
cert | X509 证书。 |
client |
OpenSSL 引擎的名称,该引擎可提供客户端证书。 |
key | 与 X509 证书关联的密钥。 |
passphrase | 用于解码与 X509 证书关联的密钥的通行短语。 |
属性详细信息
amqp
ca
用于中心服务使用的证书颁发机构的 PEM 形式的公共证书。 这是中心用于保护 TLS 连接的 CA,客户端使用此公共证书验证连接,以验证中心的标识。 如果要连接到 Azure 数据中心内的 Azure IoT 中心,则无需设置此项。 如果要连接到其他一些中心(例如 Edge 中心),则可能需要将此设置为中心用于 TLS 的服务器证书。
ca?: string
属性值
string
http
keepalive
以数字格式(秒)保持间隔。 这专门控制 MQTT 的 keepalive ping。 如果使用 AMQP 或 HTTP,则不会执行任何作。
keepalive?: number
属性值
number
modelId
!!数字孪生仅使用!! MQTT 用户名中使用的字符串设置数字孪生 modelId。
modelId?: string
属性值
string
mqtt
productInfo
要追加到现有用户代理信息的自定义用户定义信息。 用户代理标识信息主要由内部Microsoft用于标识与 Azure IoT 设备客户端使用情况相关的元数据。
productInfo?: string
属性值
string
tokenRenewal
具有令牌续订值的可选对象。 仅与使用预共享密钥的身份验证一起使用。
tokenRenewal?: TokenRenewalValues
属性值
TokenRenewalValues
继承属性详细信息
cert
X509 证书。
cert?: string | Buffer | string[] | Buffer[]
属性值
string | Buffer | string[] | Buffer[]
继承自 x509.cert 的
clientCertEngine
OpenSSL 引擎的名称,该引擎可提供客户端证书。
clientCertEngine?: string
属性值
string
继承自 X509.clientCertEngine
key
与 X509 证书关联的密钥。
key?: string | Buffer
属性值
string | Buffer
继承自 X509.key 的
passphrase
用于解码与 X509 证书关联的密钥的通行短语。
passphrase?: string
属性值
string
继承自 X509.passphrase 的