Share via

DeviceClientOptions interface

  • Referenz
Paket:
azure-iot-device

Optionen für das Clientobjekt. An die setOptions-Funktion übergeben.

Beispiel

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

X509

Eigenschaften

amqp

Optionales Objekt mit spezifischen Optionen für den AMQP-Transport
ca

Öffentliches Zertifikat im PEM-Formular für die Zertifizierungsstelle, die vom Hubdienst verwendet wird. Dies ist die Zertifizierungsstelle, die der Hub zum Sichern von TLS-Verbindungen verwendet, und der Client überprüft die Verbindung mithilfe dieses öffentlichen Zertifikats, um die Identität des Hubs zu überprüfen. Wenn Sie eine Verbindung mit einem Azure IoT Hub in einem Azure-Rechenzentrum herstellen, müssen Sie dies nicht festlegen. Wenn Sie eine Verbindung mit einem anderen Hub herstellen (z. B. einem Edge-Hub), müssen Sie dies möglicherweise auf das Serverzertifikat festlegen, das der Hub für TLS verwendet.
http

Optionales Objekt mit spezifischen Optionen für den HTTP-Transport
keepalive

Keepalive Intervall im numerischen Format (Sekunden). Dadurch wird speziell der keepalive Ping für MQTT gesteuert. Wenn Sie AMQP oder HTTP verwenden, führt dies zu keinem Fehler.
modelId

!! Digitaler Zwilling nur verwenden!! Zeichenfolge, die im MQTT-Benutzernamen verwendet wird, legt die ModelId des digitalen Zwillings fest.
mqtt

Optionales Objekt mit spezifischen Optionen für den MQTT-Transport
productInfo

Benutzerdefinierte benutzerdefinierte Informationen, die an vorhandene Benutzer-Agent-Informationen angefügt werden sollen. Die Benutzer-Agent-Identifikationsinformationen werden hauptsächlich von Microsoft intern verwendet, um Metadaten im Zusammenhang mit der Geräteclientnutzung für Azure IoT zu identifizieren.
tokenRenewal

Optionales Objekt mit Tokenverlängerungswerten. Verwenden Sie nur die Authentifizierung, die vorab freigegebene Schlüssel verwendet.

Geerbte Eigenschaften

cert

X509-Zertifikat.
clientCertEngine

Name einer OpenSSL-Engine, die das Clientzertifikat bereitstellen kann.
key

Schlüssel, der dem X509-Zertifikat zugeordnet ist.
passphrase

Passphrase, die zum Decodieren des dem X509-Zertifikat zugeordneten Schlüssels verwendet wird.

Details zur Eigenschaft

amqp

Optionales Objekt mit spezifischen Optionen für den AMQP-Transport

amqp?: AmqpTransportOptions

Eigenschaftswert

AmqpTransportOptions

ca

Öffentliches Zertifikat im PEM-Formular für die Zertifizierungsstelle, die vom Hubdienst verwendet wird. Dies ist die Zertifizierungsstelle, die der Hub zum Sichern von TLS-Verbindungen verwendet, und der Client überprüft die Verbindung mithilfe dieses öffentlichen Zertifikats, um die Identität des Hubs zu überprüfen. Wenn Sie eine Verbindung mit einem Azure IoT Hub in einem Azure-Rechenzentrum herstellen, müssen Sie dies nicht festlegen. Wenn Sie eine Verbindung mit einem anderen Hub herstellen (z. B. einem Edge-Hub), müssen Sie dies möglicherweise auf das Serverzertifikat festlegen, das der Hub für TLS verwendet.

ca?: string

Eigenschaftswert

string

http

Optionales Objekt mit spezifischen Optionen für den HTTP-Transport

http?: HttpTransportOptions

Eigenschaftswert

HttpTransportOptions

keepalive

Keepalive Intervall im numerischen Format (Sekunden). Dadurch wird speziell der keepalive Ping für MQTT gesteuert. Wenn Sie AMQP oder HTTP verwenden, führt dies zu keinem Fehler.

keepalive?: number

Eigenschaftswert

number

modelId

!! Digitaler Zwilling nur verwenden!! Zeichenfolge, die im MQTT-Benutzernamen verwendet wird, legt die ModelId des digitalen Zwillings fest.

modelId?: string

Eigenschaftswert

string

mqtt

Optionales Objekt mit spezifischen Optionen für den MQTT-Transport

mqtt?: MqttTransportOptions

Eigenschaftswert

MqttTransportOptions

productInfo

Benutzerdefinierte benutzerdefinierte Informationen, die an vorhandene Benutzer-Agent-Informationen angefügt werden sollen. Die Benutzer-Agent-Identifikationsinformationen werden hauptsächlich von Microsoft intern verwendet, um Metadaten im Zusammenhang mit der Geräteclientnutzung für Azure IoT zu identifizieren.

productInfo?: string

Eigenschaftswert

string

tokenRenewal

Optionales Objekt mit Tokenverlängerungswerten. Verwenden Sie nur die Authentifizierung, die vorab freigegebene Schlüssel verwendet.

tokenRenewal?: TokenRenewalValues

Eigenschaftswert

TokenRenewalValues

Geerbte Eigenschaftsdetails

cert

X509-Zertifikat.

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

Eigenschaftswert

string | Buffer | string[] | Buffer[]

Geerbt von X509.cert

clientCertEngine

Name einer OpenSSL-Engine, die das Clientzertifikat bereitstellen kann.

clientCertEngine?: string

Eigenschaftswert

string

Geerbt von X509.clientCertEngine

key

Schlüssel, der dem X509-Zertifikat zugeordnet ist.

key?: string | Buffer

Eigenschaftswert

string | Buffer

Geerbt von X509.key

passphrase

Passphrase, die zum Decodieren des dem X509-Zertifikat zugeordneten Schlüssels verwendet wird.

passphrase?: string

Eigenschaftswert

string

Geerbt von X509.passphrase