DeviceClientOptions interface

  • Ссылка
Пакет:
azure-iot-device

Параметры для объекта Client. Передается в функцию setOptions .

Пример

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

X509

Свойства

amqp

Необязательный объект с параметрами, характерными для транспорта AMQP
ca

Открытый сертификат в форме PEM для центра сертификации, используемого службой концентратора. Это ЦС, который концентратор использует для защиты TLS-подключений, и клиент проверяет подключение с помощью этого общедоступного сертификата, чтобы проверить удостоверение концентратора. Если вы подключаетесь к Центр Интернета вещей Azure в центре обработки данных Azure, его не нужно настраивать. Если вы подключаетесь к другому концентратору (например, к пограничному центру), может потребоваться задать сертификат сервера, который концентратор использует для TLS.
http

Необязательный объект с параметрами, характерными для транспорта HTTP
keepalive

Интервал сохранения в числовом формате (в секундах). Это управляет отслеживанием проверки связи для MQTT, в частности. Если вы используете AMQP или HTTP, это ничего не сделает.
modelId

!! Digital Twin Use Only!! Строка, используемая при настройке имени пользователя MQTT для идентификатора модели цифрового двойника.
mqtt

Необязательный объект с параметрами, характерными для транспорта MQTT
productInfo

Пользовательские сведения, определенные пользователем, которые будут добавлены к существующим сведениям агента пользователя. Сведения об идентификации агента пользователя используются преимущественно корпорацией Майкрософт для внутренней идентификации метаданных, связанных с использованием клиента устройства для Интернета вещей Azure.
tokenRenewal

Необязательный объект со значениями обновления маркера. Используйте только с проверкой подлинности, использующими предварительно общие ключи.

Унаследованные свойства

cert

Сертификат X509.
clientCertEngine

Имя подсистемы OpenSSL, которая может предоставить сертификат клиента.
key

Ключ, связанный с сертификатом X509.
passphrase

Парольная фраза, используемая для декодирования ключа, связанного с сертификатом X509.

Сведения о свойстве

amqp

Необязательный объект с параметрами, характерными для транспорта AMQP

amqp?: AmqpTransportOptions

Значение свойства

AmqpTransportOptions

ca

Открытый сертификат в форме PEM для центра сертификации, используемого службой концентратора. Это ЦС, который концентратор использует для защиты TLS-подключений, и клиент проверяет подключение с помощью этого общедоступного сертификата, чтобы проверить удостоверение концентратора. Если вы подключаетесь к Центр Интернета вещей Azure в центре обработки данных Azure, его не нужно настраивать. Если вы подключаетесь к другому концентратору (например, к пограничному центру), может потребоваться задать сертификат сервера, который концентратор использует для TLS.

ca?: string

Значение свойства

string

http

Необязательный объект с параметрами, характерными для транспорта HTTP

http?: HttpTransportOptions

Значение свойства

HttpTransportOptions

keepalive

Интервал сохранения в числовом формате (в секундах). Это управляет отслеживанием проверки связи для MQTT, в частности. Если вы используете AMQP или HTTP, это ничего не сделает.

keepalive?: number

Значение свойства

number

modelId

!! Digital Twin Use Only!! Строка, используемая при настройке имени пользователя MQTT для идентификатора модели цифрового двойника.

modelId?: string

Значение свойства

string

mqtt

Необязательный объект с параметрами, характерными для транспорта MQTT

mqtt?: MqttTransportOptions

Значение свойства

MqttTransportOptions

productInfo

Пользовательские сведения, определенные пользователем, которые будут добавлены к существующим сведениям агента пользователя. Сведения об идентификации агента пользователя используются преимущественно корпорацией Майкрософт для внутренней идентификации метаданных, связанных с использованием клиента устройства для Интернета вещей Azure.

productInfo?: string

Значение свойства

string

tokenRenewal

Необязательный объект со значениями обновления маркера. Используйте только с проверкой подлинности, использующими предварительно общие ключи.

tokenRenewal?: TokenRenewalValues

Значение свойства

TokenRenewalValues

Сведения об унаследованном свойстве

cert

Сертификат X509.

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

Значение свойства

string | Buffer | string[] | Buffer[]

Наследуется от X509.cert

clientCertEngine

Имя подсистемы OpenSSL, которая может предоставить сертификат клиента.

clientCertEngine?: string

Значение свойства

string

Наследуется от X509.clientCertEngine

key

Ключ, связанный с сертификатом X509.

key?: string | Buffer

Значение свойства

string | Buffer

Наследуется от X509.key

passphrase

Парольная фраза, используемая для декодирования ключа, связанного с сертификатом X509.

passphrase?: string

Значение свойства

string

Наследуется от X509.passphrase