DeviceClientOptions interface

Pakiet:

azure-iot-device

Opcje obiektu Client. Przekazano do funkcji setOptions .

Przykład

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

Extends

X509

Właściwości

amqp	Opcjonalny obiekt z opcjami specyficznymi dla transportu AMQP
ca	Certyfikat publiczny w formularzu PEM dla urzędu certyfikacji używanego przez usługę Hub. Jest to urząd certyfikacji używany przez centrum do zabezpieczania połączeń TLS, a klient weryfikuje połączenie przy użyciu tego publicznego certyfikatu w celu zweryfikowania tożsamości centrum. Jeśli łączysz się z Azure IoT Hub wewnątrz centrum danych platformy Azure, nie musisz tego ustawiać. Jeśli łączysz się z innym koncentratorem (np. centrum usługi Edge), może być konieczne ustawienie tego certyfikatu serwera używanego przez centrum na potrzeby protokołu TLS.
http	Opcjonalny obiekt z opcjami specyficznymi dla transportu HTTP
keepalive	Interwał utrzymania aktywności w formacie liczbowym (w sekundach). Steruje to poleceniem ping keepalive dla MQTT. Jeśli używasz protokołu AMQP lub HTTP, nie zrobi to nic.
modelId	!! Używaj tylko cyfrowej reprezentacji bliźniaczej!! Ciąg używany w nazwie użytkownika MQTT ustawiając identyfikator modelu usługi Digital Twin.
mqtt	Obiekt opcjonalny z opcjami specyficznymi dla transportu MQTT
productInfo	Niestandardowe informacje zdefiniowane przez użytkownika, które mają zostać dołączone do istniejących informacji o agencie użytkownika. Informacje o identyfikacji agenta użytkownika są używane głównie przez firmę Microsoft wewnętrznie do identyfikowania metadanych związanych z użyciem klienta urządzenia dla usługi Azure IoT.
tokenRenewal	Opcjonalny obiekt z wartościami odnowienia tokenu. Używaj tylko z uwierzytelnianiem, które używa kluczy wstępnych.

Właściwości dziedziczone

cert	Certyfikat X509.
clientCertEngine	Nazwa aparatu OpenSSL, który może dostarczyć certyfikat klienta.
key	Klucz skojarzony z certyfikatem X509.
passphrase	Hasło używane do dekodowania klucza skojarzonego z certyfikatem X509.

Szczegóły właściwości

amqp

Opcjonalny obiekt z opcjami specyficznymi dla transportu AMQP

amqp?: AmqpTransportOptions

Wartość właściwości

AmqpTransportOptions

ca

Certyfikat publiczny w formularzu PEM dla urzędu certyfikacji używanego przez usługę Hub. Jest to urząd certyfikacji używany przez centrum do zabezpieczania połączeń TLS, a klient weryfikuje połączenie przy użyciu tego publicznego certyfikatu w celu zweryfikowania tożsamości centrum. Jeśli łączysz się z Azure IoT Hub wewnątrz centrum danych platformy Azure, nie musisz tego ustawiać. Jeśli łączysz się z innym koncentratorem (np. centrum usługi Edge), może być konieczne ustawienie tego certyfikatu serwera używanego przez centrum na potrzeby protokołu TLS.

ca?: string

Wartość właściwości

string

http

Opcjonalny obiekt z opcjami specyficznymi dla transportu HTTP

http?: HttpTransportOptions

Wartość właściwości

HttpTransportOptions

keepalive

Interwał utrzymania aktywności w formacie liczbowym (w sekundach). Steruje to poleceniem ping keepalive dla MQTT. Jeśli używasz protokołu AMQP lub HTTP, nie zrobi to nic.

keepalive?: number

Wartość właściwości

number

modelId

!! Używaj tylko cyfrowej reprezentacji bliźniaczej!! Ciąg używany w nazwie użytkownika MQTT ustawiając identyfikator modelu usługi Digital Twin.

modelId?: string

Wartość właściwości

string

mqtt

Obiekt opcjonalny z opcjami specyficznymi dla transportu MQTT

mqtt?: MqttTransportOptions

Wartość właściwości

MqttTransportOptions

productInfo

Niestandardowe informacje zdefiniowane przez użytkownika, które mają zostać dołączone do istniejących informacji o agencie użytkownika. Informacje o identyfikacji agenta użytkownika są używane głównie przez firmę Microsoft wewnętrznie do identyfikowania metadanych związanych z użyciem klienta urządzenia dla usługi Azure IoT.

productInfo?: string

Wartość właściwości

string

tokenRenewal

Opcjonalny obiekt z wartościami odnowienia tokenu. Używaj tylko z uwierzytelnianiem, które używa kluczy wstępnych.

tokenRenewal?: TokenRenewalValues

Wartość właściwości

TokenRenewalValues

Szczegóły właściwości dziedziczonej

cert

Certyfikat X509.

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

Wartość właściwości

string | Buffer | string[] | Buffer[]

Dziedziczone z X509.cert

clientCertEngine

Nazwa aparatu OpenSSL, który może dostarczyć certyfikat klienta.

clientCertEngine?: string

Wartość właściwości

string

Dziedziczone z X509.clientCertEngine

key

Klucz skojarzony z certyfikatem X509.

key?: string | Buffer

Wartość właściwości

string | Buffer

Dziedziczone z X509.key

passphrase

Hasło używane do dekodowania klucza skojarzonego z certyfikatem X509.

passphrase?: string

Wartość właściwości

string

Dziedziczone z X509.passphrase