Udostępnij za pośrednictwem

DeviceClientOptions interface

  • Odwołanie
Pakiet:
azure-iot-device

Opcje obiektu Klient. Przekazano do funkcji setOptions.

Przykład

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

X509

Właściwości

amqp

Opcjonalny obiekt z opcjami specyficznymi dla transportu protokołu 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 usługą Azure IoT Hub wewnątrz centrum danych platformy Azure, nie musisz tego ustawiać. Jeśli łączysz się z innym koncentratorem (np. koncentratorem usługi Edge), może być konieczne ustawienie go na certyfikat serwera używany przez centrum do obsługi 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 na żywo dla MQTT specjalnie. Jeśli używasz protokołu AMQP lub HTTP, nie zrobi to nic.
modelId

!! Użyj tylko cyfrowej reprezentacji bliźniaczej!! Ciąg używany w ustawieniu nazwy użytkownika MQTT identyfikator modelId usługi Digital Twin.
mqtt

Opcjonalny obiekt z opcjami specyficznymi dla transportu MQTT
productInfo

Niestandardowe informacje zdefiniowane przez użytkownika, które mają być dołączane 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 wstępnie udostępnionych kluczy.

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 protokołu 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 usługą Azure IoT Hub wewnątrz centrum danych platformy Azure, nie musisz tego ustawiać. Jeśli łączysz się z innym koncentratorem (np. koncentratorem usługi Edge), może być konieczne ustawienie go na certyfikat serwera używany przez centrum do obsługi 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 na żywo dla MQTT specjalnie. Jeśli używasz protokołu AMQP lub HTTP, nie zrobi to nic.

keepalive?: number

Wartość właściwości

number

modelId

!! Użyj tylko cyfrowej reprezentacji bliźniaczej!! Ciąg używany w ustawieniu nazwy użytkownika MQTT identyfikator modelId usługi Digital Twin.

modelId?: string

Wartość właściwości

string

mqtt

Opcjonalny obiekt z opcjami specyficznymi dla transportu MQTT

mqtt?: MqttTransportOptions

Wartość właściwości

MqttTransportOptions

productInfo

Niestandardowe informacje zdefiniowane przez użytkownika, które mają być dołączane 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 wstępnie udostępnionych kluczy.

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