DeviceClientOptions interface
Client 物件的選項。 傳遞至 setOptions 函式。
範例
var options = {
cert: myX509Certificate,
key: myX509Key,
http: {
receivePolicy: {
interval: 10
}
}
}
client.setOptions(options, callback);
- Extends
-
X509
屬性
amqp | 具有AMQP傳輸特定選項的選擇性物件 |
ca | 用於中樞服務所使用證書頒發機構單位的 PEM 表體中的公用憑證。 這是中樞用來保護 TLS 連線的 CA,而用戶端會使用此公用憑證驗證連線,以驗證中樞的身分識別。 如果您要連線到 Azure 資料中心內的 Azure IoT 中樞,則不需要進行此設定。 如果您要連線到一些其他中樞(例如 Edge Hub),您可能需要將此設定為中樞用於 TLS 的伺服器憑證。 |
http | 具有 HTTP 傳輸特定選項的選擇性物件 |
keepalive | 數值格式的 Keepalive 間隔(秒)。 這會特別控制 MQTT 的 Keepalive Ping。 如果您使用AMQP或 HTTP,則不會執行任何動作。 |
model |
!!僅使用數字對應項!! 用於 MQTT 使用者名稱設定 Digital Twin 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 Hub),您可能需要將此設定為中樞用於 TLS 的伺服器憑證。
ca?: string
屬性值
string
http
keepalive
數值格式的 Keepalive 間隔(秒)。 這會特別控制 MQTT 的 Keepalive Ping。 如果您使用AMQP或 HTTP,則不會執行任何動作。
keepalive?: number
屬性值
number
modelId
!!僅使用數字對應項!! 用於 MQTT 使用者名稱設定 Digital Twin 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.複雜密碼