DeviceClientOptions interface

  • Referencia
Paquete:
azure-iot-device

Opciones para el objeto Client. Se pasa a la función setOptions .

Ejemplo

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

X509

Propiedades

amqp

Objeto opcional con opciones específicas del transporte de AMQP
ca

Certificado público en formato PEM para la entidad de certificación que usa el servicio Hub. Esta es la entidad de certificación que usa el centro para proteger las conexiones TLS y el cliente valida la conexión mediante este certificado público para validar la identidad del centro. Si se conecta a un Azure IoT Hub dentro de un centro de datos de Azure, no es necesario establecerlo. Si se conecta a otro centro (por ejemplo, un centro de Edge), es posible que tenga que establecerlo en el certificado de servidor que usa el centro para TLS.
http

Objeto opcional con opciones específicas del transporte HTTP
keepalive

Intervalo keepalive en formato numérico (segundos). Esto controla el ping keepalive para MQTT específicamente. Si usa AMQP o HTTP, esto no hará nada.
modelId

!! Digital Twin Use Only!! Cadena usada en el valor de nombre de usuario MQTT del modelId de Gemelo digital.
mqtt

Objeto opcional con opciones específicas del transporte MQTT
productInfo

Información personalizada definida por el usuario que se va a anexar a la información existente del Agente de usuario. Microsoft usa internamente la información de identificación del agente de usuario para identificar los metadatos relacionados con el uso del cliente del dispositivo para Azure IoT.
tokenRenewal

Objeto opcional con valores de renovación de tokens. Use solo con la autenticación que use claves previamente compartidas.

Propiedades heredadas

cert

Certificado X509.
clientCertEngine

Nombre de un motor de OpenSSL que puede proporcionar el certificado de cliente.
key

Clave asociada al certificado X509.
passphrase

Frase de contraseña usada para descodificar la clave asociada al certificado X509.

Detalles de las propiedades

amqp

Objeto opcional con opciones específicas del transporte de AMQP

amqp?: AmqpTransportOptions

Valor de propiedad

AmqpTransportOptions

ca

Certificado público en formato PEM para la entidad de certificación que usa el servicio Hub. Esta es la entidad de certificación que usa el centro para proteger las conexiones TLS y el cliente valida la conexión mediante este certificado público para validar la identidad del centro. Si se conecta a un Azure IoT Hub dentro de un centro de datos de Azure, no es necesario establecerlo. Si se conecta a otro centro (por ejemplo, un centro de Edge), es posible que tenga que establecerlo en el certificado de servidor que usa el centro para TLS.

ca?: string

Valor de propiedad

string

http

Objeto opcional con opciones específicas del transporte HTTP

http?: HttpTransportOptions

Valor de propiedad

HttpTransportOptions

keepalive

Intervalo keepalive en formato numérico (segundos). Esto controla el ping keepalive para MQTT específicamente. Si usa AMQP o HTTP, esto no hará nada.

keepalive?: number

Valor de propiedad

number

modelId

!! Digital Twin Use Only!! Cadena usada en el valor de nombre de usuario MQTT del modelId de Gemelo digital.

modelId?: string

Valor de propiedad

string

mqtt

Objeto opcional con opciones específicas del transporte MQTT

mqtt?: MqttTransportOptions

Valor de propiedad

MqttTransportOptions

productInfo

Información personalizada definida por el usuario que se va a anexar a la información existente del Agente de usuario. Microsoft usa internamente la información de identificación del agente de usuario para identificar los metadatos relacionados con el uso del cliente del dispositivo para Azure IoT.

productInfo?: string

Valor de propiedad

string

tokenRenewal

Objeto opcional con valores de renovación de tokens. Use solo con la autenticación que use claves previamente compartidas.

tokenRenewal?: TokenRenewalValues

Valor de propiedad

TokenRenewalValues

Detalles de las propiedades heredadas

cert

Certificado X509.

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

Valor de propiedad

string | Buffer | string[] | Buffer[]

Heredado de X509.cert

clientCertEngine

Nombre de un motor de OpenSSL que puede proporcionar el certificado de cliente.

clientCertEngine?: string

Valor de propiedad

string

Heredado de X509.clientCertEngine

key

Clave asociada al certificado X509.

key?: string | Buffer

Valor de propiedad

string | Buffer

Heredado de X509.key

passphrase

Frase de contraseña usada para descodificar la clave asociada al certificado X509.

passphrase?: string

Valor de propiedad

string

Heredado de Frase de contraseña X509.passphrase