DeviceClientOptions interface

Pacote:

azure-iot-device

Opções para o objeto Client. Passou para a função setOptions.

Exemplo

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

Extends

X509

Propriedades

amqp	Objeto opcional com opções específicas para o transporte AMQP
ca	Certificado público no formato PEM para a autoridade de certificação que está sendo usada pelo serviço Hub. Esta é a autoridade de certificação que o hub está usando para proteger conexões TLS e o cliente valida a conexão usando esse certificado público para validar a identidade do hub. Se você estiver se conectando a um Hub IoT do Azure dentro de um data center do Azure, não precisará definir isso. Se você estiver se conectando a algum outro hub (por exemplo, um Edge Hub), talvez seja necessário definir isso para o certificado de servidor que o hub usa para TLS.
http	Objeto opcional com opções específicas para o transporte HTTP
keepalive	Intervalo Keepalive em formato numérico (segundos). Isso controla o ping keepalive para MQTT especificamente. Se você estiver usando AMQP ou HTTP, isso não fará nada.
modelId	!! Uso de gêmeos digitais apenas!! String usada no nome de usuário MQTT definindo o Digital Twin modelId.
mqtt	Objeto opcional com opções específicas para o transporte MQTT
productInfo	Informações personalizadas definidas pelo usuário a serem anexadas às informações existentes do User Agent. As informações de Identificação do Agente de Usuário são usadas predominantemente pela Microsoft internamente para identificar metadados relacionados ao uso do Cliente de Dispositivo para o Azure IoT.
tokenRenewal	Objeto opcional com valores de renovação de token. Use apenas com autenticação que use chaves pré-compartilhadas.

Propriedades Herdadas

cert	Certificado X509.
clientCertEngine	Nome de um mecanismo OpenSSL que pode fornecer o certificado do cliente.
key	Chave associada ao certificado X509.
passphrase	Senha usada para decodificar a chave associada ao certificado X509.

Detalhes de Propriedade

amqp

Objeto opcional com opções específicas para o transporte AMQP

amqp?: AmqpTransportOptions

Valor de Propriedade

AmqpTransportOptions

ca

Certificado público no formato PEM para a autoridade de certificação que está sendo usada pelo serviço Hub. Esta é a autoridade de certificação que o hub está usando para proteger conexões TLS e o cliente valida a conexão usando esse certificado público para validar a identidade do hub. Se você estiver se conectando a um Hub IoT do Azure dentro de um data center do Azure, não precisará definir isso. Se você estiver se conectando a algum outro hub (por exemplo, um Edge Hub), talvez seja necessário definir isso para o certificado de servidor que o hub usa para TLS.

ca?: string

Valor de Propriedade

string

http

Objeto opcional com opções específicas para o transporte HTTP

http?: HttpTransportOptions

Valor de Propriedade

HttpTransportOptions

keepalive

Intervalo Keepalive em formato numérico (segundos). Isso controla o ping keepalive para MQTT especificamente. Se você estiver usando AMQP ou HTTP, isso não fará nada.

keepalive?: number

Valor de Propriedade

number

modelId

!! Uso de gêmeos digitais apenas!! String usada no nome de usuário MQTT definindo o Digital Twin modelId.

modelId?: string

Valor de Propriedade

string

mqtt

Objeto opcional com opções específicas para o transporte MQTT

mqtt?: MqttTransportOptions

Valor de Propriedade

MqttTransportOptions

productInfo

Informações personalizadas definidas pelo usuário a serem anexadas às informações existentes do User Agent. As informações de Identificação do Agente de Usuário são usadas predominantemente pela Microsoft internamente para identificar metadados relacionados ao uso do Cliente de Dispositivo para o Azure IoT.

productInfo?: string

Valor de Propriedade

string

tokenRenewal

Objeto opcional com valores de renovação de token. Use apenas com autenticação que use chaves pré-compartilhadas.

tokenRenewal?: TokenRenewalValues

Valor de Propriedade

TokenRenewalValues

Detalhes da Propriedade Herdada

cert

Certificado X509.

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

Valor de Propriedade

string | Buffer | string[] | Buffer[]

herdado de X509.cert

clientCertEngine

Nome de um mecanismo OpenSSL que pode fornecer o certificado do cliente.

clientCertEngine?: string

Valor de Propriedade

string

herdado do X509.clientCertEngine

key

Chave associada ao certificado X509.

key?: string | Buffer

Valor de Propriedade

string | Buffer

herdada de X509.key

passphrase

Senha usada para decodificar a chave associada ao certificado X509.

passphrase?: string

Valor de Propriedade

string

herdado de x509.passphrase