Delen via

DeviceClientOptions interface

  • Referentie
Pakket:
azure-iot-device

Opties voor het clientobject. Doorgegeven aan de functie setOptions.

voorbeeld van

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

X509

Eigenschappen

amqp

Optioneel object met opties die specifiek zijn voor het AMQP-transport
ca

Openbaar certificaat in PEM-formulier voor certificeringsinstantie die wordt gebruikt door de Hub-service. Dit is de CA die de hub gebruikt om TLS-verbindingen te beveiligen en de client valideert de verbinding met dit openbare certificaat om de identiteit van de hub te valideren. Als u verbinding maakt met een Azure IoT Hub in een Azure-datacenter, hoeft u dit niet in te stellen. Als u verbinding maakt met een andere hub (bijvoorbeeld een Edge Hub), moet u dit mogelijk instellen op het servercertificaat dat door de hub wordt gebruikt voor TLS.
http

Optioneel object met opties die specifiek zijn voor het HTTP-transport
keepalive

Keepalive-interval in numerieke notatie (seconden). Hiermee wordt de keepalive-ping voor MQTT bepaald. Als u AMQP of HTTP gebruikt, doet dit niets.
modelId

!! Alleen digital twin-gebruik!! Tekenreeks die wordt gebruikt in de MQTT-gebruikersnaam die de Digital Twin-modelId instelt.
mqtt

Optioneel object met opties die specifiek zijn voor het MQTT-transport
productInfo

Aangepaste door de gebruiker gedefinieerde gegevens die moeten worden toegevoegd aan bestaande gebruikersagentgegevens. De identificatiegegevens van de gebruikersagent worden voornamelijk intern door Microsoft gebruikt voor het identificeren van metagegevens met betrekking tot het gebruik van de apparaatclient voor Azure IoT.
tokenRenewal

Optioneel object met vernieuwingswaarden voor tokens. Gebruik alleen met verificatie die gebruikmaakt van vooraf gedeelde sleutels.

Overgenomen eigenschappen

cert

X509-certificaat.
clientCertEngine

Naam van een OpenSSL-engine die het clientcertificaat kan opgeven.
key

Sleutel die is gekoppeld aan het X509-certificaat.
passphrase

Wachtwoordzin die wordt gebruikt voor het decoderen van de sleutel die is gekoppeld aan het X509-certificaat.

Eigenschapdetails

amqp

Optioneel object met opties die specifiek zijn voor het AMQP-transport

amqp?: AmqpTransportOptions

Waarde van eigenschap

AmqpTransportOptions

ca

Openbaar certificaat in PEM-formulier voor certificeringsinstantie die wordt gebruikt door de Hub-service. Dit is de CA die de hub gebruikt om TLS-verbindingen te beveiligen en de client valideert de verbinding met dit openbare certificaat om de identiteit van de hub te valideren. Als u verbinding maakt met een Azure IoT Hub in een Azure-datacenter, hoeft u dit niet in te stellen. Als u verbinding maakt met een andere hub (bijvoorbeeld een Edge Hub), moet u dit mogelijk instellen op het servercertificaat dat door de hub wordt gebruikt voor TLS.

ca?: string

Waarde van eigenschap

string

http

Optioneel object met opties die specifiek zijn voor het HTTP-transport

http?: HttpTransportOptions

Waarde van eigenschap

HttpTransportOptions

keepalive

Keepalive-interval in numerieke notatie (seconden). Hiermee wordt de keepalive-ping voor MQTT bepaald. Als u AMQP of HTTP gebruikt, doet dit niets.

keepalive?: number

Waarde van eigenschap

number

modelId

!! Alleen digital twin-gebruik!! Tekenreeks die wordt gebruikt in de MQTT-gebruikersnaam die de Digital Twin-modelId instelt.

modelId?: string

Waarde van eigenschap

string

mqtt

Optioneel object met opties die specifiek zijn voor het MQTT-transport

mqtt?: MqttTransportOptions

Waarde van eigenschap

MqttTransportOptions

productInfo

Aangepaste door de gebruiker gedefinieerde gegevens die moeten worden toegevoegd aan bestaande gebruikersagentgegevens. De identificatiegegevens van de gebruikersagent worden voornamelijk intern door Microsoft gebruikt voor het identificeren van metagegevens met betrekking tot het gebruik van de apparaatclient voor Azure IoT.

productInfo?: string

Waarde van eigenschap

string

tokenRenewal

Optioneel object met vernieuwingswaarden voor tokens. Gebruik alleen met verificatie die gebruikmaakt van vooraf gedeelde sleutels.

tokenRenewal?: TokenRenewalValues

Waarde van eigenschap

TokenRenewalValues

Details van overgenomen eigenschap

cert

X509-certificaat.

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

Waarde van eigenschap

string | Buffer | string[] | Buffer[]

overgenomen van X509.cert

clientCertEngine

Naam van een OpenSSL-engine die het clientcertificaat kan opgeven.

clientCertEngine?: string

Waarde van eigenschap

string

overgenomen van X509.clientCertEngine

key

Sleutel die is gekoppeld aan het X509-certificaat.

key?: string | Buffer

Waarde van eigenschap

string | Buffer

overgenomen van X509.key

passphrase

Wachtwoordzin die wordt gebruikt voor het decoderen van de sleutel die is gekoppeld aan het X509-certificaat.

passphrase?: string

Waarde van eigenschap

string

overgenomen van X509.passphrase