Bagikan melalui

azure-iot-common package

  • Referensi

Kelas

Message

Objek Message digunakan untuk telemetri (perangkat-ke-cloud) dan perintah (cloud-ke-perangkat) pesan asinkron antara perangkat dan layanan IoT Hub. Ini adalah transport-agnostic, yang berarti bekerja dengan cara yang sama melalui AMQP, MQTT dan HTTP.
ArgumentError

Kesalahan muncul ketika argumen tidak valid.
ArgumentOutOfRangeError

Kesalahan muncul ketika argumen memiliki nilai yang berada di luar rentang yang dapat diterima.
BadDeviceResponseError

Kesalahan muncul ketika perangkat mengirim respons buruk ke panggilan metode perangkat.
CloudToDeviceDetachedError

Kesalahan muncul ketika fitur c2d berhenti bekerja di tingkat transportasi, mengharuskan klien untuk mencoba memulainya kembali.
DeviceAlreadyExistsError

Kesalahan muncul ketika id perangkat yang digunakan untuk pembuatan perangkat sudah ada di Registri Identitas Perangkat.
DeviceMaximumQueueDepthExceededError

Kesalahan muncul ketika antrean pesan untuk perangkat penuh.
DeviceMessageLockLostError

Kesalahan yang muncul saat menyelesaikan pesan gagal karena token kunci yang terkait dengan pesan hilang.
DeviceMethodsDetachedError

Kesalahan muncul ketika fitur metode perangkat berhenti berfungsi di tingkat transportasi, mengharuskan klien untuk mencoba memulainya kembali.
DeviceNotFoundError

Kesalahan muncul ketika perangkat tidak dapat ditemukan di registri instans IoT Hub.
DeviceRegistrationFailedError

Kesalahan yang dilemparkan ketika operasi pendaftaran DPS gagal
DeviceTimeoutError

Kesalahan muncul ketika perangkat tidak memproses panggilan metode pada waktunya.
FormatError

Kesalahan muncul ketika string yang seharusnya memiliki pemformatan tertentu tidak diformat dengan benar.
GatewayTimeoutError

Kesalahan muncul ketika instans IoT Hub tidak memproses panggilan metode perangkat pada waktunya.
InternalServerError

Kesalahan muncul ketika terjadi kesalahan server internal. Anda mungkin telah menemukan bug?
InvalidEtagError

Kesalahan muncul ketika eTag yang ditentukan salah diformat atau kedaluarsa.
InvalidOperationError

Kesalahan muncul ketika operasi dicoba tetapi tidak diizinkan.
IotHubNotFoundError

Kesalahan muncul saat hub Azure IoT tidak ditemukan.
IotHubQuotaExceededError

Kesalahan yang melemparkan kuota hub Azure IoT telah terlampaui. Kuota diatur ulang secara berkala, operasi ini harus menunggu sampai saat itu. Untuk mempelajari selengkapnya tentang kuota, lihat Azure IoT Hub kuota dan pembatasan
IoTHubSuspendedError

Kesalahan muncul ketika IoT Hub telah ditangguhkan.
JobNotFoundError

Kesalahan muncul ketika pekerjaan dengan pengidentifikasi yang ditentukan tidak ditemukan.
MessageTooLargeError

Kesalahan yang dilemparkan ketika pesan yang dikirim terlalu besar: ukuran maksimum adalah 256Kb.
NotConnectedError

Kesalahan muncul ketika perangkat terputus dan operasi tidak dapat diselesaikan.
NotImplementedError

Kesalahan muncul ketika fitur belum diimplementasikan tetapi tempat penampung ada.
OperationCancelledError

Kesalahan muncul ketika operasi apa pun (lokal atau jarak jauh) dibatalkan
PreconditionFailedError

Kesalahan muncul ketika kondisi yang seharusnya terpenuhi untuk menjalankan operasi tidak.
SecurityDeviceError

Kesalahan muncul ketika perangkat/driver keamanan tingkat rendah gagal.
ServiceUnavailableError

Kesalahan muncul ketika layanan tidak tersedia. Operasi harus dicoba kembali.
ThrottlingError

Kesalahan muncul ketika IoT Hub dibatasi karena aktivitas yang berlebihan. Untuk mempelajari selengkapnya tentang kuota, lihat Azure IoT Hub kuota dan pembatasan
TimeoutError

Kesalahan muncul ketika waktu habis terjadi
TooManyDevicesError

Kesalahan muncul ketika jumlah maksimum perangkat di hub tertentu telah tercapai.
TwinDetachedError

Kesalahan muncul ketika fitur kembar berhenti bekerja di tingkat transportasi, mengharuskan klien untuk mencoba memulainya kembali.
TwinRequestError

Kesalahan generik muncul ketika permintaan kembar gagal dengan kode kesalahan yang tidak diketahui.
UnauthorizedError

Kesalahan muncul ketika parameter koneksi salah dan server menolak koneksi.
Connected

Hasil dikembalikan ketika transportasi berhasil tersambung.
Disconnected

Hasil dikembalikan ketika transportasi berhasil terputus.
MessageAbandoned

Hasil dikembalikan ketika pesan berhasil ditinggalkan.
MessageCompleted

Hasil dikembalikan ketika pesan berhasil ditolak.
MessageEnqueued

Hasil dikembalikan ketika pesan berhasil diantrekan.
MessageRejected

Hasil dikembalikan ketika pesan berhasil ditolak.
SharedAccessSignatureUpdated

Hasil dikembalikan ketika token SAS telah berhasil diperbarui.
TransportConfigured

Hasil dikembalikan ketika transportasi berhasil dikonfigurasi.
ConnectionString

Menjelaskan parameter yang memungkinkan perangkat atau aplikasi cloud tersambung ke hub Azure IoT.
ExponentialBackOffWithJitter

Menerapkan Backoff Eksponensial dengan strategi coba lagi Jitter. Fungsi untuk menghitung interval berikutnya adalah sebagai berikut (x adalah coba lagi ke-x): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry

Kebijakan stub yang memblokir tentatif coba lagi. Operasi tidak dicoba kembali.
RetryOperation

Menerapkan logika yang diperlukan untuk mencoba kembali operasi seperti menyambungkan, menerima pesan C2D, mengirim telemetri, pembaruan kembar, dll.
SharedAccessSignature

Token tanda tangan akses bersama digunakan untuk mengautentikasi koneksi saat menggunakan kunci konten (dibandingkan dengan sertifikat x509) untuk mengamankan koneksi dengan hub Azure IoT.

Antarmuka

AuthenticationProvider

Antarmuka yang harus diimplementasikan oleh objek yang digunakan untuk memberikan kredensial ke transportasi yang digunakan oleh klien perangkat untuk mengautentikasi dengan instans hub Azure IoT.
Receiver
RetryPolicy

Antarmuka yang menjelaskan objek kebijakan coba lagi. Kebijakan percobaan kembali terdiri dari 2 hal

  • Algoritma yang menghitung waktu berikutnya untuk mencoba kembali berdasarkan angka atau percobaan ulang saat ini.
  • Filter kesalahan yang memutuskan, berdasarkan jenis kesalahan yang diterima, apakah percobaan kembali harus terjadi atau tidak.

2 komponen tersebut bersembunyi di balik 2 panggilan metode yang dijelaskan dalam antarmuka ini.
TransportConfig

Struktur konfigurasi yang digunakan oleh transportasi dan AuthenticationProvider objek untuk menyimpan dan bertukar kredensial.
X509

Objek yang digunakan untuk menyimpan sertifikat dan kunci X509 untuk digunakan transportasi.

Ini diteruskan langsung ke objek tingkat rendah yang digunakan oleh Node.js untuk menyambungkan soket TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Alias Jenis

BufferConvertible
ResultWithHttpResponse
Callback

Menentukan jenis yang menjelaskan panggilan balik reguler dengan dua hasil - satu adalah Kesalahan, yang lain adalah nilai hasil.
DoubleValueCallback

Menentukan jenis yang menjelaskan panggilan balik dengan dua hasil.
ErrorCallback

Menentukan jenis yang menjelaskan panggilan balik hanya dengan nilai hasil Kesalahan.
HttpResponseCallback

Menentukan jenis yang menjelaskan panggilan balik dengan tiga hasil - respons, respons HTTP mentah, dan Kesalahan.
NoErrorCallback

Menentukan jenis yang menjelaskan panggilan balik dengan satu nilai hasil non-kesalahan.
TripleValueCallback

Menentukan jenis yang menjelaskan panggilan balik reguler dengan tiga hasil - yang pertama adalah Kesalahan, dua lainnya adalah nilai hasil.

Enum

AuthenticationType

Tentukan jenis autentikasi yang AuthenticationProviderdigunakan oleh .

Fungsi

anHourFromNow()

Mengembalikan detik yang berlalu sejak 1 Januari 1970 00:00:00 UTC hingga satu jam dari sekarang.
encodeUriComponentStrict(string)

Detail Fungsi

anHourFromNow()

Mengembalikan detik yang berlalu sejak 1 Januari 1970 00:00:00 UTC hingga satu jam dari sekarang.

function anHourFromNow(): number

Mengembalikan

number

encodeUriComponentStrict(string) 

function encodeUriComponentStrict(str: string): string

Parameter

str

string

Mengembalikan

string