IoTHubRegistryManager الفصل

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

تهيئة عميل خدمة إدارة السجل.

يجب ألا يستدعي المستخدمون هذا مباشرة. بدلا من ذلك، يجب أن تكون أساليب مصنع from_connection_string() أو from_token_credential() .

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

توريث

builtins.object

IoTHubRegistryManager

الدالمنشئ

IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)

المعلمات

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

الأساليب

bulk_create_or_update_devices	إنشاء هويات أجهزة متعددة أو تحديثها أو حذفها من سجل هوية IoTHub. إنشاء هويات أجهزة متعددة أو تحديثها أو حذفها من سجل هوية IoTHub. يمكن تحديد هوية الجهاز مرة واحدة فقط في القائمة. يسمح بعمليات مختلفة (إنشاء وتحديث وحذف) على أجهزة مختلفة. يمكن تحديد 100 جهاز كحد أقصى لكل استدعاء. بالنسبة للعمليات واسعة النطاق، ضع في اعتبارك استخدام ميزة الاستيراد باستخدام تخزين كائن ثنائي كبير الحجم (https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
create_device_with_certificate_authority	إنشاء هوية جهاز على IoTHub باستخدام المرجع المصدق.
create_device_with_sas	إنشاء هوية جهاز على IoTHub باستخدام مصادقة SAS.
create_device_with_x509	إنشاء هوية جهاز على IoTHub باستخدام مصادقة X509.
create_module_with_certificate_authority	إنشاء هوية وحدة نمطية لجهاز على IoTHub باستخدام المرجع المصدق.
create_module_with_sas	إنشاء هوية وحدة نمطية لجهاز على IoTHub باستخدام مصادقة SAS.
create_module_with_x509	إنشاء هوية وحدة نمطية لجهاز على IoTHub باستخدام مصادقة X509.
delete_device	حذف هوية جهاز من IoTHub.
delete_module	حذف هوية وحدة نمطية لجهاز من IoTHub.
from_connection_string	تهيئة Classmethod لعميل خدمة إدارة السجل. إنشاء فئة Registry Manager من سلسلة الاتصال. بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي مستعدة لاستدعاء واجهات برمجة التطبيقات الأعضاء للتواصل مع IoTHub.
from_token_credential	تهيئة Classmethod لعميل خدمة إدارة السجل. إنشاء فئة Registry Manager من عنوان url لاسم المضيف وبيانات اعتماد رمز Azure المميز. بعد الإنشاء الناجح، تمت مصادقة الفئة مع IoTHub وهي مستعدة لاستدعاء واجهات برمجة التطبيقات الأعضاء للتواصل مع IoTHub.
get_device	استرداد هوية جهاز من IoTHub.
get_device_registry_statistics	استرداد إحصائيات سجل جهاز IoTHub.
get_devices	احصل على هويات أجهزة متعددة من سجل هوية IoTHub. غير مستحسن. استخدم لغة استعلام IoTHub لاسترداد معلومات هوية الجهاز المزدوج والجهاز. راجع https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub و https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language لمزيد من المعلومات.
get_module	استرداد هوية وحدة نمطية لجهاز من IoTHub.
get_module_twin	يحصل على وحدة مزدوجة.
get_modules	استرداد جميع هويات الوحدة النمطية على جهاز.
get_service_statistics	استرداد إحصائيات خدمة IoTHub.
get_twin	يحصل على توأم الجهاز.
invoke_device_method	استدعاء أسلوب مباشر على جهاز.
invoke_device_module_method	استدعاء أسلوب مباشر على جهاز.
query_iot_hub	الاستعلام عن IoTHub لاسترداد المعلومات المتعلقة بتوائم الجهاز باستخدام لغة تشبه SQL. راجع https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language لمزيد من المعلومات. يتم دعم ترقيم الصفحات للنتائج. يؤدي ذلك إلى إرجاع معلومات حول توائم الجهاز فقط.
replace_module_twin	يستبدل العلامات والخصائص المطلوبة للوحدة النمطية المزدوجة.
replace_twin	يستبدل العلامات والخصائص المطلوبة لجهاز مزدوج.
send_c2d_message	إرسال رسالة C2D إلى جهاز IoTHub.
update_device_with_certificate_authority	التحديثات هوية جهاز على IoTHub باستخدام المرجع المصدق.
update_device_with_sas	التحديثات هوية جهاز على IoTHub باستخدام مصادقة SAS.
update_device_with_x509	التحديثات هوية جهاز على IoTHub باستخدام مصادقة X509.
update_module_twin	التحديثات العلامات والخصائص المطلوبة للوحدة المزدوجة.
update_module_with_certificate_authority	التحديثات هوية وحدة نمطية لجهاز على IoTHub باستخدام المرجع المصدق.
update_module_with_sas	التحديثات هوية وحدة نمطية لجهاز على IoTHub باستخدام مصادقة SAS.
update_module_with_x509	التحديثات هوية وحدة نمطية لجهاز على IoTHub باستخدام مصادقة X509.
update_twin	التحديثات العلامات والخصائص المطلوبة لجهاز مزدوج.

bulk_create_or_update_devices

إنشاء هويات أجهزة متعددة أو تحديثها أو حذفها من سجل هوية IoTHub.

إنشاء هويات أجهزة متعددة أو تحديثها أو حذفها من سجل هوية IoTHub. يمكن تحديد هوية الجهاز مرة واحدة فقط في القائمة. يسمح بعمليات مختلفة (إنشاء وتحديث وحذف) على أجهزة مختلفة. يمكن تحديد 100 جهاز كحد أقصى لكل استدعاء. بالنسبة للعمليات واسعة النطاق، ضع في اعتبارك استخدام ميزة الاستيراد باستخدام تخزين كائن ثنائي كبير الحجم (https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

bulk_create_or_update_devices(devices)

المعلمات

الاسم	الوصف
devices مطلوب	list[ExportImportDevice] قائمة كائنات الجهاز للعمل عليها.

المرتجعات

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

استثناءات

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

create_device_with_certificate_authority

إنشاء هوية جهاز على IoTHub باستخدام المرجع المصدق.

create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
status مطلوب	str الحالة الأولية للجهاز الذي تم إنشاؤه. (القيم المحتملة: "ممكن" أو "معطل").
iot_edge	bool ما إذا كان الجهاز الذي تم إنشاؤه هو جهاز IoT Edge أم لا. القيمة الافتراضية: خطأ القيمة الافتراضية: False
status_reason	str سبب حالة هوية الجهاز. القيمة الافتراضية: بلا القيمة الافتراضية: None
device_scope	str نطاق الجهاز. القيمة الافتراضية: لا توجد علاقة تلقائية تم إنشاؤها وغير قابلة للتغيير لأجهزة الحافة وقابلة للتعديل في الأجهزة الطرفية لإنشاء علاقة تابعة/أصل. بالنسبة للأجهزة الطرفية، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. القيمة الافتراضية: None
parent_scopes	Union[list[str], str] نطاقات أجهزة الحافة من المستوى الأعلى إذا كان ذلك ممكنا. القيمة الافتراضية: لا شيء لأجهزة الحافة، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. بالنسبة للأجهزة الطرفية، يمكن تعيين هذا إلى نفس قيمة device_scope أو ترك الخدمة لنسخها. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

create_device_with_sas

إنشاء هوية جهاز على IoTHub باستخدام مصادقة SAS.

create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
primary_key مطلوب	str مفتاح المصادقة الأساسي.
secondary_key مطلوب	str مفتاح المصادقة الثانوي.
status مطلوب	str الحالة الأولية للجهاز الذي تم إنشاؤه. (القيم المحتملة: "ممكن" أو "معطل")
iot_edge	bool ما إذا كان الجهاز الذي تم إنشاؤه هو جهاز IoT Edge أم لا. القيمة الافتراضية: خطأ القيمة الافتراضية: False
status_reason	str سبب حالة هوية الجهاز. القيمة الافتراضية: بلا القيمة الافتراضية: None
device_scope	str نطاق الجهاز. القيمة الافتراضية: لا توجد علاقة تلقائية تم إنشاؤها وغير قابلة للتغيير لأجهزة الحافة وقابلة للتعديل في الأجهزة الطرفية لإنشاء علاقة تابعة/أصل. بالنسبة للأجهزة الطرفية، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. القيمة الافتراضية: None
parent_scopes	Union[list[str], str] نطاقات أجهزة الحافة من المستوى الأعلى إذا كان ذلك ممكنا. القيمة الافتراضية: لا شيء لأجهزة الحافة، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. بالنسبة للأجهزة الطرفية، يمكن تعيين هذا إلى نفس قيمة device_scope أو ترك الخدمة لنسخها. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

create_device_with_x509

إنشاء هوية جهاز على IoTHub باستخدام مصادقة X509.

create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
primary_thumbprint مطلوب	str بصمة إبهام X509 الأساسية.
secondary_thumbprint مطلوب	str بصمة الإبهام X509 الثانوية.
status مطلوب	str الحالة الأولية للجهاز الذي تم إنشاؤه. (القيم المحتملة: "ممكن" أو "معطل")
iot_edge	bool ما إذا كان الجهاز الذي تم إنشاؤه هو جهاز IoT Edge أم لا. القيمة الافتراضية: خطأ القيمة الافتراضية: False
status_reason	str سبب حالة هوية الجهاز. القيمة الافتراضية: بلا القيمة الافتراضية: None
device_scope	str نطاق الجهاز. القيمة الافتراضية: لا توجد علاقة تلقائية تم إنشاؤها وغير قابلة للتغيير لأجهزة الحافة وقابلة للتعديل في الأجهزة الطرفية لإنشاء علاقة تابعة/أصل. بالنسبة للأجهزة الطرفية، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. القيمة الافتراضية: None
parent_scopes	Union[list[str], str] نطاقات أجهزة الحافة من المستوى الأعلى إذا كان ذلك ممكنا. القيمة الافتراضية: لا شيء لأجهزة الحافة، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. بالنسبة للأجهزة الطرفية، يمكن تعيين هذا إلى نفس قيمة device_scope أو ترك الخدمة لنسخها. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

create_module_with_certificate_authority

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

create_module_with_certificate_authority(device_id, module_id, managed_by)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
managed_by مطلوب	str اسم جهاز المدير (edge).

المرتجعات

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

استثناءات

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

create_module_with_sas

إنشاء هوية وحدة نمطية لجهاز على IoTHub باستخدام مصادقة SAS.

create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
managed_by مطلوب	str اسم جهاز المدير (edge).
primary_key مطلوب	str مفتاح المصادقة الأساسي.
secondary_key مطلوب	str مفتاح المصادقة الثانوي.

المرتجعات

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

استثناءات

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

create_module_with_x509

إنشاء هوية وحدة نمطية لجهاز على IoTHub باستخدام مصادقة X509.

create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
managed_by مطلوب	str اسم جهاز المدير (edge).
primary_thumbprint مطلوب	str بصمة إبهام X509 الأساسية.
secondary_thumbprint مطلوب	str بصمة الإبهام X509 الثانوية.

المرتجعات

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

استثناءات

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

delete_device

حذف هوية جهاز من IoTHub.

delete_device(device_id, etag=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
etag	str قيمة etag (if_match) لاستخدامها في عملية الحذف. القيمة الافتراضية: None

المرتجعات

النوع	الوصف
	لا شيء

استثناءات

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

delete_module

حذف هوية وحدة نمطية لجهاز من IoTHub.

delete_module(device_id, module_id, etag=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
etag	str قيمة etag (if_match) لاستخدامها في عملية الحذف. القيمة الافتراضية: None

المرتجعات

النوع	الوصف
	لا شيء

استثناءات

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

from_connection_string

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

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

from_connection_string(connection_string)

المعلمات

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

المرتجعات

النوع	الوصف
IoTHubRegistryManager

استثناءات

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

from_token_credential

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

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

from_token_credential(url, token_credential)

المعلمات

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

المرتجعات

النوع	الوصف
IoTHubRegistryManager

استثناءات

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

get_device

استرداد هوية جهاز من IoTHub.

get_device(device_id)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.

المرتجعات

النوع	الوصف
	كائن الجهاز الذي يحتوي على الجهاز المطلوب.

استثناءات

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

get_device_registry_statistics

استرداد إحصائيات سجل جهاز IoTHub.

get_device_registry_statistics()

المرتجعات

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

استثناءات

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

get_devices

احصل على هويات أجهزة متعددة من سجل هوية IoTHub. غير مستحسن. استخدم لغة استعلام IoTHub لاسترداد معلومات هوية الجهاز المزدوج والجهاز. راجع https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub و https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language لمزيد من المعلومات.

get_devices(max_number_of_devices=None)

المعلمات

الاسم	الوصف
max_number_of_devices	int تحدد هذه المعلمة عند تحديدها الحد الأقصى لعدد هويات الجهاز التي يتم إرجاعها. أي قيمة خارج نطاق 1-1000 تعتبر 1000 القيمة الافتراضية: None

المرتجعات

النوع	الوصف
	قائمة معلومات الجهاز.

استثناءات

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

get_module

استرداد هوية وحدة نمطية لجهاز من IoTHub.

get_module(device_id, module_id)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.

المرتجعات

النوع	الوصف
	عنصر الوحدة النمطية الذي يحتوي على الوحدة النمطية المطلوبة.

استثناءات

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

get_module_twin

يحصل على وحدة مزدوجة.

get_module_twin(device_id, module_id)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.

المرتجعات

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

استثناءات

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

get_modules

استرداد جميع هويات الوحدة النمطية على جهاز.

get_modules(device_id)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.

المرتجعات

النوع	الوصف
	القائمة [الوحدة] التي تحتوي على جميع الوحدات النمطية على الجهاز.

استثناءات

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

get_service_statistics

استرداد إحصائيات خدمة IoTHub.

get_service_statistics()

المرتجعات

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

استثناءات

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

get_twin

يحصل على توأم الجهاز.

get_twin(device_id)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.

المرتجعات

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

استثناءات

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

invoke_device_method

استدعاء أسلوب مباشر على جهاز.

invoke_device_method(device_id, direct_method_request)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
direct_method_request مطلوب	CloudToDeviceMethod طلب الأسلوب.

المرتجعات

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

استثناءات

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

invoke_device_module_method

استدعاء أسلوب مباشر على جهاز.

invoke_device_module_method(device_id, module_id, direct_method_request)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
direct_method_request مطلوب	CloudToDeviceMethod طلب الأسلوب.

المرتجعات

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

استثناءات

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

query_iot_hub

الاستعلام عن IoTHub لاسترداد المعلومات المتعلقة بتوائم الجهاز باستخدام لغة تشبه SQL. راجع https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language لمزيد من المعلومات. يتم دعم ترقيم الصفحات للنتائج. يؤدي ذلك إلى إرجاع معلومات حول توائم الجهاز فقط.

query_iot_hub(query_specification, continuation_token=None, max_item_count=None)

المعلمات

الاسم	الوصف
query مطلوب	QuerySpecification مواصفات الاستعلام.
continuation_token	str الرمز المميز للمتابعة للترحيل القيمة الافتراضية: None
max_item_count	str الحد الأقصى لعدد توائم الجهاز المطلوبة القيمة الافتراضية: None
query_specification مطلوب

المرتجعات

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

استثناءات

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

replace_module_twin

يستبدل العلامات والخصائص المطلوبة للوحدة النمطية المزدوجة.

replace_module_twin(device_id, module_id, module_twin, etag=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
module_twin مطلوب	Twin المعلومات المزدوجة للوحدة النمطية.
etag	str قيمة etag (if_match) لاستخدامها في عملية استبدال. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

replace_twin

يستبدل العلامات والخصائص المطلوبة لجهاز مزدوج.

replace_twin(device_id, device_twin, etag=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
device_twin مطلوب	Twin المعلومات المزدوجة للجهاز.
etag	str قيمة etag (if_match) لاستخدامها في عملية استبدال. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

send_c2d_message

إرسال رسالة C2D إلى جهاز IoTHub.

send_c2d_message(device_id, message, properties={})

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
message مطلوب	str الرسالة التي سيتم تسليمها إلى الجهاز.
properties	dict الخصائص التي سيتم إرسالها مع الرسالة. يمكن أن يحتوي على خصائص التطبيق وخصائص النظام القيمة الافتراضية: {}

استثناءات

النوع	الوصف
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

التحديثات هوية جهاز على IoTHub باستخدام المرجع المصدق.

update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
etag مطلوب	str قيمة etag (if_match) لاستخدامها في عملية التحديث.
status مطلوب	str الحالة الأولية للجهاز الذي تم إنشاؤه. (القيم المحتملة: "ممكن" أو "معطل").
iot_edge	bool ما إذا كان الجهاز الذي تم إنشاؤه هو جهاز IoT Edge أم لا. القيمة الافتراضية: خطأ القيمة الافتراضية: False
status_reason	str سبب حالة هوية الجهاز. القيمة الافتراضية: بلا القيمة الافتراضية: None
device_scope	str نطاق الجهاز. القيمة الافتراضية: لا توجد قيمة تلقائية تم إنشاؤها وغير قابلة للتغيير لأجهزة الحافة وقابلة للتعديل في الأجهزة الطرفية لإنشاء علاقة تابعة/أصل. بالنسبة للأجهزة الطرفية، يمكن استرداد قيمة تعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. القيمة الافتراضية: None
parent_scopes	Union[list[str], str] نطاقات أجهزة الحافة من المستوى الأعلى إذا كان ذلك ممكنا. القيمة الافتراضية: لا شيء لأجهزة الحافة، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. بالنسبة للأجهزة الطرفية، يمكن تعيين هذا إلى نفس قيمة device_scope أو ترك الخدمة لنسخها. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

update_device_with_sas

التحديثات هوية جهاز على IoTHub باستخدام مصادقة SAS.

update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
etag مطلوب	str قيمة etag (if_match) لاستخدامها في عملية التحديث.
primary_key مطلوب	str مفتاح المصادقة الأساسي.
secondary_key مطلوب	str مفتاح المصادقة الثانوي.
status مطلوب	str الحالة الأولية للجهاز الذي تم إنشاؤه. (القيم المحتملة: "ممكن" أو "معطل").
iot_edge	bool ما إذا كان الجهاز الذي تم إنشاؤه هو جهاز IoT Edge أم لا. القيمة الافتراضية: خطأ القيمة الافتراضية: False
status_reason	str سبب حالة هوية الجهاز. القيمة الافتراضية: بلا القيمة الافتراضية: None
device_scope	str نطاق الجهاز. القيمة الافتراضية: لا توجد قيمة تلقائية تم إنشاؤها وغير قابلة للتغيير لأجهزة الحافة وقابلة للتعديل في الأجهزة الطرفية لإنشاء علاقة تابعة/أصل. بالنسبة للأجهزة الطرفية، يمكن استرداد قيمة تعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. القيمة الافتراضية: None
parent_scopes	Union[list[str], str] نطاقات أجهزة الحافة من المستوى الأعلى إذا كان ذلك ممكنا. القيمة الافتراضية: لا شيء لأجهزة الحافة، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. بالنسبة للأجهزة الطرفية، يمكن تعيين هذا إلى نفس قيمة device_scope أو ترك الخدمة لنسخها. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

update_device_with_x509

التحديثات هوية جهاز على IoTHub باستخدام مصادقة X509.

update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
etag مطلوب	str قيمة etag (if_match) لاستخدامها في عملية التحديث.
primary_thumbprint مطلوب	str بصمة إبهام X509 الأساسية.
secondary_thumbprint مطلوب	str بصمة إبهام X509 الثانوية.
status مطلوب	str الحالة الأولية للجهاز الذي تم إنشاؤه. (القيم المحتملة: "ممكن" أو "معطل").
iot_edge	bool ما إذا كان الجهاز الذي تم إنشاؤه هو جهاز IoT Edge أم لا. القيمة الافتراضية: خطأ القيمة الافتراضية: False
status_reason	str سبب حالة هوية الجهاز. القيمة الافتراضية: بلا القيمة الافتراضية: None
device_scope	str نطاق الجهاز. القيمة الافتراضية: لا توجد قيمة تلقائية تم إنشاؤها وغير قابلة للتغيير لأجهزة الحافة وقابلة للتعديل في الأجهزة الطرفية لإنشاء علاقة تابعة/أصل. بالنسبة للأجهزة الطرفية، يمكن استرداد قيمة تعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. القيمة الافتراضية: None
parent_scopes	Union[list[str], str] نطاقات أجهزة الحافة من المستوى الأعلى إذا كان ذلك ممكنا. القيمة الافتراضية: لا شيء لأجهزة الحافة، يمكن استرداد القيمة لتعيين جهاز حافة أصل من خاصية device_scope لجهاز الحافة الأصل. بالنسبة للأجهزة الطرفية، يمكن تعيين هذا إلى نفس قيمة device_scope أو ترك الخدمة لنسخها. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

update_module_twin

التحديثات العلامات والخصائص المطلوبة للوحدة المزدوجة.

update_module_twin(device_id, module_id, module_twin, etag=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
module_twin مطلوب	Twin المعلومات المزدوجة للوحدة النمطية.
etag	str قيمة etag (if_match) لاستخدامها في عملية التحديث. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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

update_module_with_certificate_authority

التحديثات هوية وحدة نمطية لجهاز على IoTHub باستخدام المرجع المصدق.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
managed_by مطلوب	str اسم جهاز المدير (edge).
etag مطلوب	str قيمة etag (if_match) لاستخدامها في عملية التحديث.

المرتجعات

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

استثناءات

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

update_module_with_sas

التحديثات هوية وحدة نمطية لجهاز على IoTHub باستخدام مصادقة SAS.

update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
managed_by مطلوب	str اسم جهاز المدير (edge).
etag مطلوب	str قيمة etag (if_match) لاستخدامها في عملية التحديث.
primary_key مطلوب	str مفتاح المصادقة الأساسي.
secondary_key مطلوب	str مفتاح المصادقة الثانوي.

المرتجعات

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

استثناءات

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

update_module_with_x509

التحديثات هوية وحدة نمطية لجهاز على IoTHub باستخدام مصادقة X509.

update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
module_id مطلوب	str اسم (معرف) الوحدة النمطية.
managed_by مطلوب	str اسم جهاز المدير (edge).
etag مطلوب	str قيمة etag (if_match) لاستخدامها في عملية التحديث.
primary_thumbprint مطلوب	str بصمة إبهام X509 الأساسية.
secondary_thumbprint مطلوب	str بصمة إبهام X509 الثانوية.

المرتجعات

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

استثناءات

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

update_twin

التحديثات العلامات والخصائص المطلوبة لجهاز مزدوج.

update_twin(device_id, device_twin, etag=None)

المعلمات

الاسم	الوصف
device_id مطلوب	str اسم (معرف) الجهاز.
device_twin مطلوب	Twin المعلومات المزدوجة للجهاز.
etag	str قيمة etag (if_match) لاستخدامها في عملية التحديث. القيمة الافتراضية: None

المرتجعات

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

استثناءات

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