DeviceClientOptions interface

Csomag:

azure-iot-device

Az ügyfélobjektum beállításai. A setOptions függvény.

példa

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

Extends

X509

Tulajdonságok

amqp	Választható objektum az AMQP-átvitelre vonatkozó beállításokkal
ca	Nyilvános tanúsítvány PEM formátumban a központi szolgáltatás által használt hitelesítésszolgáltató számára. Ez az a hitelesítésszolgáltató, amelyet a központ a TLS-kapcsolatok védelmére használ, és az ügyfél ezzel a nyilvános tanúsítvány használatával ellenőrzi a kapcsolatot a központ identitásának ellenőrzése érdekében. Ha azure-adatközponton belül csatlakozik egy Azure IoT Hubhoz, ezt nem kell beállítania. Ha más központhoz (pl. Edge Hubhoz) csatlakozik, akkor előfordulhat, hogy ezt a kiszolgálói tanúsítványra kell beállítania, amelyet a központ a TLS-hez használ.
http	Nem kötelező objektum a HTTP-átvitelre vonatkozó beállításokkal
keepalive	Megőrzési időköz numerikus formátumban (másodpercben). Ez szabályozza az MQTT megőrzési pingét. Ha AMQP-t vagy HTTP-t használ, ez semmit sem fog tenni.
modelId	!! Csak digitális ikerpéldány használata!! A Digital Twin modelId beállításához használt MQTT-felhasználónévben használt sztring.
mqtt	Nem kötelező objektum az MQTT-átvitelre vonatkozó beállításokkal
productInfo	A meglévő felhasználói ügynök adataihoz hozzáfűzendő egyéni felhasználó által definiált adatok. A felhasználói ügynök azonosítási adatait elsősorban a Microsoft használja belsőleg az Azure IoT eszközügyfél-használatával kapcsolatos metaadatok azonosítására.
tokenRenewal	Opcionális objektum tokenmegújítási értékekkel. Csak olyan hitelesítéssel használható, amely előre megosztott kulcsokat használ.

Örökölt tulajdonságok

cert	X509-tanúsítvány.
clientCertEngine	Egy OpenSSL-motor neve, amely meg tudja adni az ügyféltanúsítványt.
key	Az X509-tanúsítványhoz társított kulcs.
passphrase	Az X509-tanúsítványhoz társított kulcs dekódolásához használt jelszó.

Tulajdonság adatai

amqp

Választható objektum az AMQP-átvitelre vonatkozó beállításokkal

amqp?: AmqpTransportOptions

Tulajdonság értéke

AmqpTransportOptions

ca

Nyilvános tanúsítvány PEM formátumban a központi szolgáltatás által használt hitelesítésszolgáltató számára. Ez az a hitelesítésszolgáltató, amelyet a központ a TLS-kapcsolatok védelmére használ, és az ügyfél ezzel a nyilvános tanúsítvány használatával ellenőrzi a kapcsolatot a központ identitásának ellenőrzése érdekében. Ha azure-adatközponton belül csatlakozik egy Azure IoT Hubhoz, ezt nem kell beállítania. Ha más központhoz (pl. Edge Hubhoz) csatlakozik, akkor előfordulhat, hogy ezt a kiszolgálói tanúsítványra kell beállítania, amelyet a központ a TLS-hez használ.

ca?: string

Tulajdonság értéke

string

http

Nem kötelező objektum a HTTP-átvitelre vonatkozó beállításokkal

http?: HttpTransportOptions

Tulajdonság értéke

HttpTransportOptions

keepalive

Megőrzési időköz numerikus formátumban (másodpercben). Ez szabályozza az MQTT megőrzési pingét. Ha AMQP-t vagy HTTP-t használ, ez semmit sem fog tenni.

keepalive?: number

Tulajdonság értéke

number

modelId

!! Csak digitális ikerpéldány használata!! A Digital Twin modelId beállításához használt MQTT-felhasználónévben használt sztring.

modelId?: string

Tulajdonság értéke

string

mqtt

Nem kötelező objektum az MQTT-átvitelre vonatkozó beállításokkal

mqtt?: MqttTransportOptions

Tulajdonság értéke

MqttTransportOptions

productInfo

A meglévő felhasználói ügynök adataihoz hozzáfűzendő egyéni felhasználó által definiált adatok. A felhasználói ügynök azonosítási adatait elsősorban a Microsoft használja belsőleg az Azure IoT eszközügyfél-használatával kapcsolatos metaadatok azonosítására.

productInfo?: string

Tulajdonság értéke

string

tokenRenewal

Opcionális objektum tokenmegújítási értékekkel. Csak olyan hitelesítéssel használható, amely előre megosztott kulcsokat használ.

tokenRenewal?: TokenRenewalValues

Tulajdonság értéke

TokenRenewalValues

Örökölt tulajdonság részletei

cert

X509-tanúsítvány.

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

Tulajdonság értéke

string | Buffer | string[] | Buffer[]

örökölt X509.cert

clientCertEngine

Egy OpenSSL-motor neve, amely meg tudja adni az ügyféltanúsítványt.

clientCertEngine?: string

Tulajdonság értéke

string

örökölt X509.clientCertEngine

key

Az X509-tanúsítványhoz társított kulcs.

key?: string | Buffer

Tulajdonság értéke

string | Buffer

örökölt X509.key

passphrase

Az X509-tanúsítványhoz társított kulcs dekódolásához használt jelszó.

passphrase?: string

Tulajdonság értéke

string

örökölt X509.passphrase