DeviceClientOptions interface

  • Referência
Pacote:
azure-iot-device

Opções para o objeto Client. Passado 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 formulário PEM para a autoridade de certificação que está sendo usada pelo serviço Hub. Essa é a AC 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 Hub do Edge), talvez seja necessário definir isso para o certificado do servidor que o hub usa para TLS.
http

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

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

!! Somente uso de gêmeo digital!! Cadeia de caracteres usada no nome de usuário do MQTT definindo a ModelId do Gêmeo Digital.
mqtt

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

Informações personalizadas definidas pelo usuário a serem acrescentadas às informações existentes do Agente de Usuário. 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 IoT do Azure.
tokenRenewal

Objeto opcional com valores de renovação de token. Use apenas com a autenticação que usa 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

Frase secreta usada para decodificar a chave associada ao certificado X509.

Detalhes da propriedade

amqp

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

amqp?: AmqpTransportOptions

Valor da propriedade

AmqpTransportOptions

ca

Certificado público no formulário PEM para a autoridade de certificação que está sendo usada pelo serviço Hub. Essa é a AC 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 Hub do Edge), talvez seja necessário definir isso para o certificado do servidor que o hub usa para TLS.

ca?: string

Valor da propriedade

string

http

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

http?: HttpTransportOptions

Valor da propriedade

HttpTransportOptions

keepalive

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

keepalive?: number

Valor da propriedade

number

modelId

!! Somente uso de gêmeo digital!! Cadeia de caracteres usada no nome de usuário do MQTT definindo a ModelId do Gêmeo Digital.

modelId?: string

Valor da propriedade

string

mqtt

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

mqtt?: MqttTransportOptions

Valor da propriedade

MqttTransportOptions

productInfo

Informações personalizadas definidas pelo usuário a serem acrescentadas às informações existentes do Agente de Usuário. 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 IoT do Azure.

productInfo?: string

Valor da propriedade

string

tokenRenewal

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

tokenRenewal?: TokenRenewalValues

Valor da propriedade

TokenRenewalValues

Detalhes das propriedades herdadas

cert

Certificado X509.

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

Valor da 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 da propriedade

string

Herdado de X509.clientCertEngine

key

Chave associada ao certificado X509.

key?: string | Buffer

Valor da propriedade

string | Buffer

Herdado de X509.key

passphrase

Frase secreta usada para decodificar a chave associada ao certificado X509.

passphrase?: string

Valor da propriedade

string

Herdado de X509.passphrase