DigitalTwinsClient الفصل
إنشاء مثيل لعميل Digital Twins.
- توريث
-
builtins.objectDigitalTwinsClient
الدالمنشئ
DigitalTwinsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)المعلمات
الأساليب
| create_models |
إنشاء نموذج واحد أو أكثر. عند حدوث أي خطأ، لا يتم تحميل أي نماذج. |
| decommission_model |
إيقاف تشغيل نموذج. |
| delete_digital_twin |
حذف توأم رقمي. |
| delete_event_route |
حذف مسار حدث. |
| delete_model |
حذف نموذج. |
| delete_relationship |
حذف علاقة على توأم رقمي. |
| get_component |
احصل على مكون على التوأم الرقمي. |
| get_digital_twin |
احصل على توأم رقمي. |
| get_event_route |
احصل على مسار حدث. |
| get_model |
احصل على نموذج، بما في ذلك بيانات تعريف النموذج وتعريف النموذج. |
| get_relationship |
الحصول على علاقة على التوأم الرقمي. |
| list_event_routes |
استرداد جميع مسارات الأحداث. |
| list_incoming_relationships |
استرداد جميع العلاقات الواردة لتوأم رقمي. |
| list_models |
احصل على قائمة النماذج. |
| list_relationships |
استرداد العلاقات لتوأم رقمي. |
| publish_component_telemetry |
نشر بيانات تتبع الاستخدام من مكون التوأم الرقمي، والذي يتم استهلاكه بعد ذلك بواسطة نقطة نهاية وجهة واحدة أو العديد من نقاط النهاية (المشتركين) المحددة ضمن. |
| publish_telemetry |
نشر بيانات تتبع الاستخدام من توأم رقمي، والذي يتم استهلاكه بعد ذلك بواسطة نقطة نهاية وجهة واحدة أو العديد من نقاط النهاية (المشتركين) المحددة ضمن. |
| query_twins |
الاستعلام عن التوائم الرقمية. ملاحظة: قد يكون هناك تأخير بين قبل أن تنعكس التغييرات في المثيل الخاص بك في الاستعلامات. لمزيد من التفاصيل حول قيود الاستعلام، راجع https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations |
| update_component |
تحديث خصائص مكون على توأم رقمي باستخدام تصحيح JSON. |
| update_digital_twin |
تحديث توأم رقمي باستخدام تصحيح JSON. |
| update_relationship |
التحديثات خصائص العلاقة على توأم رقمي باستخدام تصحيح JSON. |
| upsert_digital_twin |
إنشاء توأم رقمي أو تحديثه. |
| upsert_event_route |
إنشاء مسار حدث أو تحديثه. |
| upsert_relationship |
إنشاء علاقة أو تحديثها على توأم رقمي. |
create_models
إنشاء نموذج واحد أو أكثر. عند حدوث أي خطأ، لا يتم تحميل أي نماذج.
create_models(dtdl_models: List[Dict[str, object]], **kwargs: Any) -> List[DigitalTwinsModelData]المعلمات
مجموعة النماذج المراد إنشاؤها. تتوافق كل إملاء مع نموذج واحد بالضبط.
المرتجعات
قائمة النماذج التي تم إنشاؤها.
نوع الإرجاع
استثناءات
يوجد بالفعل نموذج واحد أو أكثر من النماذج المقدمة.
decommission_model
إيقاف تشغيل نموذج.
decommission_model(model_id: str, **kwargs: Any) -> Noneالمعلمات
المرتجعات
بلا
نوع الإرجاع
استثناءات
لا يوجد نموذج مع المعرف المقدم.
delete_digital_twin
حذف توأم رقمي.
delete_digital_twin(digital_twin_id: str, **kwargs: Any) -> Noneالمعلمات
- match_condition
- MatchConditions
الشرط الذي يجب تنفيذ العملية بموجبه.
- etag
- str
قم بتنفيذ العملية فقط إذا كان etag للكيان يطابق القيمة المقدمة وفقا match_condition.
المرتجعات
بلا
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي مع المعرف المقدم.
delete_event_route
حذف مسار حدث.
delete_event_route(event_route_id: str, **kwargs: Any) -> Noneالمعلمات
المرتجعات
بلا
نوع الإرجاع
استثناءات
لا يوجد مسار حدث بالمعرف المتوفر.
delete_model
حذف نموذج.
delete_model(model_id: str, **kwargs: Any) -> Noneالمعلمات
المرتجعات
بلا
نوع الإرجاع
استثناءات
لا يوجد نموذج مع المعرف المقدم.
هناك تبعيات على النموذج تمنع حذفه.
delete_relationship
حذف علاقة على توأم رقمي.
delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> Noneالمعلمات
- match_condition
- MatchConditions
الشرط الذي يجب تنفيذ العملية بموجبه.
- etag
- str
قم بتنفيذ العملية فقط إذا كان etag للكيان يطابق القيمة المقدمة وفقا match_condition.
المرتجعات
بلا
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي أو علاقة بالمعرف المقدم.
get_component
احصل على مكون على التوأم الرقمي.
get_component(digital_twin_id: str, component_name: str, **kwargs: Any) -> Dict[str, object]المعلمات
المرتجعات
القاموس الذي يحتوي على المكون.
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي مع المعرف المقدم أو كان اسم المكون غير صالح.
get_digital_twin
احصل على توأم رقمي.
get_digital_twin(digital_twin_id: str, **kwargs: Any) -> Dict[str, object]المعلمات
المرتجعات
القاموس الذي يحتوي على التوأم.
نوع الإرجاع
استثناءات
إذا لم يكن التوأم الرقمي موجودا.
get_event_route
احصل على مسار حدث.
get_event_route(event_route_id: str, **kwargs: Any) -> DigitalTwinsEventRouteالمعلمات
المرتجعات
كائن مسار الحدث.
نوع الإرجاع
استثناءات
لا يوجد مسار حدث بالمعرف المتوفر.
get_model
احصل على نموذج، بما في ذلك بيانات تعريف النموذج وتعريف النموذج.
get_model(model_id: str, **kwargs: Any) -> DigitalTwinsModelDataالمعلمات
- include_model_definition
- bool
قم بتضمين تعريف النموذج كجزء من النتيجة. القيمة الافتراضية هي False.
المرتجعات
بيانات النموذج.
نوع الإرجاع
استثناءات
إذا لم يكن هناك نموذج مع المعرف المقدم.
get_relationship
الحصول على علاقة على التوأم الرقمي.
get_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> Dict[str, object]المعلمات
المرتجعات
القاموس الذي يحتوي على العلاقة.
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي أو علاقة بالمعرف المقدم.
list_event_routes
استرداد جميع مسارات الأحداث.
list_event_routes(**kwargs: Any) -> ItemPaged[DigitalTwinsEventRoute]المعلمات
- results_per_page
- int
الحد الأقصى لعدد العناصر المراد استردادها لكل طلب. قد يختار الخادم إرجاع أقل من الحد الأقصى المطلوب.
المرتجعات
مثيل مكرر لمسارات الأحداث.
نوع الإرجاع
استثناءات
list_incoming_relationships
استرداد جميع العلاقات الواردة لتوأم رقمي.
list_incoming_relationships(digital_twin_id: str, **kwargs: Any) -> ItemPaged[IncomingRelationship]المعلمات
المرتجعات
مكرر مثل مثيل أي من العلاقة.
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي مع المعرف المقدم.
list_models
احصل على قائمة النماذج.
list_models(dependencies_for: List[str] | None = None, **kwargs: Any) -> ItemPaged[DigitalTwinsModelData]المعلمات
معرفات النموذج المراد استرداد تبعياتها. إذا تم حذفها، يتم استرداد جميع النماذج.
- include_model_definition
- bool
قم بتضمين تعريف النموذج كجزء من النتائج. القيمة الافتراضية هي False.
- results_per_page
- int
الحد الأقصى لعدد العناصر المراد استردادها لكل طلب. قد يختار الخادم إرجاع أقل من الحد الأقصى المطلوب.
المرتجعات
مثيل مكرر لقائمة بيانات النموذج.
نوع الإرجاع
استثناءات
list_relationships
استرداد العلاقات لتوأم رقمي.
list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs: Any) -> ItemPaged[Dict[str, object]]المعلمات
المرتجعات
مثيل مكرر لقائمة العلاقات
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي مع المعرف المقدم.
publish_component_telemetry
نشر بيانات تتبع الاستخدام من مكون التوأم الرقمي، والذي يتم استهلاكه بعد ذلك بواسطة نقطة نهاية وجهة واحدة أو العديد من نقاط النهاية (المشتركين) المحددة ضمن.
publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs: Any) -> Noneالمعلمات
- message_id
- str
معرف الرسالة. إذا لم يتم تحديده، فسيتم إنشاء UUID.
المرتجعات
بلا
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي مع المعرف المقدم أو اسم المكون غير صالح.
publish_telemetry
نشر بيانات تتبع الاستخدام من توأم رقمي، والذي يتم استهلاكه بعد ذلك بواسطة نقطة نهاية وجهة واحدة أو العديد من نقاط النهاية (المشتركين) المحددة ضمن.
publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs: Any) -> Noneالمعلمات
- message_id
- str
معرف الرسالة. إذا لم يتم تحديده، فسيتم إنشاء UUID.
المرتجعات
بلا
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي مع المعرف المقدم.
query_twins
الاستعلام عن التوائم الرقمية.
ملاحظة: قد يكون هناك تأخير بين قبل أن تنعكس التغييرات في المثيل الخاص بك في الاستعلامات. لمزيد من التفاصيل حول قيود الاستعلام، راجع https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
query_twins(query_expression: str, **kwargs: Any) -> ItemPaged[Dict[str, object]]المعلمات
المرتجعات
قابل للتكبير لنتائج الاستعلام.
نوع الإرجاع
استثناءات
update_component
تحديث خصائص مكون على توأم رقمي باستخدام تصحيح JSON.
update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> Noneالمعلمات
- match_condition
- MatchConditions
الشرط الذي يجب تنفيذ العملية بموجبه.
- etag
- str
قم بتنفيذ العملية فقط إذا كان etag للكيان يطابق القيمة المقدمة وفقا match_condition.
المرتجعات
بلا
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي مع المعرف المقدم أو كان اسم المكون غير صالح.
update_digital_twin
تحديث توأم رقمي باستخدام تصحيح JSON.
update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> Noneالمعلمات
مواصفات تحديث موصوفة بواسطة JSON Patch. قد يحدث التحديثات إلى قيم الخصائص وعناصر $model في نفس الطلب. تقتصر العمليات على الإضافةوالاستبدالوالإزالة.
- match_condition
- MatchConditions
الشرط الذي يجب تنفيذ العملية بموجبه.
- etag
- str
قم بتنفيذ العملية فقط إذا كان etag للكيان يطابق القيمة المقدمة وفقا match_condition.
المرتجعات
بلا
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي مع المعرف المقدم.
update_relationship
التحديثات خصائص العلاقة على توأم رقمي باستخدام تصحيح JSON.
update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> Noneالمعلمات
- match_condition
- MatchConditions
الشرط الذي يجب تنفيذ العملية بموجبه.
- etag
- str
قم بتنفيذ العملية فقط إذا كان etag للكيان يطابق القيمة المقدمة وفقا match_condition.
المرتجعات
بلا
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي أو علاقة بالمعرف المقدم.
upsert_digital_twin
إنشاء توأم رقمي أو تحديثه.
upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs: Any) -> Dict[str, object]المعلمات
- match_condition
- MatchConditions
الشرط الذي يجب تنفيذ العملية بموجبه.
- etag
- str
قم بتنفيذ العملية فقط إذا كان etag للكيان يطابق القيمة المقدمة وفقا match_condition.
المرتجعات
القاموس الذي يحتوي على التوأم الذي تم إنشاؤه أو تحديثه.
نوع الإرجاع
استثناءات
إذا كان التوأم الرقمي موجودا بالفعل.
upsert_event_route
إنشاء مسار حدث أو تحديثه.
upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs: Any) -> Noneالمعلمات
المرتجعات
بلا
نوع الإرجاع
استثناءات
upsert_relationship
إنشاء علاقة أو تحديثها على توأم رقمي.
upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs: Any) -> Dict[str, object]المعلمات
- match_condition
- MatchConditions
الشرط الذي يجب تنفيذ العملية بموجبه.
- etag
- str
قم بتنفيذ العملية فقط إذا كان etag للكيان يطابق القيمة المقدمة وفقا match_condition.
المرتجعات
العلاقة التي تم إنشاؤها أو تحديثها.
نوع الإرجاع
استثناءات
إذا لم يكن هناك توأم رقمي، فإن التوأم الرقمي المستهدف أو العلاقة مع المعرف المقدم.
Azure SDK for Python
الملاحظات
قريبًا: خلال عام 2024، سنتخلص تدريجيًا من GitHub Issues بوصفها آلية إرسال ملاحظات للمحتوى ونستبدلها بنظام ملاحظات جديد. لمزيد من المعلومات، راجع https://aka.ms/ContentUserFeedback.
إرسال الملاحظات وعرضها المتعلقة بـ