Dela via


DeviceClientOptions interface

Alternativ för klientobjektet. Skickades till setOptions-funktionen .

Exempel

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);
Extends

X509

Egenskaper

amqp

Valfritt objekt med alternativ som är specifika för AMQP-transporten

ca

Offentligt certifikat i PEM-formulär för certifikatutfärdare som används av hubbtjänsten. Det här är den certifikatutfärdare som hubben använder för att skydda TLS-anslutningar och klienten validerar anslutningen med det här offentliga certifikatet för att verifiera hubbens identitet. Om du ansluter till en Azure IoT Hub i ett Azure-datacenter behöver du inte ange detta. Om du ansluter till någon annan hubb (t.ex. en Edge Hub) kan du behöva ange detta till det servercertifikat som hubben använder för TLS.

http

Valfritt objekt med alternativ som är specifika för HTTP-transporten

keepalive

Keepalive-intervall i numeriskt format (sekunder). Detta styr keepalive-pingen för MQTT specifikt. Om du använder AMQP eller HTTP gör detta ingenting.

modelId

!! Använd endast digital tvilling!! Sträng som används i MQTT-användarnamn som anger Digital Twin modelId.

mqtt

Valfritt objekt med alternativ som är specifika för MQTT-transporten

productInfo

Anpassad användardefinierad information som ska läggas till i befintlig användaragentinformation. Informationen om användaragentidentifiering används främst av Microsoft internt för att identifiera metadata som rör enhetsklientanvändning för Azure IoT.

tokenRenewal

Valfritt objekt med tokenförnyelsevärden. Använd endast med autentisering som använder i förväg delade nycklar.

Ärvda egenskaper

cert

X509-certifikat.

clientCertEngine

Namnet på en OpenSSL-motor som kan tillhandahålla klientcertifikatet.

key

Nyckel som är associerad med X509-certifikatet.

passphrase

Lösenfras som används för att avkoda nyckeln som är associerad med X509-certifikatet.

Egenskapsinformation

amqp

Valfritt objekt med alternativ som är specifika för AMQP-transporten

amqp?: AmqpTransportOptions

Egenskapsvärde

ca

Offentligt certifikat i PEM-formulär för certifikatutfärdare som används av hubbtjänsten. Det här är den certifikatutfärdare som hubben använder för att skydda TLS-anslutningar och klienten validerar anslutningen med det här offentliga certifikatet för att verifiera hubbens identitet. Om du ansluter till en Azure IoT Hub i ett Azure-datacenter behöver du inte ange detta. Om du ansluter till någon annan hubb (t.ex. en Edge Hub) kan du behöva ange detta till det servercertifikat som hubben använder för TLS.

ca?: string

Egenskapsvärde

string

http

Valfritt objekt med alternativ som är specifika för HTTP-transporten

http?: HttpTransportOptions

Egenskapsvärde

keepalive

Keepalive-intervall i numeriskt format (sekunder). Detta styr keepalive-pingen för MQTT specifikt. Om du använder AMQP eller HTTP gör detta ingenting.

keepalive?: number

Egenskapsvärde

number

modelId

!! Använd endast digital tvilling!! Sträng som används i MQTT-användarnamn som anger Digital Twin modelId.

modelId?: string

Egenskapsvärde

string

mqtt

Valfritt objekt med alternativ som är specifika för MQTT-transporten

mqtt?: MqttTransportOptions

Egenskapsvärde

productInfo

Anpassad användardefinierad information som ska läggas till i befintlig användaragentinformation. Informationen om användaragentidentifiering används främst av Microsoft internt för att identifiera metadata som rör enhetsklientanvändning för Azure IoT.

productInfo?: string

Egenskapsvärde

string

tokenRenewal

Valfritt objekt med tokenförnyelsevärden. Använd endast med autentisering som använder i förväg delade nycklar.

tokenRenewal?: TokenRenewalValues

Egenskapsvärde

TokenRenewalValues

Information om ärvda egenskaper

cert

X509-certifikat.

cert?: string | Buffer | string[] | Buffer[]

Egenskapsvärde

string | Buffer | string[] | Buffer[]

Ärvd från X509.cert

clientCertEngine

Namnet på en OpenSSL-motor som kan tillhandahålla klientcertifikatet.

clientCertEngine?: string

Egenskapsvärde

string

Ärvd från X509.clientCertEngine

key

Nyckel som är associerad med X509-certifikatet.

key?: string | Buffer

Egenskapsvärde

string | Buffer

Ärvd från X509.key

passphrase

Lösenfras som används för att avkoda nyckeln som är associerad med X509-certifikatet.

passphrase?: string

Egenskapsvärde

string

Ärvd från X509.lösenfras