IoTHubConfigurationManager الفصل

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

تهيئة عميل خدمة Configuration Manager.

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

توريث

builtins.object

IoTHubConfigurationManager

الدالمنشئ

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

المعلمات

الاسم	الوصف
connection_string	str سلسلة اتصال IoTHub المستخدمة لمصادقة الاتصال مع IoTHub إذا كنا نستخدم مصادقة connection_str. القيمة الافتراضية: بلا القيمة الافتراضية: None
host	str عنوان URL لخدمة Azure إذا كنا نستخدم مصادقة بيانات اعتماد الرمز المميز. القيمة الافتراضية: بلا القيمة الافتراضية: None
auth	str كائن مصادقة Azure إذا كنا نستخدم مصادقة بيانات اعتماد الرمز المميز. القيمة الافتراضية: بلا القيمة الافتراضية: None

الأساليب

apply_configuration_on_edge_device	تطبيق محتوى التكوين المتوفر على جهاز الحافة المحدد. محتوى الوحدات النمطية إلزامي.
create_configuration	إنشاء تكوين للأجهزة أو الوحدات النمطية ل IoTHub.
delete_configuration	حذف تكوين من IoTHub.
from_connection_string	تهيئة Classmethod لعميل IoTHubConfigurationManager Service. إنشاء فئة IoTHubConfigurationManager من سلسلة الاتصال. بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي جاهزة لاستدعاء واجهات برمجة تطبيقات العضو للاتصال ب IoTHub.
from_token_credential	تهيئة Classmethod لعميل IoTHubConfigurationManager Service. إنشاء فئة IoTHubConfigurationManager من عنوان url لاسم المضيف وبيانات اعتماد رمز Azure المميز. بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي جاهزة لاستدعاء واجهات برمجة تطبيقات العضو للاتصال ب IoTHub.
get_configuration	استرداد تكوين IoTHub لجهاز معين.
get_configurations	استرداد تكوينات متعددة للجهاز والوحدات النمطية ل IoTHub. إرجاع العدد المحدد من التكوينات. ترقيم الصفحات غير مدعوم.
test_configuration_queries	التحقق من صحة استعلام الشرط الهدف واستعلامات القياس المخصصة للتكوين.
update_configuration	التحديثات تكوين للأجهزة أو الوحدات النمطية ل IoTHub. ملاحظة: لا يمكن للمستخدم تحديث معرف التكوين والمحتوى.

apply_configuration_on_edge_device

تطبيق محتوى التكوين المتوفر على جهاز الحافة المحدد. محتوى الوحدات النمطية إلزامي.

apply_configuration_on_edge_device(device_id, configuration_content)

المعلمات

الاسم	الوصف
configuration_content مطلوب	ConfigurationContent اسم (معرف) جهاز الحافة.
device_id مطلوب

المرتجعات

النوع	الوصف
	كائن.

استثناءات

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

create_configuration

إنشاء تكوين للأجهزة أو الوحدات النمطية ل IoTHub.

create_configuration(configuration)

المعلمات

الاسم	الوصف
configuration_id مطلوب	str معرف التكوين.
configuration مطلوب	Configuration التكوين المراد إنشاؤه.

المرتجعات

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

استثناءات

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

delete_configuration

حذف تكوين من IoTHub.

delete_configuration(configuration_id, etag=None)

المعلمات

الاسم	الوصف
configuration_id مطلوب	str معرف التكوين.
configuration مطلوب	Configuration التكوين المراد إنشاؤه.
etag	str قيمة etag (if_match) لاستخدامها في عملية الحذف. القيمة الافتراضية: None

المرتجعات

النوع	الوصف
	كائن التكوين الذي يحتوي على التكوين المحدث.

استثناءات

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

from_connection_string

تهيئة Classmethod لعميل IoTHubConfigurationManager Service. إنشاء فئة IoTHubConfigurationManager من سلسلة الاتصال.

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

from_connection_string(connection_string)

المعلمات

الاسم	الوصف
connection_string مطلوب	str سلسلة اتصال IoTHub المستخدمة لمصادقة الاتصال مع IoTHub.

المرتجعات

النوع	الوصف
IoTHubConfigurationManager

استثناءات

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

from_token_credential

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

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

from_token_credential(url, token_credential)

المعلمات

الاسم	الوصف
url مطلوب	str عنوان URL لخدمة Azure (اسم المضيف).
token_credential مطلوب	<xref:azure.core.TokenCredential> كائن بيانات اعتماد الرمز المميز ل Azure

المرتجعات

النوع	الوصف
IoTHubConfigurationManager

استثناءات

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

get_configuration

استرداد تكوين IoTHub لجهاز معين.

get_configuration(configuration_id)

المعلمات

الاسم	الوصف
configuration_id مطلوب	str معرف التكوين.

المرتجعات

النوع	الوصف
	كائن التكوين.

استثناءات

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

get_configurations

استرداد تكوينات متعددة للجهاز والوحدات النمطية ل IoTHub. إرجاع العدد المحدد من التكوينات. ترقيم الصفحات غير مدعوم.

get_configurations(max_count=None)

المعلمات

الاسم	الوصف
max_count	int الحد الأقصى لعدد التكوينات المطلوبة. القيمة الافتراضية: None

المرتجعات

النوع	الوصف
	عنصر القائمة [التكوين].

استثناءات

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

test_configuration_queries

التحقق من صحة استعلام الشرط الهدف واستعلامات القياس المخصصة للتكوين.

test_configuration_queries(configuration_queries_test_input)

المعلمات

الاسم	الوصف
configuration_queries_test_input مطلوب	ConfigurationQueriesTestInput اختبار إدخال الاستعلامات.

المرتجعات

النوع	الوصف
	عنصر ConfigurationQueriesTestResponse.

استثناءات

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

update_configuration

التحديثات تكوين للأجهزة أو الوحدات النمطية ل IoTHub. ملاحظة: لا يمكن للمستخدم تحديث معرف التكوين والمحتوى.

update_configuration(configuration, etag)

المعلمات

الاسم	الوصف
configuration_id مطلوب	str معرف التكوين.
configuration مطلوب	Configuration يحتوي التكوين على التكوين المحدث.
etag مطلوب	str قيمة etag (if_match) لاستخدامها في عملية التحديث.

المرتجعات

النوع	الوصف
	كائن التكوين الذي يحتوي على التكوين المحدث.

استثناءات

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