IoTHubModuleClient Kelas

Klien modul sinkron yang tersambung ke instans Azure IoT Hub atau Azure IoT Edge.

Initializer untuk IoTHubModuleClient.

Penginisialisasi ini tidak boleh dipanggil secara langsung. Sebagai gantinya, gunakan salah satu classmethod '>>create_from_<<' untuk membuat instans

Warisan
azure.iot.device.iothub.sync_clients.GenericIoTHubClient
IoTHubModuleClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClient
IoTHubModuleClient

Konstruktor

IoTHubModuleClient(mqtt_pipeline, http_pipeline)

Parameter

mqtt_pipeline
<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
Diperlukan

Alur yang digunakan untuk menyambungkan ke titik akhir IoTHub.

http_pipeline
<xref:azure.iot.device.iothub.pipeline.HTTPPipeline>
Diperlukan

Alur yang digunakan untuk menyambungkan ke titik akhir IoTHub melalui HTTP.

Metode

connect

Menyambungkan klien ke instans Azure IoT Hub atau Azure IoT Edge Hub.

Tujuan dipilih berdasarkan kredensial yang diteruskan melalui parameter auth_provider yang disediakan ketika objek ini diinisialisasi.

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai koneksi ke layanan telah sepenuhnya dibuat.

create_from_connection_string

Buat instans klien dari perangkat IoTHub atau string koneksi modul.

create_from_edge_environment

Buat instans klien dari lingkungan IoT Edge.

Metode ini hanya dapat dijalankan dari dalam kontainer IoT Edge, atau di lingkungan debugging yang dikonfigurasi untuk pengembangan Edge (misalnya Visual Studio, Visual Studio Code)

create_from_sastoken

Membuat instans klien dari string Token SAS yang telah dibuat sebelumnya

create_from_x509_certificate

Membuat instans klien menggunakan autentikasi sertifikat X509.

disconnect

Putuskan sambungan klien dari instans Azure IoT Hub atau Azure IoT Edge Hub.

Disarankan agar Anda memastikan untuk memanggil fungsi ini ketika Anda benar-benar selesai dengan instans klien Anda.

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai koneksi ke layanan telah ditutup sepenuhnya.

get_twin

Mendapatkan perangkat atau modul kembar dari layanan Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai kembar diambil dari layanan.

invoke_method

Panggil metode dari klien Anda ke perangkat atau klien modul, dan terima respons terhadap panggilan metode.

patch_twin_reported_properties

Perbarui properti yang dilaporkan dengan layanan Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai patch dikirim ke layanan dan diakui.

Jika layanan mengembalikan kesalahan pada operasi patch, fungsi ini akan memunculkan kesalahan yang sesuai.

receive_message_on_input

Terima pesan input yang telah dikirim dari Modul lain ke input tertentu.

Tidak digunakan lagi sejak versi 2.3.0: Kami sarankan Anda menggunakan properti .on_message_received untuk mengatur handler sebagai gantinya

receive_method_request

Terima permintaan metode melalui Azure IoT Hub atau Azure IoT Edge Hub.

Tidak digunakan lagi sejak versi 2.3.0: Kami sarankan Anda menggunakan properti .on_method_request_received untuk mengatur handler sebagai gantinya

receive_twin_desired_properties_patch

Terima patch properti yang diinginkan melalui Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah panggilan sinkron, yang berarti sebagai berikut:

  1. Jika block=True, fungsi ini akan memblokir hingga salah satu hal berikut ini terjadi:

    • patch properti yang diinginkan diterima dari Azure IoT Hub atau Azure IoT Edge Hub.

    • periode batas waktu, jika disediakan, berlalu. Jika waktu habis terjadi, fungsi ini akan meningkatkan pengecualian InboxEmpty

  2. Jika block=False, fungsi ini akan mengembalikan patch properti yang diinginkan yang mungkin telah diterima oleh alur, tetapi belum dikembalikan ke aplikasi. Jika tidak ada patch properti yang diinginkan yang diterima oleh alur, fungsi ini akan meningkatkan pengecualian InboxEmpty

Tidak digunakan lagi sejak versi 2.3.0: Kami sarankan Anda menggunakan properti .on_twin_desired_properties_patch_received untuk mengatur handler sebagai gantinya

send_message

Mengirim pesan ke titik akhir peristiwa default pada instans Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah peristiwa sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai peristiwa dikirim ke layanan dan layanan telah mengakui penerimaan peristiwa.

Jika koneksi ke layanan sebelumnya belum dibuka oleh panggilan untuk menyambungkan, fungsi ini akan membuka koneksi sebelum mengirim peristiwa.

send_message_to_output

Mengirim peristiwa/pesan ke output modul yang diberikan.

Ini adalah peristiwa keluar dan dimaksudkan untuk menjadi "peristiwa output".

Ini adalah peristiwa sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai peristiwa dikirim ke layanan dan layanan telah mengakui penerimaan peristiwa.

Jika koneksi ke layanan sebelumnya belum dibuka oleh panggilan untuk menyambungkan, fungsi ini akan membuka koneksi sebelum mengirim peristiwa.

send_method_response

Kirim respons ke permintaan metode melalui Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah peristiwa sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai peristiwa dikirim ke layanan dan layanan telah mengakui penerimaan peristiwa.

Jika koneksi ke layanan sebelumnya belum dibuka oleh panggilan untuk menyambungkan, fungsi ini akan membuka koneksi sebelum mengirim peristiwa.

shutdown

Matikan klien untuk keluar dengan baik.

Setelah metode ini dipanggil, setiap upaya pada panggilan klien lebih lanjut akan mengakibatkan ClientError dinaikkan

update_sastoken

Perbarui Token SAS klien yang digunakan untuk autentikasi, lalu autentikasi ulang koneksi.

API ini hanya dapat digunakan jika klien awalnya dibuat dengan Token SAS.

connect

Menyambungkan klien ke instans Azure IoT Hub atau Azure IoT Edge Hub.

Tujuan dipilih berdasarkan kredensial yang diteruskan melalui parameter auth_provider yang disediakan ketika objek ini diinisialisasi.

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai koneksi ke layanan telah sepenuhnya dibuat.

connect()

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu koneksi habis.

jika ada kegagalan yang tidak terduga selama eksekusi.

create_from_connection_string

Buat instans klien dari perangkat IoTHub atau string koneksi modul.

create_from_connection_string(connection_string, **kwargs)

Parameter

connection_string
str
Diperlukan

String koneksi untuk IoTHub yang ingin Anda sambungkan.

server_verification_cert
str
Diperlukan

Opsi Konfigurasi. Rantai sertifikat tepercaya. Diperlukan saat menggunakan menyambungkan ke titik akhir yang memiliki akar kepercayaan non-standar, seperti gateway protokol.

websockets
bool
Diperlukan

Opsi Konfigurasi. Defaultnya adalah False. Atur ke true jika menggunakan MQTT melalui websocket.

cipher
str atau list(str)
Diperlukan

Opsi Konfigurasi. Cipher suite untuk TLS/SSL, sebagai string dalam "format daftar sandi OpenSSL" atau sebagai daftar string cipher suite.

product_info
str
Diperlukan

Opsi Konfigurasi. Defaultnya adalah string kosong. String berisi info produk arbitrer yang ditambahkan ke string agen pengguna.

proxy_options
ProxyOptions
Diperlukan

Opsi untuk mengirim lalu lintas melalui server proksi.

sastoken_ttl
int
Diperlukan

Waktu hidup (dalam detik) untuk SasToken yang dibuat digunakan untuk autentikasi. Defaultnya adalah 3600 detik (1 jam).

keep_alive
int
Diperlukan

Periode maksimum dalam detik antara komunikasi dengan broker. Jika tidak ada pesan lain yang ditukar, ini mengontrol tingkat di mana klien akan mengirim pesan ping ke broker. Jika tidak disediakan nilai default 60 detik akan digunakan.

auto_connect
bool
Diperlukan

Sambungkan klien secara otomatis ke IoTHub saat metode dipanggil yang memerlukan koneksi untuk dibuat. (Default: True)

connection_retry
bool
Diperlukan

Mencoba membuat ulang koneksi yang terputus (Default: True)

connection_retry_interval
int
Diperlukan

Interval, dalam detik, antara upaya untuk membuat ulang koneksi yang terputus (Default: 10)

ensure_desired_properties
bool
Diperlukan

Pastikan patch properti terbaru yang diinginkan telah diterima setelah koneksi ulang (Default:True)

Mengembalikan

Instans klien IoTHub yang menggunakan string koneksi untuk autentikasi.

Pengecualian

ValueError if given an invalid connection_string.
TypeError if given an unsupported parameter.

create_from_edge_environment

Buat instans klien dari lingkungan IoT Edge.

Metode ini hanya dapat dijalankan dari dalam kontainer IoT Edge, atau di lingkungan debugging yang dikonfigurasi untuk pengembangan Edge (misalnya Visual Studio, Visual Studio Code)

create_from_edge_environment(**kwargs)

Parameter

websockets
bool
Diperlukan

Opsi Konfigurasi. Defaultnya adalah False. Atur ke true jika menggunakan MQTT melalui websocket.

cipher
str atau list(str)
Diperlukan

Opsi Konfigurasi. Cipher suite untuk TLS/SSL, sebagai string dalam "format daftar sandi OpenSSL" atau sebagai daftar string cipher suite.

product_info
str
Diperlukan

Opsi Konfigurasi. Defaultnya adalah string kosong. String berisi info produk arbitrer yang ditambahkan ke string agen pengguna.

proxy_options
ProxyOptions
Diperlukan

Opsi untuk mengirim lalu lintas melalui server proksi.

sastoken_ttl
int
Diperlukan

Waktu hidup (dalam detik) untuk SasToken yang dibuat digunakan untuk autentikasi. Defaultnya adalah 3600 detik (1 jam)

keep_alive
int
Diperlukan

Periode maksimum dalam detik antara komunikasi dengan broker. Jika tidak ada pesan lain yang ditukar, ini mengontrol tingkat di mana klien akan mengirim pesan ping ke broker. Jika tidak disediakan nilai default 60 detik akan digunakan.

auto_connect
bool
Diperlukan

Sambungkan klien secara otomatis ke IoTHub saat metode dipanggil yang memerlukan koneksi untuk dibuat. (Default: True)

connection_retry
bool
Diperlukan

Mencoba membuat ulang koneksi yang terputus (Default: True)

connection_retry_interval
int
Diperlukan

Interval, dalam detik, antara upaya untuk membuat ulang koneksi yang terputus (Default: 10)

Mengembalikan

Instans klien IoTHub yang menggunakan lingkungan IoT Edge untuk autentikasi.

Pengecualian

OSError if the IoT Edge container is not configured correctly.
ValueError if debug variables are invalid.
TypeError if given an unsupported parameter.

create_from_sastoken

Membuat instans klien dari string Token SAS yang telah dibuat sebelumnya

create_from_sastoken(sastoken, **kwargs)

Parameter

sastoken
str
Diperlukan

String Token SAS

server_verification_cert
str
Diperlukan

Opsi Konfigurasi. Rantai sertifikat tepercaya. Diperlukan saat menggunakan menyambungkan ke titik akhir yang memiliki akar kepercayaan non-standar, seperti gateway protokol.

gateway_hostname
str
Diperlukan

Opsi Konfigurasi. Nama host gateway untuk perangkat gateway.

websockets
bool
Diperlukan

Opsi Konfigurasi. Defaultnya adalah False. Atur ke true jika menggunakan MQTT melalui websocket.

cipher
str atau list(str)
Diperlukan

Opsi Konfigurasi. Cipher suite untuk TLS/SSL, sebagai string dalam "format daftar sandi OpenSSL" atau sebagai daftar string cipher suite.

product_info
str
Diperlukan

Opsi Konfigurasi. Defaultnya adalah string kosong. String berisi info produk arbitrer yang ditambahkan ke string agen pengguna.

proxy_options
ProxyOptions
Diperlukan

Opsi untuk mengirim lalu lintas melalui server proksi.

keep_alive
int
Diperlukan

Periode maksimum dalam detik antara komunikasi dengan broker. Jika tidak ada pesan lain yang ditukar, ini mengontrol tingkat di mana klien akan mengirim pesan ping ke broker. Jika tidak disediakan nilai default 60 detik akan digunakan.

auto_connect
bool
Diperlukan

Sambungkan klien secara otomatis ke IoTHub ketika metode dipanggil yang memerlukan koneksi untuk dibuat. (Default: True)

connection_retry
bool
Diperlukan

Mencoba membuat ulang koneksi yang terputus (Default: True)

connection_retry_interval
int
Diperlukan

Interval, dalam detik, antara upaya untuk membuat kembali koneksi yang terputus (Default: 10)

ensure_desired_properties
bool
Diperlukan

Pastikan patch properti terbaru yang diinginkan telah diterima setelah koneksi ulang (Default:True)

Pengecualian

TypeError if given an unsupported parameter.
ValueError if the sastoken parameter is invalid.

create_from_x509_certificate

Membuat instans klien menggunakan autentikasi sertifikat X509.

create_from_x509_certificate(x509, hostname, device_id, module_id, **kwargs)

Parameter

hostname
str
Diperlukan

Host yang menjalankan IotHub. Dapat ditemukan di portal Azure di tab Gambaran Umum sebagai nama host string.

x509
X509
Diperlukan

Objek sertifikat x509 lengkap. Untuk menggunakan sertifikat, objek pendaftaran harus berisi sertifikasi (baik sertifikat akar atau salah satu sertifikat OS perantara). Jika sertifikasi berasal dari file CER, sertifikat perlu dikodekan base64.

device_id
str
Diperlukan

ID yang digunakan untuk mengidentifikasi perangkat secara unik di IoTHub

module_id
str
Diperlukan

ID yang digunakan untuk mengidentifikasi modul secara unik pada perangkat di IoTHub.

server_verification_cert
str
Diperlukan

Opsi Konfigurasi. Rantai sertifikat tepercaya. Diperlukan saat menggunakan menyambungkan ke titik akhir yang memiliki akar kepercayaan non-standar, seperti gateway protokol.

gateway_hostname
str
Diperlukan

Opsi Konfigurasi. Nama host gateway untuk perangkat gateway.

websockets
bool
Diperlukan

Opsi Konfigurasi. Defaultnya adalah False. Atur ke true jika menggunakan MQTT melalui websocket.

cipher
str atau list(str)
Diperlukan

Opsi Konfigurasi. Cipher suite untuk TLS/SSL, sebagai string dalam "format daftar sandi OpenSSL" atau sebagai daftar string cipher suite.

product_info
str
Diperlukan

Opsi Konfigurasi. Defaultnya adalah string kosong. String berisi info produk arbitrer yang ditambahkan ke string agen pengguna.

proxy_options
ProxyOptions
Diperlukan

Opsi untuk mengirim lalu lintas melalui server proksi.

keep_alive
int
Diperlukan

Periode maksimum dalam detik antara komunikasi dengan broker. Jika tidak ada pesan lain yang ditukar, ini mengontrol tingkat di mana klien akan mengirim pesan ping ke broker. Jika tidak disediakan nilai default 60 detik akan digunakan.

auto_connect
bool
Diperlukan

Sambungkan klien secara otomatis ke IoTHub ketika metode dipanggil yang memerlukan koneksi untuk dibuat. (Default: True)

connection_retry
bool
Diperlukan

Mencoba membuat ulang koneksi yang terputus (Default: True)

connection_retry_interval
int
Diperlukan

Interval, dalam detik, antara upaya untuk membuat kembali koneksi yang terputus (Default: 10)

ensure_desired_properties
bool
Diperlukan

Pastikan patch properti terbaru yang diinginkan telah diterima setelah koneksi ulang (Default:True)

Mengembalikan

Instans klien IoTHub yang menggunakan sertifikat X509 untuk autentikasi.

Pengecualian

TypeError if given an unsupported parameter.

disconnect

Putuskan sambungan klien dari instans Azure IoT Hub atau Azure IoT Edge Hub.

Disarankan agar Anda memastikan untuk memanggil fungsi ini ketika Anda benar-benar selesai dengan instans klien Anda.

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai koneksi ke layanan telah ditutup sepenuhnya.

disconnect()

Pengecualian

jika ada kegagalan yang tidak terduga selama eksekusi.

get_twin

Mendapatkan perangkat atau modul kembar dari layanan Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai kembar diambil dari layanan.

get_twin()

Mengembalikan

Complete Twin sebagai dict JSON

Tipe hasil

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu upaya koneksi habis

jika klien tidak tersambung (dan tidak ada koneksi otomatis yang diaktifkan)

jika ada kegagalan yang tidak terduga selama eksekusi.

invoke_method

Panggil metode dari klien Anda ke perangkat atau klien modul, dan terima respons terhadap panggilan metode.

invoke_method(method_params, device_id, module_id=None)

Parameter

method_params
dict
Diperlukan

Harus berisi methodName (str), payload (str), connectTimeoutInSeconds (int), responseTimeoutInSeconds (int).

device_id
str
Diperlukan

ID perangkat dari perangkat target tempat metode akan dipanggil.

module_id
str
nilai default: None

ID modul modul target tempat metode akan dipanggil. (Opsional)

Mengembalikan

method_result harus berisi status, dan payload

Tipe hasil

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu koneksi habis.

jika ada kegagalan yang tidak terduga selama eksekusi.

patch_twin_reported_properties

Perbarui properti yang dilaporkan dengan layanan Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai patch dikirim ke layanan dan diakui.

Jika layanan mengembalikan kesalahan pada operasi patch, fungsi ini akan memunculkan kesalahan yang sesuai.

patch_twin_reported_properties(reported_properties_patch)

Parameter

reported_properties_patch
dict
Diperlukan

Patch Properti yang Dilaporkan Kembar sebagai dict JSON

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu upaya koneksi habis

jika klien tidak tersambung (dan tidak ada koneksi otomatis yang diaktifkan)

jika ada kegagalan yang tidak terduga selama eksekusi.

receive_message_on_input

Terima pesan input yang telah dikirim dari Modul lain ke input tertentu.

Tidak digunakan lagi sejak versi 2.3.0: Kami sarankan Anda menggunakan properti .on_message_received untuk mengatur handler sebagai gantinya

receive_message_on_input(input_name, block=True, timeout=None)

Parameter

input_name
str
Diperlukan

Nama input untuk menerima pesan.

block
bool
Diperlukan

Menunjukkan apakah operasi harus memblokir hingga pesan diterima.

timeout
int
Diperlukan

Secara opsional, berikan beberapa detik hingga waktu pemblokiran habis.

Mengembalikan

Pesan yang dikirim ke input yang ditentukan, atau Tidak Ada jika tidak ada permintaan metode yang diterima pada akhir periode pemblokiran.

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu koneksi habis.

jika ada kegagalan yang tidak terduga selama eksekusi.

receive_method_request

Terima permintaan metode melalui Azure IoT Hub atau Azure IoT Edge Hub.

Tidak digunakan lagi sejak versi 2.3.0: Kami sarankan Anda menggunakan properti .on_method_request_received untuk mengatur handler sebagai gantinya

receive_method_request(method_name=None, block=True, timeout=None)

Parameter

method_name
str
nilai default: None

Secara opsional berikan nama metode untuk menerima permintaan. Jika parameter ini tidak diberikan, semua metode belum ditargetkan secara khusus oleh permintaan yang berbeda untuk receive_method akan diterima.

block
bool
nilai default: True

Menunjukkan apakah operasi harus memblokir hingga permintaan diterima.

timeout
int
nilai default: None

Secara opsional, berikan beberapa detik hingga waktu pemblokiran habis.

Mengembalikan

Objek MethodRequest yang mewakili permintaan metode yang diterima, atau Tidak Ada jika tidak ada permintaan metode yang diterima pada akhir periode pemblokiran.

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu koneksi habis.

jika ada kegagalan yang tidak terduga selama eksekusi.

receive_twin_desired_properties_patch

Terima patch properti yang diinginkan melalui Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah panggilan sinkron, yang berarti sebagai berikut:

  1. Jika block=True, fungsi ini akan memblokir hingga salah satu hal berikut ini terjadi:

    • patch properti yang diinginkan diterima dari Azure IoT Hub atau Azure IoT Edge Hub.

    • periode batas waktu, jika disediakan, berlalu. Jika waktu habis terjadi, fungsi ini akan meningkatkan pengecualian InboxEmpty

  2. Jika block=False, fungsi ini akan mengembalikan patch properti yang diinginkan yang mungkin telah diterima oleh alur, tetapi belum dikembalikan ke aplikasi. Jika tidak ada patch properti yang diinginkan yang diterima oleh alur, fungsi ini akan meningkatkan pengecualian InboxEmpty

Tidak digunakan lagi sejak versi 2.3.0: Kami sarankan Anda menggunakan properti .on_twin_desired_properties_patch_received untuk mengatur handler sebagai gantinya

receive_twin_desired_properties_patch(block=True, timeout=None)

Parameter

block
bool
nilai default: True

Menunjukkan apakah operasi harus memblokir hingga permintaan diterima.

timeout
int
nilai default: None

Secara opsional, berikan beberapa detik hingga waktu pemblokiran habis.

Mengembalikan

Patch Properti yang Diinginkan Kembar sebagai dict JSON, atau Tidak Ada jika tidak ada patch yang diterima pada akhir periode pemblokiran

Tipe hasil

dict,

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu koneksi habis.

jika ada kegagalan yang tidak terduga selama eksekusi.

send_message

Mengirim pesan ke titik akhir peristiwa default pada instans Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah peristiwa sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai peristiwa dikirim ke layanan dan layanan telah mengakui penerimaan peristiwa.

Jika koneksi ke layanan sebelumnya belum dibuka oleh panggilan untuk menyambungkan, fungsi ini akan membuka koneksi sebelum mengirim peristiwa.

send_message(message)

Parameter

message
Message
Diperlukan

Pesan aktual yang akan dikirim. Apa pun yang diteruskan yang bukan merupakan instans kelas Pesan akan dikonversi ke objek Pesan.

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu upaya koneksi habis

jika klien tidak tersambung (dan tidak ada koneksi otomatis yang diaktifkan)

jika ada kegagalan yang tidak terduga selama eksekusi.

ValueError if the message fails size validation.

send_message_to_output

Mengirim peristiwa/pesan ke output modul yang diberikan.

Ini adalah peristiwa keluar dan dimaksudkan untuk menjadi "peristiwa output".

Ini adalah peristiwa sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai peristiwa dikirim ke layanan dan layanan telah mengakui penerimaan peristiwa.

Jika koneksi ke layanan sebelumnya belum dibuka oleh panggilan untuk menyambungkan, fungsi ini akan membuka koneksi sebelum mengirim peristiwa.

send_message_to_output(message, output_name)

Parameter

message
Message
Diperlukan

Pesan untuk dikirim ke output yang diberikan. Apa pun yang diteruskan yang bukan merupakan instans kelas Pesan akan dikonversi ke objek Pesan.

output_name
str
Diperlukan

Nama output yang akan dikirimi peristiwa.

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu upaya koneksi habis

jika klien tidak tersambung (dan tidak ada koneksi otomatis yang diaktifkan)

jika ada kegagalan yang tidak terduga selama eksekusi.

ValueError if the message fails size validation.

send_method_response

Kirim respons ke permintaan metode melalui Azure IoT Hub atau Azure IoT Edge Hub.

Ini adalah peristiwa sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai peristiwa dikirim ke layanan dan layanan telah mengakui penerimaan peristiwa.

Jika koneksi ke layanan sebelumnya belum dibuka oleh panggilan untuk menyambungkan, fungsi ini akan membuka koneksi sebelum mengirim peristiwa.

send_method_response(method_response)

Parameter

method_response
MethodResponse
Diperlukan

MethodResponse yang akan dikirim.

Pengecualian

jika kredensial tidak valid dan koneksi tidak dapat dibuat.

jika membuat koneksi mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu upaya koneksi habis

jika klien tidak tersambung (dan tidak ada koneksi otomatis yang diaktifkan)

jika ada kegagalan yang tidak terduga selama eksekusi.

shutdown

Matikan klien untuk keluar dengan baik.

Setelah metode ini dipanggil, setiap upaya pada panggilan klien lebih lanjut akan mengakibatkan ClientError dinaikkan

shutdown()

Pengecualian

jika ada kegagalan yang tidak terduga selama eksekusi.

update_sastoken

Perbarui Token SAS klien yang digunakan untuk autentikasi, lalu autentikasi ulang koneksi.

API ini hanya dapat digunakan jika klien awalnya dibuat dengan Token SAS.

update_sastoken(sastoken)

Parameter

sastoken
str
Diperlukan

String Token SAS baru untuk digunakan klien

Pengecualian

ValueError if the sastoken parameter is invalid

jika kredensial tidak valid dan koneksi tidak dapat dibuat ulang.

jika membuat ulang koneksi akan mengalihkan kegagalan.

jika koneksi hilang selama eksekusi.

jika waktu upaya otorisasi ulang habis.

jika klien awalnya tidak dibuat dengan token SAS.

jika ada kegagalan yang tidak terduga selama eksekusi.

Atribut

connected

Properti baca-saja untuk menunjukkan apakah transportasi tersambung atau tidak.

on_background_exception

Fungsi handler atau coroutine akan dipanggil ketika pengecualian latar belakang terjadi.

Fungsi atau definisi coroutine harus mengambil satu argumen posisi (objek pengecualian)

on_connection_state_change

Fungsi handler atau coroutine yang akan dipanggil ketika status koneksi berubah.

Fungsi atau definisi coroutine tidak boleh mengambil argumen posisi.

on_message_received

Fungsi handler atau coroutine yang akan dipanggil ketika pesan input diterima.

Definisi fungsi atau coroutine harus mengambil satu argumen posisi ( Message objek )

on_method_request_received

Fungsi handler atau coroutine yang akan dipanggil ketika permintaan metode diterima.

Ingatlah untuk mengakui permintaan metode dalam fungsi atau coroutine Anda melalui penggunaan metode .send_method_response() klien.

Fungsi atau definisi coroutine harus mengambil satu argumen posisi ( MethodRequest objek )

on_new_sastoken_required

Fungsi handler atau coroutine yang akan dipanggil ketika klien memerlukan token SAS baru. Ini akan terjadi sekitar 2 menit sebelum Token SAS kedaluwarsa. Pada platform Windows, jika masa pakai melebihi sekitar 49 hari, token baru akan diperlukan setelah 49 hari tersebut terlepas dari berapa lama masa pakai SAS.

Perhatikan bahwa handler ini HANYA diperlukan saat menggunakan klien yang dibuat melalui metode .create_from_sastoken().

Token baru dapat disediakan dalam fungsi atau coroutine Anda melalui penggunaan metode .update_sastoken() klien.

Fungsi atau definisi coroutine tidak boleh mengambil argumen posisi.

on_twin_desired_properties_patch_received

Fungsi handler atau coroutine yang akan dipanggil ketika patch properti yang diinginkan kembar diterima.

Fungsi atau definisi coroutine harus mengambil satu argumen posisi (patch kembar dalam bentuk objek kamus JSON)