IoTHubModuleClient الفصل
عميل وحدة نمطية متزامن يتصل بمثيل Azure IoT Hub أو Azure IoT Edge.
تهيئة IoTHubModuleClient.
يجب عدم استدعاء هذا المهيئ مباشرة. بدلا من ذلك، استخدم أحد>> "create_from_<<" classmethods لإنشاء مثيل
- توريث
-
azure.iot.device.iothub.sync_clients.GenericIoTHubClientIoTHubModuleClientazure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClientIoTHubModuleClient
الدالمنشئ
IoTHubModuleClient(mqtt_pipeline, http_pipeline)المعلمات
- mqtt_pipeline
- <xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
البنية الأساسية لبرنامج ربط العمليات التجارية المستخدمة للاتصال بنقطة نهاية IoTHub.
- http_pipeline
- <xref:azure.iot.device.iothub.pipeline.HTTPPipeline>
البنية الأساسية لبرنامج ربط العمليات التجارية المستخدمة للاتصال بنقطة نهاية IoTHub عبر HTTP.
الأساليب
| connect |
يربط العميل بمثيل Azure IoT Hub أو Azure IoT Edge Hub. يتم اختيار الوجهة استنادا إلى بيانات الاعتماد التي تم تمريرها عبر المعلمة auth_provider التي تم توفيرها عند تهيئة هذا الكائن. هذا استدعاء متزامن، ما يعني أن هذه الدالة لن تعود حتى يتم إنشاء الاتصال بالخدمة بالكامل. |
| create_from_connection_string |
إنشاء مثيل للعميل من جهاز IoTHub أو سلسلة اتصال الوحدة النمطية. |
| create_from_edge_environment |
إنشاء مثيل للعميل من بيئة IoT Edge. يمكن تشغيل هذا الأسلوب فقط من داخل حاوية IoT Edge، أو في بيئة تصحيح الأخطاء التي تم تكوينها لتطوير Edge (على سبيل المثال، Visual Studio، Visual Studio Code) |
| create_from_sastoken |
إنشاء مثيل للعميل من سلسلة رمز SAS المميز التي تم إنشاؤها مسبقا |
| create_from_x509_certificate |
إنشاء مثيل لعميل باستخدام مصادقة شهادة X509. |
| disconnect |
افصل العميل عن Azure IoT Hub أو مثيل Azure IoT Edge Hub. يوصى بالتأكد من استدعاء هذه الدالة عند الانتهاء تماما من مثيل العميل الخاص بك. هذا استدعاء متزامن، ما يعني أن هذه الدالة لن تعود حتى يتم إغلاق الاتصال بالخدمة بالكامل. |
| get_twin |
يحصل على الجهاز أو الوحدة النمطية المزدوجة من Azure IoT Hub أو خدمة Azure IoT Edge Hub. هذا استدعاء متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم استرداد التوأم من الخدمة. |
| invoke_method |
استدعاء أسلوب من العميل الخاص بك إلى عميل جهاز أو وحدة نمطية، وتلقي الاستجابة لاستدعاء الأسلوب. |
| patch_twin_reported_properties |
تحديث الخصائص المبلغ عنها باستخدام Azure IoT Hub أو خدمة Azure IoT Edge Hub. هذا استدعاء متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم إرسال التصحيح إلى الخدمة والإقرار به. إذا كانت الخدمة ترجع خطأ في عملية التصحيح، فستثير هذه الدالة الخطأ المناسب. |
| receive_message_on_input |
تلقي رسالة إدخال تم إرسالها من وحدة نمطية أخرى إلى إدخال معين. مهمل منذ الإصدار 2.3.0: نوصي باستخدام الخاصية .on_message_received لتعيين معالج بدلا من ذلك |
| receive_method_request |
تلقي طلب أسلوب عبر Azure IoT Hub أو Azure IoT Edge Hub. مهمل منذ الإصدار 2.3.0: نوصي باستخدام الخاصية .on_method_request_received لتعيين معالج بدلا من ذلك |
| receive_twin_desired_properties_patch |
تلقي تصحيح الخاصية المطلوب عبر Azure IoT Hub أو Azure IoT Edge Hub. هذا استدعاء متزامن، ما يعني ما يلي:
مهمل منذ الإصدار 2.3.0: نوصي باستخدام خاصية .on_twin_desired_properties_patch_received لتعيين معالج بدلا من ذلك |
| send_message |
يرسل رسالة إلى نقطة نهاية الأحداث الافتراضية على Azure IoT Hub أو مثيل Azure IoT Edge Hub. هذا حدث متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم إرسال الحدث إلى الخدمة واعترفت الخدمة باستلام الحدث. إذا لم يتم فتح الاتصال بالخدمة مسبقا بواسطة استدعاء للاتصال، فستفتح هذه الدالة الاتصال قبل إرسال الحدث. |
| send_message_to_output |
إرسال حدث/رسالة إلى إخراج الوحدة النمطية المحددة. هذه هي الأحداث الصادرة والمقصود بها أن تكون "أحداث الإخراج". هذا حدث متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم إرسال الحدث إلى الخدمة واعترفت الخدمة باستلام الحدث. إذا لم يتم فتح الاتصال بالخدمة مسبقا بواسطة استدعاء للاتصال، فستفتح هذه الدالة الاتصال قبل إرسال الحدث. |
| send_method_response |
إرسال استجابة لطلب أسلوب عبر Azure IoT Hub أو Azure IoT Edge Hub. هذا حدث متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم إرسال الحدث إلى الخدمة واعترفت الخدمة باستلام الحدث. إذا لم يتم فتح الاتصال بالخدمة مسبقا بواسطة استدعاء للاتصال، فستفتح هذه الدالة الاتصال قبل إرسال الحدث. |
| shutdown |
قم بإيقاف تشغيل العميل للخروج بأمان. بمجرد استدعاء هذا الأسلوب، ستؤدي أي محاولات في مكالمات العميل الإضافية إلى رفع ClientError |
| update_sastoken |
تحديث رمز SAS المميز للعميل المستخدم للمصادقة، ثم إعادة مصادقة الاتصال. يمكن استخدام واجهة برمجة التطبيقات هذه فقط إذا تم إنشاء العميل في البداية باستخدام رمز SAS المميز. |
connect
يربط العميل بمثيل Azure IoT Hub أو Azure IoT Edge Hub.
يتم اختيار الوجهة استنادا إلى بيانات الاعتماد التي تم تمريرها عبر المعلمة auth_provider التي تم توفيرها عند تهيئة هذا الكائن.
هذا استدعاء متزامن، ما يعني أن هذه الدالة لن تعود حتى يتم إنشاء الاتصال بالخدمة بالكامل.
connect()استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة الاتصال.
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
create_from_connection_string
إنشاء مثيل للعميل من جهاز IoTHub أو سلسلة اتصال الوحدة النمطية.
create_from_connection_string(connection_string, **kwargs)المعلمات
- server_verification_cert
- str
خيار التكوين. سلسلة الشهادات الموثوق بها. ضروري عند استخدام الاتصال بنقطة نهاية لها جذر ثقة غير قياسي، مثل بوابة البروتوكول.
- websockets
- bool
خيار التكوين. الافتراضي هو خطأ. اضبط على true إذا كنت تستخدم MQTT عبر websockets.
خيار التكوين. مجموعة (مجموعات) التشفير ل TLS/SSL، كسلسلة في "تنسيق قائمة تشفير OpenSSL" أو كقائمة بسلاسل مجموعة التشفير.
- product_info
- str
خيار التكوين. الافتراضي هو سلسلة فارغة. تحتوي السلسلة على معلومات منتج عشوائية يتم إلحاقها بسلسلة عامل المستخدم.
- sastoken_ttl
- int
وقت البقاء (بالثوان) ل SasToken الذي تم إنشاؤه والمستخدم للمصادقة. الافتراضي هو 3600 ثانية (ساعة واحدة).
- keep_alive
- int
الحد الأقصى للفترة بالثوان بين الاتصالات مع الوسيط. إذا لم يتم تبادل أي رسائل أخرى، فإن هذا يتحكم في المعدل الذي سيرسل به العميل رسائل اختبار اتصال إلى الوسيط. إذا لم يتم توفير القيمة الافتراضية من 60 ثانية سيتم استخدامها.
- auto_connect
- bool
قم بتوصيل العميل تلقائيا ب IoTHub عند استدعاء أسلوب يتطلب إنشاء اتصال. (الافتراضي: صحيح)
- connection_retry_interval
- int
الفاصل الزمني، بالثوان، بين محاولات إعادة إنشاء اتصال تم إسقاطه (افتراضي: 10)
- ensure_desired_properties
- bool
تأكد من تلقي أحدث تصحيح للخصائص المطلوبة عند إعادة الاتصال (افتراضي:صحيح)
المرتجعات
مثيل لعميل IoTHub يستخدم سلسلة اتصال للمصادقة.
استثناءات
create_from_edge_environment
إنشاء مثيل للعميل من بيئة IoT Edge.
يمكن تشغيل هذا الأسلوب فقط من داخل حاوية IoT Edge، أو في بيئة تصحيح الأخطاء التي تم تكوينها لتطوير Edge (على سبيل المثال، Visual Studio، Visual Studio Code)
create_from_edge_environment(**kwargs)المعلمات
- websockets
- bool
خيار التكوين. الافتراضي هو خطأ. اضبط على true إذا كنت تستخدم MQTT عبر websockets.
خيار التكوين. مجموعة (مجموعات) التشفير ل TLS/SSL، كسلسلة في "تنسيق قائمة تشفير OpenSSL" أو كقائمة بسلاسل مجموعة التشفير.
- product_info
- str
خيار التكوين. الافتراضي هو سلسلة فارغة. تحتوي السلسلة على معلومات منتج عشوائية يتم إلحاقها بسلسلة عامل المستخدم.
- sastoken_ttl
- int
وقت البقاء (بالثوان) ل SasToken الذي تم إنشاؤه والمستخدم للمصادقة. الافتراضي هو 3600 ثانية (ساعة واحدة)
- keep_alive
- int
الحد الأقصى للفترة بالثوان بين الاتصالات مع الوسيط. إذا لم يتم تبادل أي رسائل أخرى، فإن هذا يتحكم في المعدل الذي سيرسل به العميل رسائل اختبار اتصال إلى الوسيط. إذا لم يتم توفير القيمة الافتراضية من 60 ثانية سيتم استخدامها.
- auto_connect
- bool
قم بتوصيل العميل تلقائيا ب IoTHub عند استدعاء أسلوب يتطلب إنشاء اتصال. (الافتراضي: صحيح)
- connection_retry_interval
- int
الفاصل الزمني، بالثوان، بين محاولات إعادة إنشاء اتصال تم إسقاطه (افتراضي: 10)
المرتجعات
مثيل لعميل IoTHub يستخدم بيئة IoT Edge للمصادقة.
استثناءات
create_from_sastoken
إنشاء مثيل للعميل من سلسلة رمز SAS المميز التي تم إنشاؤها مسبقا
create_from_sastoken(sastoken, **kwargs)المعلمات
- server_verification_cert
- str
خيار التكوين. سلسلة الشهادات الموثوق بها. ضروري عند استخدام الاتصال بنقطة نهاية لها جذر ثقة غير قياسي، مثل بوابة البروتوكول.
- websockets
- bool
خيار التكوين. الافتراضي هو خطأ. اضبط على true إذا كنت تستخدم MQTT عبر websockets.
خيار التكوين. مجموعة (مجموعات) التشفير ل TLS/SSL، كسلسلة في "تنسيق قائمة تشفير OpenSSL" أو كقائمة بسلاسل مجموعة التشفير.
- product_info
- str
خيار التكوين. الافتراضي هو سلسلة فارغة. تحتوي السلسلة على معلومات منتج عشوائية يتم إلحاقها بسلسلة عامل المستخدم.
- keep_alive
- int
الحد الأقصى للفترة بالثوان بين الاتصالات مع الوسيط. إذا لم يتم تبادل أي رسائل أخرى، فإن هذا يتحكم في المعدل الذي سيرسل به العميل رسائل اختبار الاتصال إلى الوسيط. إذا لم يتم توفير القيمة الافتراضية 60 ثانية سيتم استخدامها.
- auto_connect
- bool
قم بتوصيل العميل تلقائيا ب IoTHub عند استدعاء أسلوب يتطلب إنشاء اتصال. (افتراضي: صحيح)
- connection_retry_interval
- int
الفاصل الزمني، بالثوان، بين محاولات إعادة إنشاء اتصال تم إسقاطه (افتراضي: 10)
- ensure_desired_properties
- bool
تأكد من تلقي أحدث تصحيح للخصائص المطلوبة عند إعادة الاتصال (افتراضي:صحيح)
استثناءات
create_from_x509_certificate
إنشاء مثيل لعميل باستخدام مصادقة شهادة X509.
create_from_x509_certificate(x509, hostname, device_id, module_id, **kwargs)المعلمات
- hostname
- str
المضيف الذي يقوم بتشغيل IotHub. يمكن العثور عليها في مدخل Microsoft Azure في علامة التبويب نظرة عامة باسم مضيف السلسلة.
- x509
- X509
كائن شهادة x509 الكامل. لاستخدام الشهادة، يحتاج عنصر التسجيل إلى احتواء الشهادة (إما الشهادة الجذر أو إحدى شهادات CA الوسيطة). إذا كانت الشهادة تأتي من ملف CER، فيجب ترميز base64.
- server_verification_cert
- str
خيار التكوين. سلسلة الشهادات الموثوق بها. ضروري عند استخدام الاتصال بنقطة نهاية لها جذر ثقة غير قياسي، مثل بوابة البروتوكول.
- websockets
- bool
خيار التكوين. الافتراضي هو خطأ. اضبط على true إذا كنت تستخدم MQTT عبر websockets.
خيار التكوين. مجموعة (مجموعات) التشفير ل TLS/SSL، كسلسلة في "تنسيق قائمة تشفير OpenSSL" أو كقائمة بسلاسل مجموعة التشفير.
- product_info
- str
خيار التكوين. الافتراضي هو سلسلة فارغة. تحتوي السلسلة على معلومات منتج عشوائية يتم إلحاقها بسلسلة عامل المستخدم.
- keep_alive
- int
الحد الأقصى للفترة بالثوان بين الاتصالات مع الوسيط. إذا لم يتم تبادل أي رسائل أخرى، فإن هذا يتحكم في المعدل الذي سيرسل به العميل رسائل اختبار الاتصال إلى الوسيط. إذا لم يتم توفير القيمة الافتراضية 60 ثانية سيتم استخدامها.
- auto_connect
- bool
قم بتوصيل العميل تلقائيا ب IoTHub عند استدعاء أسلوب يتطلب إنشاء اتصال. (افتراضي: صحيح)
- connection_retry_interval
- int
الفاصل الزمني، بالثوان، بين محاولات إعادة إنشاء اتصال تم إسقاطه (افتراضي: 10)
- ensure_desired_properties
- bool
تأكد من تلقي أحدث تصحيح للخصائص المطلوبة عند إعادة الاتصال (افتراضي:صحيح)
المرتجعات
مثيل لعميل IoTHub يستخدم شهادة X509 للمصادقة.
استثناءات
disconnect
افصل العميل عن Azure IoT Hub أو مثيل Azure IoT Edge Hub.
يوصى بالتأكد من استدعاء هذه الدالة عند الانتهاء تماما من مثيل العميل الخاص بك.
هذا استدعاء متزامن، ما يعني أن هذه الدالة لن تعود حتى يتم إغلاق الاتصال بالخدمة بالكامل.
disconnect()استثناءات
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
get_twin
يحصل على الجهاز أو الوحدة النمطية المزدوجة من Azure IoT Hub أو خدمة Azure IoT Edge Hub.
هذا استدعاء متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم استرداد التوأم من الخدمة.
get_twin()المرتجعات
إكمال التوأم كمطرح JSON
نوع الإرجاع
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة محاولة الاتصال
إذا لم يكن العميل متصلا (ولم يتم تمكين الاتصال التلقائي)
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
invoke_method
استدعاء أسلوب من العميل الخاص بك إلى عميل جهاز أو وحدة نمطية، وتلقي الاستجابة لاستدعاء الأسلوب.
invoke_method(method_params, device_id, module_id=None)المعلمات
- method_params
- dict
يجب أن يحتوي على methodName (str)، الحمولة (str)، connectTimeoutInSeconds (int)، responseTimeoutInSeconds (int).
- module_id
- str
معرف الوحدة النمطية للوحدة النمطية الهدف حيث سيتم استدعاء الأسلوب. (اختياري)
المرتجعات
يجب أن تحتوي method_result على حالة، وحمولة
نوع الإرجاع
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة الاتصال.
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
patch_twin_reported_properties
تحديث الخصائص المبلغ عنها باستخدام Azure IoT Hub أو خدمة Azure IoT Edge Hub.
هذا استدعاء متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم إرسال التصحيح إلى الخدمة والإقرار به.
إذا كانت الخدمة ترجع خطأ في عملية التصحيح، فستثير هذه الدالة الخطأ المناسب.
patch_twin_reported_properties(reported_properties_patch)المعلمات
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة محاولة الاتصال
إذا لم يكن العميل متصلا (ولم يتم تمكين الاتصال التلقائي)
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
receive_message_on_input
تلقي رسالة إدخال تم إرسالها من وحدة نمطية أخرى إلى إدخال معين.
مهمل منذ الإصدار 2.3.0: نوصي باستخدام الخاصية .on_message_received لتعيين معالج بدلا من ذلك
receive_message_on_input(input_name, block=True, timeout=None)المعلمات
المرتجعات
الرسالة التي تم إرسالها إلى الإدخال المحدد، أو بلا إذا لم يتم تلقي طلب أسلوب بحلول نهاية فترة الحظر.
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة الاتصال.
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
receive_method_request
تلقي طلب أسلوب عبر Azure IoT Hub أو Azure IoT Edge Hub.
مهمل منذ الإصدار 2.3.0: نوصي باستخدام الخاصية .on_method_request_received لتعيين معالج بدلا من ذلك
receive_method_request(method_name=None, block=True, timeout=None)المعلمات
- method_name
- str
قم بتوفير اسم الأسلوب لتلقي الطلبات الخاصة به اختياريا. إذا لم يتم إعطاء هذه المعلمة، فسيتم تلقي جميع الأساليب التي لم يتم استهدافها بالفعل بشكل خاص بواسطة طلب مختلف receive_method.
المرتجعات
عنصر MethodRequest الذي يمثل طلب الأسلوب المستلم، أو بلا إذا لم يتم تلقي طلب أسلوب بحلول نهاية فترة الحظر.
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة الاتصال.
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
receive_twin_desired_properties_patch
تلقي تصحيح الخاصية المطلوب عبر Azure IoT Hub أو Azure IoT Edge Hub.
هذا استدعاء متزامن، ما يعني ما يلي:
إذا كانت block=True، فستحظر هذه الدالة حتى يحدث أحد الإجراءات التالية:
يتم تلقي تصحيح الخاصية المطلوب من Azure IoT Hub أو Azure IoT Edge Hub.
تنقضي فترة المهلة، إذا تم توفيرها. إذا حدثت مهلة، فسترفع هذه الدالة استثناء InboxEmpty
إذا كانت block=False، فسترجع هذه الدالة أي تصحيحات خصائص مطلوبة قد تكون تم تلقيها بواسطة المسار، ولكن لم يتم إرجاعها بعد إلى التطبيق. إذا لم يتم تلقي تصحيحات الخصائص المطلوبة بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية، فستثير هذه الدالة استثناء InboxEmpty
مهمل منذ الإصدار 2.3.0: نوصي باستخدام خاصية .on_twin_desired_properties_patch_received لتعيين معالج بدلا من ذلك
receive_twin_desired_properties_patch(block=True, timeout=None)المعلمات
المرتجعات
تصحيح الخصائص المرغوبة المزدوجة كإملاء JSON، أو بلا إذا لم يتم تلقي أي تصحيح بنهاية فترة الحظر
نوع الإرجاع
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة الاتصال.
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
send_message
يرسل رسالة إلى نقطة نهاية الأحداث الافتراضية على Azure IoT Hub أو مثيل Azure IoT Edge Hub.
هذا حدث متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم إرسال الحدث إلى الخدمة واعترفت الخدمة باستلام الحدث.
إذا لم يتم فتح الاتصال بالخدمة مسبقا بواسطة استدعاء للاتصال، فستفتح هذه الدالة الاتصال قبل إرسال الحدث.
send_message(message)المعلمات
- message
- Message
الرسالة الفعلية لإرسالها. سيتم تحويل أي شيء تم تمريره ليس مثيلا لفئة Message إلى كائن Message.
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة محاولة الاتصال
إذا لم يكن العميل متصلا (ولم يتم تمكين الاتصال التلقائي)
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
send_message_to_output
إرسال حدث/رسالة إلى إخراج الوحدة النمطية المحددة.
هذه هي الأحداث الصادرة والمقصود بها أن تكون "أحداث الإخراج".
هذا حدث متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم إرسال الحدث إلى الخدمة واعترفت الخدمة باستلام الحدث.
إذا لم يتم فتح الاتصال بالخدمة مسبقا بواسطة استدعاء للاتصال، فستفتح هذه الدالة الاتصال قبل إرسال الحدث.
send_message_to_output(message, output_name)المعلمات
- message
- Message
رسالة لإرسالها إلى الإخراج المحدد. سيتم تحويل أي شيء تم تمريره ليس مثيلا لفئة Message إلى كائن Message.
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة محاولة الاتصال
إذا لم يكن العميل متصلا (ولم يتم تمكين الاتصال التلقائي)
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
send_method_response
إرسال استجابة لطلب أسلوب عبر Azure IoT Hub أو Azure IoT Edge Hub.
هذا حدث متزامن، ما يعني أن هذه الدالة لن ترجع حتى يتم إرسال الحدث إلى الخدمة واعترفت الخدمة باستلام الحدث.
إذا لم يتم فتح الاتصال بالخدمة مسبقا بواسطة استدعاء للاتصال، فستفتح هذه الدالة الاتصال قبل إرسال الحدث.
send_method_response(method_response)المعلمات
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إنشاء اتصال.
إذا كان إنشاء اتصال يؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة محاولة الاتصال
إذا لم يكن العميل متصلا (ولم يتم تمكين الاتصال التلقائي)
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
shutdown
قم بإيقاف تشغيل العميل للخروج بأمان.
بمجرد استدعاء هذا الأسلوب، ستؤدي أي محاولات في مكالمات العميل الإضافية إلى رفع ClientError
shutdown()استثناءات
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
update_sastoken
تحديث رمز SAS المميز للعميل المستخدم للمصادقة، ثم إعادة مصادقة الاتصال.
يمكن استخدام واجهة برمجة التطبيقات هذه فقط إذا تم إنشاء العميل في البداية باستخدام رمز SAS المميز.
update_sastoken(sastoken)المعلمات
استثناءات
إذا كانت بيانات الاعتماد غير صالحة ولا يمكن إعادة إنشاء اتصال.
إذا كانت إعادة تأسيس الاتصال تؤدي إلى فشل.
إذا فقد الاتصال أثناء التنفيذ.
إذا انتهت مهلة محاولة إعادة المصادقة.
إذا لم يتم إنشاء العميل في البداية باستخدام رمز SAS المميز.
إذا كان هناك فشل غير متوقع أثناء التنفيذ.
السمات
connected
خاصية للقراءة فقط للإشارة إلى ما إذا كان النقل متصلا أم لا.
on_background_exception
سيتم استدعاء دالة المعالج أو coroutine عند حدوث استثناء في الخلفية.
يجب أن تأخذ الدالة أو تعريف coroutine وسيطة موضعية واحدة (كائن الاستثناء)
on_connection_state_change
دالة المعالج أو coroutine التي سيتم استدعاؤها عند تغيير حالة الاتصال.
يجب ألا تأخذ الدالة أو تعريف coroutine أي وسيطات موضعية.
on_message_received
دالة المعالج أو coroutine التي سيتم استدعاؤها عند تلقي رسالة إدخال.
يجب أن يأخذ تعريف الدالة أو coroutine وسيطة موضعية واحدة ( Message الكائن)
on_method_request_received
دالة المعالج أو coroutine التي سيتم استدعاؤها عند تلقي طلب أسلوب.
تذكر الاعتراف بطلب الأسلوب في الدالة أو coroutine عبر استخدام أسلوب .send_method_response() للعميل.
يجب أن تأخذ الدالة أو تعريف coroutine وسيطة موضعية واحدة ( MethodRequest العنصر)
on_new_sastoken_required
دالة المعالج أو coroutine التي سيتم استدعاؤها عندما يتطلب العميل رمز SAS مميزا جديدا. سيحدث هذا قبل دقيقتين تقريبا من انتهاء صلاحية رمز SAS المميز. على الأنظمة الأساسية ل Windows، إذا تجاوز العمر الافتراضي حوالي 49 يوما، فسيلزم وجود رمز مميز جديد بعد تلك الأيام ال 49 بغض النظر عن مدة عمر SAS.
لاحظ أن هذا المعالج ضروري فقط عند استخدام عميل تم إنشاؤه عبر أسلوب .create_from_sastoken().
يمكن توفير الرمز المميز الجديد في الدالة أو coroutine عبر استخدام أسلوب .update_sastoken() للعميل.
يجب ألا تأخذ الدالة أو تعريف coroutine أي وسيطات موضعية.
on_twin_desired_properties_patch_received
دالة المعالج أو coroutine التي سيتم استدعاؤها عند تلقي تصحيح خصائص التوأم المطلوب.
يجب أن تأخذ الدالة أو تعريف coroutine وسيطة موضعية واحدة (التصحيح المزدوج في شكل كائن قاموس JSON)
Azure SDK for Python
الملاحظات
قريبًا: خلال عام 2024، سنتخلص تدريجيًا من GitHub Issues بوصفها آلية إرسال ملاحظات للمحتوى ونستبدلها بنظام ملاحظات جديد. لمزيد من المعلومات، راجع https://aka.ms/ContentUserFeedback.
إرسال الملاحظات وعرضها المتعلقة بـ