共用方式為

DeviceClientOptions interface

  • 參考
套件:
azure-iot-device

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，則不會執行任何動作。
modelId

!!Digital Twin Use Only!! 用於 MQTT 使用者名稱設定 Digital Twin modelId 的字串。
mqtt

選擇性物件，其中包含 MQTT 傳輸的特定選項
productInfo

要附加至現有使用者代理程式資訊的自訂使用者定義資訊。 使用者代理程式識別資訊主要是由 Microsoft 內部用來識別與 Azure IoT 裝置用戶端使用量相關的中繼資料。
tokenRenewal

選擇性物件，具有權杖更新值。 只搭配使用預先共用金鑰的驗證使用。

繼承的屬性

cert

X509 憑證。
clientCertEngine

可提供用戶端憑證的 OpenSSL 引擎名稱。
key

與 X509 憑證相關聯的金鑰。
passphrase

用來解碼與 X509 憑證相關聯之金鑰的複雜密碼。

屬性詳細資料

amqp

選擇性物件，其中包含 AMQP 傳輸的特定選項

amqp?: AmqpTransportOptions

屬性值

AmqpTransportOptions

ca

中樞服務所使用憑證授權單位單位的 PEM 形式公開憑證。 這是中樞用來保護 TLS 連線的 CA，而用戶端會使用此公用憑證驗證連線，以驗證中樞的身分識別。 如果您要連線到 Azure 資料中心內的Azure IoT 中樞，則不需要設定此設定。 如果您要連線到一些其他中樞 (例如 Edge Hub) ，您可能需要將此設定為中樞用於 TLS 的伺服器憑證。

ca?: string

屬性值

string

http

選擇性物件，其中包含 HTTP 傳輸特定的選項

http?: HttpTransportOptions

屬性值

HttpTransportOptions

keepalive

(秒) 數值格式的 Keepalive 間隔。 這會特別控制 MQTT 的 Keepalive Ping。 如果您使用 AMQP 或 HTTP，則不會執行任何動作。

keepalive?: number

屬性值

number

modelId

!!Digital Twin Use Only!! 用於 MQTT 使用者名稱設定 Digital Twin modelId 的字串。

modelId?: string

屬性值

string

mqtt

選擇性物件，其中包含 MQTT 傳輸的特定選項

mqtt?: MqttTransportOptions

屬性值

MqttTransportOptions

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