Bagikan melalui

DeviceClientOptions interface

  • Referensi
Paket:
azure-iot-device

Opsi untuk objek Klien. Diteruskan ke fungsi setOptions .

Contoh

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

X509

Properti

amqp

Objek opsional dengan opsi khusus untuk transportasi AMQP
ca

Sertifikat publik dalam formulir PEM untuk otoritas sertifikat yang digunakan oleh layanan Hub. Ini adalah CA yang digunakan hub untuk mengamankan koneksi TLS dan klien memvalidasi koneksi menggunakan sertifikasi publik ini untuk memvalidasi identitas hub. Jika Anda menyambungkan ke Azure IoT Hub di dalam pusat data Azure, Anda tidak perlu mengatur ini. Jika Anda menyambungkan ke beberapa hub lain (misalnya Edge Hub), maka Anda mungkin perlu mengatur ini ke sertifikasi server yang digunakan hub untuk TLS.
http

Objek opsional dengan opsi khusus untuk transportasi HTTP
keepalive

Interval keepalive dalam format numerik (detik). Ini mengontrol ping keepalive untuk MQTT secara khusus. Jika Anda menggunakan AMQP atau HTTP, ini tidak akan melakukan apa pun.
modelId

!! Penggunaan Digital Twin Saja!! String yang digunakan dalam nama pengguna MQTT mengatur Digital Twin modelId.
mqtt

Objek opsional dengan opsi khusus untuk transportasi MQTT
productInfo

Informasi yang ditentukan pengguna kustom untuk ditambahkan ke informasi Agen Pengguna yang ada. Informasi Identifikasi Agen Pengguna digunakan sebagian besar oleh Microsoft secara internal untuk mengidentifikasi metadata yang terkait dengan penggunaan Klien Perangkat untuk Azure IoT.
tokenRenewal

Objek opsional dengan nilai perpanjangan token. Hanya gunakan dengan autentikasi yang menggunakan kunci yang dibagikan sebelumnya.

Properti yang Diwariskan

cert

Sertifikat X509.
clientCertEngine

Nama mesin OpenSSL yang dapat menyediakan sertifikat klien.
key

Kunci yang terkait dengan sertifikat X509.
passphrase

Frasa sandi yang digunakan untuk mendekode kunci yang terkait dengan sertifikat X509.

Detail Properti

amqp

Objek opsional dengan opsi khusus untuk transportasi AMQP

amqp?: AmqpTransportOptions

Nilai Properti

AmqpTransportOptions

ca

Sertifikat publik dalam formulir PEM untuk otoritas sertifikat yang digunakan oleh layanan Hub. Ini adalah CA yang digunakan hub untuk mengamankan koneksi TLS dan klien memvalidasi koneksi menggunakan sertifikasi publik ini untuk memvalidasi identitas hub. Jika Anda menyambungkan ke Azure IoT Hub di dalam pusat data Azure, Anda tidak perlu mengatur ini. Jika Anda menyambungkan ke beberapa hub lain (misalnya Edge Hub), maka Anda mungkin perlu mengatur ini ke sertifikasi server yang digunakan hub untuk TLS.

ca?: string

Nilai Properti

string

http

Objek opsional dengan opsi khusus untuk transportasi HTTP

http?: HttpTransportOptions

Nilai Properti

HttpTransportOptions

keepalive

Interval keepalive dalam format numerik (detik). Ini mengontrol ping keepalive untuk MQTT secara khusus. Jika Anda menggunakan AMQP atau HTTP, ini tidak akan melakukan apa pun.

keepalive?: number

Nilai Properti

number

modelId

!! Penggunaan Digital Twin Saja!! String yang digunakan dalam nama pengguna MQTT mengatur Digital Twin modelId.

modelId?: string

Nilai Properti

string

mqtt

Objek opsional dengan opsi khusus untuk transportasi MQTT

mqtt?: MqttTransportOptions

Nilai Properti

MqttTransportOptions

productInfo

Informasi yang ditentukan pengguna kustom untuk ditambahkan ke informasi Agen Pengguna yang ada. Informasi Identifikasi Agen Pengguna digunakan sebagian besar oleh Microsoft secara internal untuk mengidentifikasi metadata yang terkait dengan penggunaan Klien Perangkat untuk Azure IoT.

productInfo?: string

Nilai Properti

string

tokenRenewal

Objek opsional dengan nilai perpanjangan token. Hanya gunakan dengan autentikasi yang menggunakan kunci yang dibagikan sebelumnya.

tokenRenewal?: TokenRenewalValues

Nilai Properti

TokenRenewalValues

Detail Properti yang Diwariskan

cert

Sertifikat X509.

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

Nilai Properti

string | Buffer | string[] | Buffer[]

Diwarisi Dari X509.cert

clientCertEngine

Nama mesin OpenSSL yang dapat menyediakan sertifikat klien.

clientCertEngine?: string

Nilai Properti

string

Diwarisi Dari X509.clientCertEngine

key

Kunci yang terkait dengan sertifikat X509.

key?: string | Buffer

Nilai Properti

string | Buffer

Diwarisi Dari X509.key

passphrase

Frasa sandi yang digunakan untuk mendekode kunci yang terkait dengan sertifikat X509.

passphrase?: string

Nilai Properti

string

Diwarisi Dari X509.passphrase