IoTHubJobManager الفصل

فئة لتوفير واجهات برمجة تطبيقات ملائمة لعمليات IoTHub Job Manager، استنادا إلى واجهات برمجة تطبيقات IotHub REST التي تم إنشاؤها تلقائيا

تهيئة عميل خدمة مدير الوظائف.

بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي مستعدة لاستدعاء واجهات برمجة التطبيقات الأعضاء للتواصل مع IoTHub.

توريث
builtins.object
IoTHubJobManager

الدالمنشئ

IoTHubJobManager(connection_string=None, host=None, auth=None)

المعلمات

الاسم الوصف
connection_string
str

سلسلة اتصال IoTHub المستخدمة لمصادقة الاتصال مع IoTHub إذا كنا نستخدم مصادقة connection_str. القيمة الافتراضية: بلا

القيمة الافتراضية: None
host
str

عنوان URL لخدمة Azure إذا كنا نستخدم مصادقة بيانات اعتماد الرمز المميز. القيمة الافتراضية: بلا

القيمة الافتراضية: None
auth
str

كائن مصادقة Azure إذا كنا نستخدم مصادقة بيانات اعتماد الرمز المميز. القيمة الافتراضية: بلا

القيمة الافتراضية: None

الأساليب

cancel_import_export_job

إلغاء مهمة استيراد/تصدير على مركز IoT.

cancel_scheduled_job

إلغاء مهمة مجدولة على مركز IoT.

create_import_export_job

إنشاء مهمة استيراد/تصدير جديدة على مركز IoT.

create_scheduled_job

إنشاء مهمة جديدة لجدولة تحديث التوائم أو الأساليب المباشرة للجهاز على مركز IoT.

from_connection_string

تهيئة Classmethod لعميل خدمة IoTHubJobManager. إنشاء فئة IoTHubJobManager من سلسلة الاتصال.

بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي مستعدة لاستدعاء واجهات برمجة التطبيقات الأعضاء للتواصل مع IoTHub.

from_token_credential

تهيئة Classmethod لعميل خدمة IoTHubJobManager. إنشاء فئة IoTHubJobManager من عنوان url لاسم المضيف وبيانات اعتماد رمز Azure المميز.

بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي مستعدة لاستدعاء واجهات برمجة التطبيقات الأعضاء للتواصل مع IoTHub.

get_import_export_job

استرداد حالة مهمة استيراد/تصدير على IoTHub.

get_import_export_jobs

استرداد حالة جميع مهام الاستيراد/التصدير على IoTHub.

get_scheduled_job

استرداد تفاصيل مهمة مجدولة على IoTHub.

query_scheduled_jobs

الاستعلام عن مركز IoT لاسترداد المعلومات المتعلقة بالوظائف باستخدام لغة استعلام IoT Hub.

cancel_import_export_job

إلغاء مهمة استيراد/تصدير على مركز IoT.

cancel_import_export_job(job_id)

المعلمات

الاسم الوصف
job_id
مطلوب
str

معرف الوظيفة.

المرتجعات

النوع الوصف

الاعتراض.

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

cancel_scheduled_job

إلغاء مهمة مجدولة على مركز IoT.

cancel_scheduled_job(job_id)

المعلمات

الاسم الوصف
job_id
مطلوب
str

معرف الوظيفة.

المرتجعات

النوع الوصف
<xref:azure.iot.hub.models.JobResponse>

كائن JobResponse الذي يحتوي على المهمة الملغاة.

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_import_export_job

إنشاء مهمة استيراد/تصدير جديدة على مركز IoT.

create_import_export_job(job_properties)

المعلمات

الاسم الوصف
job_properties
مطلوب
<xref:azure.iot.hub.models.JobProperties>

يحدد مواصفات الوظيفة.

المرتجعات

النوع الوصف
<xref:azure.iot.hub.models.JobProperties>

عنصر JobProperties الذي يحتوي على الوظيفة التي تم إنشاؤها.

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_scheduled_job

إنشاء مهمة جديدة لجدولة تحديث التوائم أو الأساليب المباشرة للجهاز على مركز IoT.

create_scheduled_job(job_id, job_request)

المعلمات

الاسم الوصف
job_id
مطلوب
str

معرف الوظيفة.

job_request
مطلوب
<xref:azure.iot.hub.models.JobRequest>

يحدد الوظيفة.

المرتجعات

النوع الوصف
<xref:azure.iot.hub.models.JobResponse>

كائن JobResponse الذي يحتوي على الوظيفة التي تم إنشاؤها.

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

تهيئة Classmethod لعميل خدمة IoTHubJobManager. إنشاء فئة IoTHubJobManager من سلسلة الاتصال.

بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي مستعدة لاستدعاء واجهات برمجة التطبيقات الأعضاء للتواصل مع IoTHub.

from_connection_string(connection_string)

المعلمات

الاسم الوصف
connection_string
مطلوب
str

سلسلة اتصال IoTHub المستخدمة لمصادقة الاتصال مع IoTHub.

المرتجعات

النوع الوصف

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

تهيئة Classmethod لعميل خدمة IoTHubJobManager. إنشاء فئة IoTHubJobManager من عنوان url لاسم المضيف وبيانات اعتماد رمز Azure المميز.

بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي مستعدة لاستدعاء واجهات برمجة التطبيقات الأعضاء للتواصل مع IoTHub.

from_token_credential(url, token_credential)

المعلمات

الاسم الوصف
url
مطلوب
str

عنوان URL لخدمة Azure (اسم المضيف).

token_credential
مطلوب
<xref:azure.core.TokenCredential>

كائن بيانات اعتماد الرمز المميز ل Azure

المرتجعات

النوع الوصف

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_import_export_job

استرداد حالة مهمة استيراد/تصدير على IoTHub.

get_import_export_job(job_id)

المعلمات

الاسم الوصف
job_id
مطلوب
str

معرف الوظيفة.

المرتجعات

النوع الوصف
<xref:azure.iot.hub.models.JobProperties>

كائن JobProperties الذي يحتوي على الوظيفة المطلوبة.

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_import_export_jobs

استرداد حالة جميع مهام الاستيراد/التصدير على IoTHub.

get_import_export_jobs()

المرتجعات

النوع الوصف
list[<xref:azure.iot.hub.models.JobProperties>]

عنصر القائمة [job_properties].

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_scheduled_job

استرداد تفاصيل مهمة مجدولة على IoTHub.

get_scheduled_job(job_id)

المعلمات

الاسم الوصف
job_id
مطلوب
str

معرف الوظيفة.

المرتجعات

النوع الوصف
<xref:azure.iot.hub.models.JobResponse>

كائن JobResponse الذي يحتوي على التفاصيل المطلوبة.

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

query_scheduled_jobs

الاستعلام عن مركز IoT لاسترداد المعلومات المتعلقة بالوظائف باستخدام لغة استعلام IoT Hub.

query_scheduled_jobs(job_type, job_status)

المعلمات

الاسم الوصف
job_type
مطلوب
str

نوع الوظائف.

job_status
مطلوب
str

حالة الوظائف.

المرتجعات

النوع الوصف
<xref:azure.iot.hub.models.QueryResult>

كائن QueryResult الذي يحتوي على الوظائف.

استثناءات

النوع الوصف
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>