Condividi tramite


DeviceClientOptions interface

Opzioni per l'oggetto Client. Passato alla funzione setOptions .

Esempio

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

X509

Proprietà

amqp

Oggetto facoltativo con opzioni specifiche del trasporto AMQP

ca

Certificato pubblico in formato PEM per l'autorità di certificazione usata dal servizio Hub. Questa è la CA usata dall'hub per proteggere le connessioni TLS e il client convalida la connessione usando questo certificato pubblico per convalidare l'identità dell'hub. Se ci si connette a un hub IoT di Azure all'interno di un data center di Azure, non è necessario impostarlo. Se ci si connette ad un altro hub, ad esempio un hub Edge, potrebbe essere necessario impostarlo sul certificato del server usato dall'hub per TLS.

http

Oggetto facoltativo con opzioni specifiche del trasporto HTTP

keepalive

Intervallo Keepalive in formato numerico (secondi). In questo modo viene controllato il ping keepalive per MQTT in modo specifico. Se si usa AMQP o HTTP, non verrà eseguita alcuna operazione.

modelId

!! Solo uso di Gemelli digitali!! Stringa usata nel nome utente MQTT impostando il modelId di Gemelli digitali.

mqtt

Oggetto facoltativo con opzioni specifiche del trasporto MQTT

productInfo

Informazioni personalizzate definite dall'utente da aggiungere alle informazioni esistenti dell'agente utente. Le informazioni di identificazione agente utente vengono usate prevalentemente da Microsoft internamente per identificare i metadati correlati all'utilizzo del client del dispositivo per Azure IoT.

tokenRenewal

Oggetto facoltativo con valori di rinnovo del token. Usare solo con l'autenticazione che usa chiavi precondivie.

Proprietà ereditate

cert

Certificato X509.

clientCertEngine

Nome di un motore OpenSSL che può fornire il certificato client.

key

Chiave associata al certificato X509.

passphrase

Passphrase usata per decodificare la chiave associata al certificato X509.

Dettagli proprietà

amqp

Oggetto facoltativo con opzioni specifiche del trasporto AMQP

amqp?: AmqpTransportOptions

Valore della proprietà

ca

Certificato pubblico in formato PEM per l'autorità di certificazione usata dal servizio Hub. Questa è la CA usata dall'hub per proteggere le connessioni TLS e il client convalida la connessione usando questo certificato pubblico per convalidare l'identità dell'hub. Se ci si connette a un hub IoT di Azure all'interno di un data center di Azure, non è necessario impostarlo. Se ci si connette ad un altro hub, ad esempio un hub Edge, potrebbe essere necessario impostarlo sul certificato del server usato dall'hub per TLS.

ca?: string

Valore della proprietà

string

http

Oggetto facoltativo con opzioni specifiche del trasporto HTTP

http?: HttpTransportOptions

Valore della proprietà

keepalive

Intervallo Keepalive in formato numerico (secondi). In questo modo viene controllato il ping keepalive per MQTT in modo specifico. Se si usa AMQP o HTTP, non verrà eseguita alcuna operazione.

keepalive?: number

Valore della proprietà

number

modelId

!! Solo uso di Gemelli digitali!! Stringa usata nel nome utente MQTT impostando il modelId di Gemelli digitali.

modelId?: string

Valore della proprietà

string

mqtt

Oggetto facoltativo con opzioni specifiche del trasporto MQTT

mqtt?: MqttTransportOptions

Valore della proprietà

productInfo

Informazioni personalizzate definite dall'utente da aggiungere alle informazioni esistenti dell'agente utente. Le informazioni di identificazione agente utente vengono usate prevalentemente da Microsoft internamente per identificare i metadati correlati all'utilizzo del client del dispositivo per Azure IoT.

productInfo?: string

Valore della proprietà

string

tokenRenewal

Oggetto facoltativo con valori di rinnovo del token. Usare solo con l'autenticazione che usa chiavi precondivie.

tokenRenewal?: TokenRenewalValues

Valore della proprietà

TokenRenewalValues

Dettagli proprietà ereditate

cert

Certificato X509.

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

Valore della proprietà

string | Buffer | string[] | Buffer[]

Ereditato da X509.cert

clientCertEngine

Nome di un motore OpenSSL che può fornire il certificato client.

clientCertEngine?: string

Valore della proprietà

string

Ereditato da X509.clientCertEngine

key

Chiave associata al certificato X509.

key?: string | Buffer

Valore della proprietà

string | Buffer

Ereditato da X509.key

passphrase

Passphrase usata per decodificare la chiave associata al certificato X509.

passphrase?: string

Valore della proprietà

string

Ereditato da X509.passphrase