DeviceClientOptions interface

  • Referência
Pacote:
azure-iot-device

Opções para o objeto Cliente. Transmitido 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 autoridade de certificação que está a ser utilizada pelo serviço Hub. Esta é a AC que o hub está a utilizar para proteger as ligações TLS e o cliente valida a ligação com este certificado público para validar a identidade do hub. Se estiver a ligar-se a um Hub IoT do Azure dentro de um datacenter do Azure, não precisa de o definir. Se estiver a ligar-se a outro hub (por exemplo, um Hub do Edge), poderá ter de o definir para o certificado de servidor que o hub utiliza para o TLS.
http

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

Intervalo keepalive em formato numérico (segundos). Isto controla especificamente o ping keepalive para MQTT. Se estiver a utilizar AMQP ou HTTP, isto não fará nada.
modelId

!! Apenas Utilização de Duplos Digitais!! Cadeia utilizada no nome de utilizador MQTT a definir o ModelId do Duplo Digital.
mqtt

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

Informações personalizadas definidas pelo utilizador a acrescentar às informações existentes do Agente de Utilizador. As informações de Identificação do Agente de Utilizador são utilizadas predominantemente pela Microsoft internamente para identificar metadados relacionados com a utilização do Cliente do Dispositivo para o Azure IoT.
tokenRenewal

Objeto opcional com valores de renovação de tokens. Utilize apenas com a autenticação que utiliza chaves pré-partilhadas.

Propriedades Herdadas

cert

Certificado X509.
clientCertEngine

Nome de um motor OpenSSL que pode fornecer o certificado de cliente.
key

Chave associada ao certificado X509.
passphrase

Frase de acesso utilizada para descodificar 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 formulário PEM para autoridade de certificação que está a ser utilizada pelo serviço Hub. Esta é a AC que o hub está a utilizar para proteger as ligações TLS e o cliente valida a ligação com este certificado público para validar a identidade do hub. Se estiver a ligar-se a um Hub IoT do Azure dentro de um datacenter do Azure, não precisa de o definir. Se estiver a ligar-se a outro hub (por exemplo, um Hub do Edge), poderá ter de o definir para o certificado de servidor que o hub utiliza para o 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). Isto controla especificamente o ping keepalive para MQTT. Se estiver a utilizar AMQP ou HTTP, isto não fará nada.

keepalive?: number

Valor de Propriedade

number

modelId

!! Apenas Utilização de Duplos Digitais!! Cadeia utilizada no nome de utilizador MQTT a definir o ModelId do Duplo Digital.

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 utilizador a acrescentar às informações existentes do Agente de Utilizador. As informações de Identificação do Agente de Utilizador são utilizadas predominantemente pela Microsoft internamente para identificar metadados relacionados com a utilização do Cliente do Dispositivo para o Azure IoT.

productInfo?: string

Valor de Propriedade

string

tokenRenewal

Objeto opcional com valores de renovação de tokens. Utilize apenas com a autenticação que utiliza chaves pré-partilhadas.

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 motor OpenSSL que pode fornecer o certificado de cliente.

clientCertEngine?: string

Valor de Propriedade

string

Herdado de X509.clientCertEngine

key

Chave associada ao certificado X509.

key?: string | Buffer

Valor de Propriedade

string | Buffer

Herdado de X509.key

passphrase

Frase de acesso utilizada para descodificar a chave associada ao certificado X509.

passphrase?: string

Valor de Propriedade

string

Herdado de X509.passphrase