Configuration الفصل

تكوين جهاز Iot Hub وتوائم الوحدة النمطية.

توريث
Configuration

الدالمنشئ

Configuration(*, id: str = None, schema_version: str = None, labels=None, content=None, target_condition: str = None, created_time_utc=None, last_updated_time_utc=None, priority: int = None, system_metrics=None, metrics=None, etag: str = None, **kwargs)

المعلمات

id
str
مطلوب

المعرف الفريد للتكوين.

schema_version
str
مطلوب

إصدار المخطط للتكوين.

labels
dict[str, str]
مطلوب

أزواج قيم المفاتيح المستخدمة لوصف التكوين.

content
ConfigurationContent
مطلوب

محتوى التكوين.

target_condition
str
مطلوب

الاستعلام المستخدم لتعريف الأجهزة أو الوحدات المستهدفة. يستند الاستعلام إلى علامات مزدوجة و/أو خصائص تم الإبلاغ عنها.

created_time_utc
datetime
مطلوب

تاريخ ووقت إنشاء التكوين.

last_updated_time_utc
datetime
مطلوب

تاريخ ووقت التحديث للتكوين.

priority
int
مطلوب

رقم الأولوية المعين للتكوين.

system_metrics
ConfigurationMetrics
مطلوب

مقاييس النظام المحسوبة بواسطة IoT Hub التي لا يمكن تخصيصها.

metrics
ConfigurationMetrics
مطلوب

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

etag
str
مطلوب

ETag للتكوين.

الأساليب

as_dict

إرجاع إملاء يمكن أن يكون JSONify باستخدام json.dump.

قد يستخدم الاستخدام المتقدم رد اتصال كمعلمة اختياريا:

المفتاح هو اسم السمة المستخدم في Python. Attr_desc هو قالب من بيانات التعريف. يحتوي حاليا على "type" مع نوع msrest و"المفتاح" مع المفتاح المشفرة RestAPI. القيمة هي القيمة الحالية في هذا الكائن.

سيتم استخدام السلسلة التي تم إرجاعها لتسلسل المفتاح. إذا كان نوع الإرجاع عبارة عن قائمة، يعتبر هذا إملاءا للنتيجة الهرمية.

راجع الأمثلة الثلاثة في هذا الملف:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

deserialize

تحليل سلسلة باستخدام بناء جملة RestAPI وإرجاع نموذج.

enable_additional_properties_sending
from_dict

تحليل الإملاء باستخدام مستخرج مفتاح معين يرجع نموذجا.

بشكل افتراضي، ضع في اعتبارك المستخرجات الرئيسية (rest_key_case_insensitive_extractor attribute_key_case_insensitive_extractor last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

إرجاع JSON الذي سيتم إرساله إلى azure من هذا النموذج.

هذا اسم مستعار as_dict(full_restapi_key_transformer, keep_readonly=False).

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

validate

تحقق من صحة هذا النموذج بشكل متكرر وأعد قائمة ValidationError.

as_dict

إرجاع إملاء يمكن أن يكون JSONify باستخدام json.dump.

قد يستخدم الاستخدام المتقدم رد اتصال كمعلمة اختياريا:

المفتاح هو اسم السمة المستخدم في Python. Attr_desc هو قالب من بيانات التعريف. يحتوي حاليا على "type" مع نوع msrest و"المفتاح" مع المفتاح المشفرة RestAPI. القيمة هي القيمة الحالية في هذا الكائن.

سيتم استخدام السلسلة التي تم إرجاعها لتسلسل المفتاح. إذا كان نوع الإرجاع عبارة عن قائمة، يعتبر هذا إملاءا للنتيجة الهرمية.

راجع الأمثلة الثلاثة في هذا الملف:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

المعلمات

key_transformer
<xref:function>

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

keep_readonly
القيمة الافتراضية: True

المرتجعات

كائن متوافق مع JSON

نوع الإرجاع

deserialize

تحليل سلسلة باستخدام بناء جملة RestAPI وإرجاع نموذج.

deserialize(data, content_type=None)

المعلمات

data
str
مطلوب

سلسلة باستخدام بنية RestAPI. JSON بشكل افتراضي.

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

JSON بشكل افتراضي، قم بتعيين application/xml إذا XML.

المرتجعات

مثيل لهذا النموذج

استثناءات

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

تحليل الإملاء باستخدام مستخرج مفتاح معين يرجع نموذجا.

بشكل افتراضي، ضع في اعتبارك المستخرجات الرئيسية (rest_key_case_insensitive_extractor attribute_key_case_insensitive_extractor last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

المعلمات

data
dict
مطلوب

إملاء باستخدام بنية RestAPI

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

JSON بشكل افتراضي، قم بتعيين application/xml إذا XML.

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

المرتجعات

مثيل لهذا النموذج

استثناءات

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

إرجاع JSON الذي سيتم إرساله إلى azure من هذا النموذج.

هذا اسم مستعار as_dict(full_restapi_key_transformer, keep_readonly=False).

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

المعلمات

keep_readonly
bool
القيمة الافتراضية: False

إذا كنت تريد تسلسل السمات للقراءة فقط

المرتجعات

كائن متوافق مع JSON

نوع الإرجاع

validate

تحقق من صحة هذا النموذج بشكل متكرر وأعد قائمة ValidationError.

validate()

المرتجعات

قائمة بخطأ التحقق من الصحة

نوع الإرجاع