DeviceClientOptions interface
Az Ügyfél objektum beállításai. Átadva a setOptions függvénynek .
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óhoz. 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ánysal ellenőrzi a kapcsolatot a központ identitásának ellenőrzéséhez. Ha egy Azure-adatközponton belüli Azure IoT Hub csatlakozik, ezt nem kell beállítania. Ha más központhoz (például egy Edge Hubhoz) csatlakozik, akkor előfordulhat, hogy azt a kiszolgálói tanúsítványt 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 | Megtartási időköz numerikus formátumban (másodpercben). Ez kifejezetten az MQTT megtartási pingelt beállítását szabályozza. Ha AMQP-t vagy HTTP-t használ, ez semmit sem fog tenni. |
model |
!! Digitális ikerpéldány használata csak!! Az MQTT-felhasználónévben használt karakterlánc, amely a Digital Twin modelId értéket állítja be. |
mqtt | Nem kötelező objektum az MQTT-átvitelre vonatkozó beállításokkal |
product |
Egyéni felhasználó által definiált információk, amelyet hozzá kell fűzni a meglévő felhasználói ügynök adataihoz. 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. |
token |
Nem kötelező 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. |
client |
Az ügyféltanúsítványt biztosító OpenSSL-motor neve. |
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
ca
Nyilvános tanúsítvány PEM formátumban a központi szolgáltatás által használt hitelesítésszolgáltatóhoz. 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ánysal ellenőrzi a kapcsolatot a központ identitásának ellenőrzéséhez. Ha egy Azure-adatközponton belüli Azure IoT Hub csatlakozik, ezt nem kell beállítania. Ha más központhoz (például egy Edge Hubhoz) csatlakozik, akkor előfordulhat, hogy azt a kiszolgálói tanúsítványt 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
keepalive
Megtartási időköz numerikus formátumban (másodpercben). Ez kifejezetten az MQTT megtartási pingelt beállítását szabályozza. Ha AMQP-t vagy HTTP-t használ, ez semmit sem fog tenni.
keepalive?: number
Tulajdonság értéke
number
modelId
!! Digitális ikerpéldány használata csak!! Az MQTT-felhasználónévben használt karakterlánc, amely a Digital Twin modelId értéket állítja be.
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
productInfo
Egyéni felhasználó által definiált információk, amelyet hozzá kell fűzni a meglévő felhasználói ügynök adataihoz. 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
Nem kötelező 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 forrás X509.cert
clientCertEngine
Az ügyféltanúsítványt biztosító OpenSSL-motor neve.
clientCertEngine?: string
Tulajdonság értéke
string
Örökölt forrás 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 forrás 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 forrás X509.passphrase