DigitalTwinsClient class

الحزمة:

@azure/digital-twins-core

عميل لواجهة برمجة تطبيقات Azure IoT DigitalTwins.

المنشئون

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

إنشاء مثيل AzureDigitalTwinsAPI. استخدام المثال: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

الأساليب

createModels(any[], OperationOptions)	إنشاء واحد أو أكثر
decomissionModel(string, OperationOptions)	إيقاف تشغيل نموذج باستخدام تصحيح json. عندما يتم إيقاف تشغيل نموذج، لن يتمكن هذا النموذج من تعريف التوائم الرقمية الجديدة. ومع ذلك، قد يستمر التوأم الرقمي الحالي في استخدام هذا النموذج. بمجرد إيقاف تشغيل النموذج، قد لا يتم إعادة تشغيله.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	حذف التوأم الرقمي
deleteEventRoute(string, OperationOptions)	حذف مسار حدث.
deleteModel(string, OperationOptions)	حذف نموذج.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	حذف علاقة على توأم رقمي.
getComponent(string, string, OperationOptions)	احصل على مكون على التوأم الرقمي.
getDigitalTwin(string, OperationOptions)	الحصول على توأم رقمي
getEventRoute(string, OperationOptions)	احصل على مسار حدث.
getModel(string, boolean, OperationOptions)	احصل على نموذج، بما في ذلك بيانات تعريف النموذج وتعريف النموذج.
getRelationship(string, string, OperationOptions)	الحصول على علاقة على التوأم الرقمي.
listEventRoutes(number, OperationOptions & PageSettings)	سرد مسارات الأحداث في مثيل التوائم الرقمية.
listIncomingRelationships(string, OperationOptions & PageSettings)	استرداد جميع العلاقات الواردة لتوأم رقمي.
listModels(string[], boolean, number, OperationOptions & PageSettings)	الحصول على قائمة النماذج
listRelationships(string, OperationOptions & PageSettings)	استرداد العلاقات لتوأم رقمي.
publishComponentTelemetry(string, string, string, string, OperationOptions)	انشر بيانات تتبع الاستخدام من مكون التوأم الرقمي، والذي يتم استهلاكه بعد ذلك بواسطة نقطة نهاية وجهة واحدة أو العديد من نقاط النهاية الوجهة (المشتركون) المحددة ضمن.
publishTelemetry(string, any, string, OperationOptions)	نشر بيانات تتبع الاستخدام من التوأم الرقمي، والذي يتم استهلاكه بعد ذلك بواسطة نقطة نهاية وجهة واحدة أو أكثر (المشتركون) المحددة ضمن.
queryTwins(string, number, OperationOptions & PageSettings)	الاستعلام عن التوائم الرقمية.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	تحديث خصائص مكون على توأم رقمي باستخدام تصحيح JSON.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	تحديث التوأم الرقمي باستخدام تصحيح json.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	التحديثات خصائص العلاقة على توأم رقمي باستخدام تصحيح JSON.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	إنشاء توأم رقمي أو تحديثه
upsertEventRoute(string, string, string, OperationOptions)	إنشاء مسار حدث أو تحديثه.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	إنشاء علاقة أو تحديثها على التوأم الرقمي.

تفاصيل المنشئ

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

إنشاء مثيل AzureDigitalTwinsAPI.

استخدام المثال:

const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core");

const client = new DigitalTwinsClient(
  "<endpoint>",
  new DefaultAzureCredential();
);

new DigitalTwinsClient(endpointUrl: string, credential: TokenCredential, options?: DigitalTwinsClientOptions)

المعلمات

endpointUrl

string

عنوان URL لنقطة النهاية للخدمة.

credential

TokenCredential

يستخدم لمصادقة الطلبات إلى الخدمة.

options

DigitalTwinsClientOptions

يستخدم لتكوين عميل الخدمة.

تفاصيل الأسلوب

createModels(any[], OperationOptions)

إنشاء واحد أو أكثر

function createModels(dtdlModels: any[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>

المعلمات

dtdlModels

any[]

options

OperationOptions

خيارات العملية

المرتجعات

Promise<DigitalTwinModelsAddResponse>

نماذج التطبيق/json التي تم إنشاؤها واستجابة http.

decomissionModel(string, OperationOptions)

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

function decomissionModel(modelId: string, options?: OperationOptions): Promise<RestResponse>

المعلمات

modelId

string

معرف النموذج لإيقاف التشغيل. يمكن استبدال الخاصية.

options

OperationOptions

خيارات العملية

المرتجعات

Promise<RestResponse>

استجابة http.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

حذف التوأم الرقمي

function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<RestResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي المراد حذفه.

options

DigitalTwinsDeleteOptionalParams

خيارات العملية الموسعة بما في ذلك ifMatch: قم بتنفيذ العملية فقط إذا كان etag للكيان يطابق إحدى etags المتوفرة أو * يتم توفيرها.

المرتجعات

Promise<RestResponse>

استجابة http.

deleteEventRoute(string, OperationOptions)

حذف مسار حدث.

function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<RestResponse>

المعلمات

eventRouteId

string

معرف الحدثRoute المراد حذفه.

options

OperationOptions

خيارات العملية

المرتجعات

Promise<RestResponse>

استجابة http.

deleteModel(string, OperationOptions)

حذف نموذج.

function deleteModel(modelId: string, options?: OperationOptions): Promise<RestResponse>

المعلمات

modelId

string

معرف النموذج المراد حذفه.

options

OperationOptions

خيارات العملية

المرتجعات

Promise<RestResponse>

استجابة http.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

حذف علاقة على توأم رقمي.

function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<RestResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي المصدر.

relationshipId

string

معرف العلاقة المراد حذفها.

options

DigitalTwinsDeleteRelationshipOptionalParams

خيارات العملية ifMatch: تنفيذ العملية فقط إذا كان etag للكيان يطابق أحد علامات etag المتوفرة أو * هو

المرتجعات

Promise<RestResponse>

استجابة http.

getComponent(string, string, OperationOptions)

احصل على مكون على التوأم الرقمي.

function getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي.

componentName

string

المكون الذي يتم استرداده.

options

OperationOptions

خيارات العملية

المرتجعات

Promise<DigitalTwinsGetComponentResponse>

تمثيل سلسلة Json للمكون المقابل ل componentName المتوفر واستجابة HTTP.

getDigitalTwin(string, OperationOptions)

الحصول على توأم رقمي

function getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي.

options

OperationOptions

خيارات العملية

المرتجعات

Promise<DigitalTwinsGetByIdResponse>

التوأم الرقمي للتطبيق/json واستجابة http.

getEventRoute(string, OperationOptions)

احصل على مسار حدث.

function getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoutesGetByIdResponse>

المعلمات

eventRouteId

string

options

OperationOptions

خيارات العملية

المرتجعات

Promise<EventRoutesGetByIdResponse>

مسار حدث application/json واستجابة http.

getModel(string, boolean, OperationOptions)

احصل على نموذج، بما في ذلك بيانات تعريف النموذج وتعريف النموذج.

function getModel(modelId: string, includeModelDefinition?: boolean, options?: OperationOptions): Promise<DigitalTwinModelsGetByIdResponse>

المعلمات

modelId

string

معرف النموذج.

includeModelDefinition

boolean

options

OperationOptions

خيارات العملية الموسعة بما في ذلك includeModelDefinition: عندما يكون تعريف النموذج صحيحا، سيتم إرجاعه كجزء من النتيجة. القيمة الافتراضية: خطأ.

المرتجعات

Promise<DigitalTwinModelsGetByIdResponse>

نموذج التطبيق/json واستجابة http.

getRelationship(string, string, OperationOptions)

الحصول على علاقة على التوأم الرقمي.

function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي المصدر.

relationshipId

string

معرف العلاقة المراد استردادها.

options

OperationOptions

خيارات العملية

المرتجعات

Promise<DigitalTwinsGetRelationshipByIdResponse>

قائمة قابلة للصفحة لعلاقات التطبيق/json التي تنتمي إلى التوأم الرقمي المحدد واستجابة http.

listEventRoutes(number, OperationOptions & PageSettings)

سرد مسارات الأحداث في مثيل التوائم الرقمية.

function listEventRoutes(resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

المعلمات

resultsPerPage

number

الحد الأقصى لعدد العناصر المراد استردادها لكل طلب. قد يختار الخادم إرجاع أقل من الحد الأقصى المطلوب.

options

OperationOptions & PageSettings

المرتجعات

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

مسار حدث application/json واستجابة http.

listIncomingRelationships(string, OperationOptions & PageSettings)

استرداد جميع العلاقات الواردة لتوأم رقمي.

function listIncomingRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي.

options

OperationOptions & PageSettings

المرتجعات

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

listModels(string[], boolean, number, OperationOptions & PageSettings)

الحصول على قائمة النماذج

function listModels(dependeciesFor?: string[], includeModelDefinition?: boolean, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

المعلمات

dependeciesFor

string[]

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

includeModelDefinition

boolean

ما إذا كان يجب تضمين تعريف النموذج في النتيجة. إذا كانت خاطئة، فسيتم إرجاع بيانات تعريف النموذج فقط.

resultsPerPage

number

الحد الأقصى لعدد العناصر المراد استردادها لكل طلب. قد يختار الخادم إرجاع أقل من الحد الأقصى المطلوب.

options

OperationOptions & PageSettings

المرتجعات

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

مجموعة قابلة للصفحة من نماذج التطبيق/json واستجابة http.

listRelationships(string, OperationOptions & PageSettings)

استرداد العلاقات لتوأم رقمي.

function listRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي.

options

OperationOptions & PageSettings

المرتجعات

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

publishComponentTelemetry(string, string, string, string, OperationOptions)

انشر بيانات تتبع الاستخدام من مكون التوأم الرقمي، والذي يتم استهلاكه بعد ذلك بواسطة نقطة نهاية وجهة واحدة أو العديد من نقاط النهاية الوجهة (المشتركون) المحددة ضمن.

function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: string, messageId: string, options?: OperationOptions): Promise<RestResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي المراد حذفه.

componentName

string

اسم مكون DTDL.

payload

string

حمولة بيانات تتبع الاستخدام للتطبيق/json التي سيتم إرسالها.

messageId

string

معرف الرسالة.

options

OperationOptions

خيارات العملية

المرتجعات

Promise<RestResponse>

استجابة http.

publishTelemetry(string, any, string, OperationOptions)

نشر بيانات تتبع الاستخدام من التوأم الرقمي، والذي يتم استهلاكه بعد ذلك بواسطة نقطة نهاية وجهة واحدة أو أكثر (المشتركون) المحددة ضمن.

function publishTelemetry(digitalTwinId: string, payload: any, messageId: string, options?: OperationOptions): Promise<RestResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي المراد حذفه.

payload

any

حمولة بيانات تتبع الاستخدام للتطبيق/json التي سيتم إرسالها.

messageId

string

معرف الرسالة.

options

OperationOptions

خيارات العملية

المرتجعات

Promise<RestResponse>

استجابة http.

queryTwins(string, number, OperationOptions & PageSettings)

الاستعلام عن التوائم الرقمية.

function queryTwins(query: string, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

المعلمات

query

string

سلسلة الاستعلام، في بناء جملة يشبه SQL.

resultsPerPage

number

الحد الأقصى لعدد العناصر المراد استردادها لكل طلب. قد يختار الخادم إرجاع أقل من الحد الأقصى المطلوب.

options

OperationOptions & PageSettings

المرتجعات

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

قائمة نتائج الاستعلام القابلة للصفحة.

updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)

تحديث خصائص مكون على توأم رقمي باستخدام تصحيح JSON.

function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: any[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي.

componentName

string

المكون الذي يتم تحديثه.

jsonPatch

any[]

عمليات application/json-patch+json التي سيتم تنفيذها على مكون التوأم الرقمي المحدد.

options

DigitalTwinsUpdateComponentOptionalParams

خيارات العملية الموسعة بما في ذلك ifMatch: يتم توفير العملية فقط إذا تطابق etag للكيان مع إحدى etags المتوفرة أو * .

المرتجعات

Promise<DigitalTwinsUpdateComponentResponse>

استجابة http.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

تحديث التوأم الرقمي باستخدام تصحيح json.

function updateDigitalTwin(digitalTwinId: string, jsonPatch: any, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي.

jsonPatch

any

مواصفات تحديث موصوفة بواسطة JSON Patch. قد يحدث التحديثات إلى قيم الخصائص وعناصر $model في نفس الطلب. تقتصر العمليات على الإضافة والاستبدال والإزالة.

options

DigitalTwinsUpdateOptionalParams

خيارات العملية الموسعة بما في ذلك ifMatch: يتم توفير العملية فقط إذا تطابق etag للكيان مع إحدى etags المتوفرة أو * .

المرتجعات

Promise<DigitalTwinsUpdateResponse>

استجابة http.

updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)

التحديثات خصائص العلاقة على توأم رقمي باستخدام تصحيح JSON.

function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: any[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي المراد حذفه.

relationshipId

string

معرف العلاقة المراد تحديثها.

jsonPatch

any[]

عمليات application/json-patch+json التي سيتم إجراؤها على علاقة التوأم الرقمي المحدد.

options

DigitalTwinsUpdateRelationshipOptionalParams

خيارات العملية الموسعة ifMatch: تنفيذ العملية فقط إذا تطابق etag للكيان مع إحدى etags المتوفرة أو * يتم توفيرها.

المرتجعات

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

إنشاء توأم رقمي أو تحديثه

function upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: DigitalTwinsAddOptionalParams): Promise<DigitalTwinsAddResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي المراد إنشاؤه أو تحديثه.

digitalTwinJson

string

التوأم الرقمي للتطبيق/json المراد إنشاؤه.

options

DigitalTwinsAddOptionalParams

خيارات العملية الموسعة بما في ذلك ifNoneMatch: قم بتنفيذ العملية فقط إذا لم يكن الكيان موجودا بالفعل.

المرتجعات

Promise<DigitalTwinsAddResponse>

التوأم الرقمي للتطبيق/json الذي تم إنشاؤه واستجابة http.

upsertEventRoute(string, string, string, OperationOptions)

إنشاء مسار حدث أو تحديثه.

function upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<RestResponse>

المعلمات

eventRouteId

string

معرف مسار الحدث المراد إنشاؤه أو تحديثه.

endpointId

string

معرف نقطة النهاية التي يرتبط بها مسار الحدث هذا.

filter

string

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

options

OperationOptions

خيارات العملية

المرتجعات

Promise<RestResponse>

استجابة http.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

إنشاء علاقة أو تحديثها على التوأم الرقمي.

function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: any, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>

المعلمات

digitalTwinId

string

معرف التوأم الرقمي المصدر.

relationshipId

string

معرف العلاقة المراد إنشاؤها.

relationship

any

علاقة التطبيق/json التي سيتم إنشاؤها.

options

DigitalTwinsAddRelationshipOptionalParams

خيارات العملية الموسعة بما في ذلك ifNoneMatch: قم بتنفيذ العملية فقط إذا لم يكن الكيان موجودا بالفعل.

المرتجعات

Promise<DigitalTwinsAddRelationshipResponse>