DigitalTwinsClient class

Paket:

@azure/digital-twins-core

Klien untuk Azure IoT DigitalTwins API.

Konstruktor

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Membuat instans AzureDigitalTwinsAPI. Contoh penggunaan: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

Metode

createModels(any[], OperationOptions)	Membuat satu atau banyak
decomissionModel(string, OperationOptions)	Menonaktifkan model menggunakan patch json. Ketika model dinonaktifkan, kembar digital baru tidak akan lagi dapat didefinisikan oleh model ini. Namun, kembar digital yang ada dapat terus menggunakan model ini. Setelah model dinonaktifkan, model mungkin tidak akan dikoreksi ulang.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Menghapus twin digital
deleteEventRoute(string, OperationOptions)	Menghapus rute peristiwa.
deleteModel(string, OperationOptions)	Hapus model.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Menghapus hubungan pada kembar digital.
getComponent(string, string, OperationOptions)	Dapatkan komponen pada kembar digital.
getDigitalTwin(string, OperationOptions)	Mendapatkan kembar digital
getEventRoute(string, OperationOptions)	Mendapatkan rute peristiwa.
getModel(string, boolean, OperationOptions)	Dapatkan model, termasuk metadata model dan definisi model.
getRelationship(string, string, OperationOptions)	Dapatkan hubungan pada kembar digital.
listEventRoutes(number, OperationOptions & PageSettings)	Mencantumkan rute peristiwa dalam instans kembar digital.
listIncomingRelationships(string, OperationOptions & PageSettings)	Ambil semua hubungan masuk untuk kembar digital.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Mendapatkan daftar model
listRelationships(string, OperationOptions & PageSettings)	Mengambil hubungan untuk kembar digital.
publishComponentTelemetry(string, string, string, string, OperationOptions)	Terbitkan telemetri dari komponen kembar digital, yang kemudian digunakan oleh satu atau banyak titik akhir tujuan (pelanggan) yang ditentukan di bawah.
publishTelemetry(string, any, string, OperationOptions)	Terbitkan telemetri dari kembar digital, yang kemudian dikonsumsi oleh satu atau banyak titik akhir tujuan (pelanggan) yang ditentukan di bawah.
queryTwins(string, number, OperationOptions & PageSettings)	Kueri untuk kembar digital.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Memperbarui properti komponen pada kembaran digital menggunakan patch JSON.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Perbarui kembaran digital menggunakan patch json.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Updates properti hubungan pada kembaran digital menggunakan patch JSON.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Membuat atau memperbarui kembar digital
upsertEventRoute(string, string, string, OperationOptions)	Membuat atau memperbarui rute peristiwa.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	Membuat atau memperbarui hubungan pada kembar digital.

Detail Konstruktor

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Membuat instans AzureDigitalTwinsAPI.

Contoh penggunaan:

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

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

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

Parameter

endpointUrl

string

URL titik akhir layanan.

credential

TokenCredential

Digunakan untuk mengautentikasi permintaan ke layanan.

options

DigitalTwinsClientOptions

Digunakan untuk mengonfigurasi klien layanan.

Detail Metode

createModels(any[], OperationOptions)

Membuat satu atau banyak

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

Parameter

dtdlModels

any[]

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<DigitalTwinModelsAddResponse>

Model aplikasi/json yang dibuat dan respons http.

decomissionModel(string, OperationOptions)

Menonaktifkan model menggunakan patch json. Ketika model dinonaktifkan, kembar digital baru tidak akan lagi dapat didefinisikan oleh model ini. Namun, kembar digital yang ada dapat terus menggunakan model ini. Setelah model dinonaktifkan, model mungkin tidak akan dikoreksi ulang.

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

Parameter

modelId

string

Id model yang akan dinonaktifkan. properti dapat diganti.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<RestResponse>

Respons http.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Menghapus twin digital

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

Parameter

digitalTwinId

string

Id kembar digital yang akan dihapus.

options

DigitalTwinsDeleteOptionalParams

Opsi operasi yang diperluas termasuk ifMatch: Hanya lakukan operasi jika etag entitas cocok dengan salah satu etag yang disediakan atau * disediakan.

Mengembalikan

Promise<RestResponse>

Respons http.

deleteEventRoute(string, OperationOptions)

Menghapus rute peristiwa.

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

Parameter

eventRouteId

string

Id eventRoute yang akan dihapus.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<RestResponse>

Respons http.

deleteModel(string, OperationOptions)

Hapus model.

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

Parameter

modelId

string

Id model yang akan dihapus.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<RestResponse>

Respons http.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Menghapus hubungan pada kembar digital.

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

Parameter

digitalTwinId

string

Id kembar digital sumber.

relationshipId

string

Id hubungan yang akan dihapus.

options

DigitalTwinsDeleteRelationshipOptionalParams

Opsi operasi ifMatch: Hanya melakukan operasi jika etag entitas cocok dengan salah satu etag yang disediakan atau * adalah

Mengembalikan

Promise<RestResponse>

Respons http.

getComponent(string, string, OperationOptions)

Dapatkan komponen pada kembar digital.

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

Parameter

digitalTwinId

string

Id kembar digital.

componentName

string

Komponen sedang diambil.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<DigitalTwinsGetComponentResponse>

Representasi string Json dari komponen yang sesuai dengan componentName dan respons HTTP yang disediakan.

getDigitalTwin(string, OperationOptions)

Mendapatkan kembar digital

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

Parameter

digitalTwinId

string

Id kembar digital.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<DigitalTwinsGetByIdResponse>

Aplikasi/json digital twin dan respons http.

getEventRoute(string, OperationOptions)

Mendapatkan rute peristiwa.

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

Parameter

eventRouteId

string

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<EventRoutesGetByIdResponse>

Rute peristiwa aplikasi/json dan respons http.

getModel(string, boolean, OperationOptions)

Dapatkan model, termasuk metadata model dan definisi model.

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

Parameter

modelId

string

Id model.

includeModelDefinition

boolean

options

OperationOptions

Opsi operasi yang diperluas termasuk includeModelDefinition: Ketika benar definisi model akan dikembalikan sebagai bagian dari hasil. Nilai default: false.

Mengembalikan

Promise<DigitalTwinModelsGetByIdResponse>

Model aplikasi/json dan respons http.

getRelationship(string, string, OperationOptions)

Dapatkan hubungan pada kembar digital.

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

Parameter

digitalTwinId

string

Id kembar digital sumber.

relationshipId

string

Id hubungan yang akan diambil.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<DigitalTwinsGetRelationshipByIdResponse>

Daftar hubungan aplikasi/json yang dapat di-pageable milik kembar digital yang ditentukan dan respons http.

listEventRoutes(number, OperationOptions & PageSettings)

Mencantumkan rute peristiwa dalam instans kembar digital.

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

Parameter

resultsPerPage

number

Jumlah maksimum item yang akan diambil per permintaan. Server dapat memilih untuk mengembalikan kurang dari maksimal yang diminta.

options

OperationOptions & PageSettings

Mengembalikan

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

Rute peristiwa aplikasi/json dan respons http.

listIncomingRelationships(string, OperationOptions & PageSettings)

Ambil semua hubungan masuk untuk kembar digital.

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

Parameter

digitalTwinId

string

Id kembar digital.

options

OperationOptions & PageSettings

Mengembalikan

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

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

Mendapatkan daftar model

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

Parameter

dependeciesFor

string[]

Id model untuk memiliki dependensi yang diambil. Jika dihilangkan, semua model diambil.

includeModelDefinition

boolean

Apakah akan menyertakan definisi model dalam hasil. Jika false, hanya metadata model yang akan dikembalikan.

resultsPerPage

number

Jumlah maksimum item yang akan diambil per permintaan. Server dapat memilih untuk mengembalikan kurang dari maksimal yang diminta.

options

OperationOptions & PageSettings

Mengembalikan

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

Sekumpulan model aplikasi/json yang dapat di-pageable dan respons http.

listRelationships(string, OperationOptions & PageSettings)

Mengambil hubungan untuk kembar digital.

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

Parameter

digitalTwinId

string

Id kembar digital.

options

OperationOptions & PageSettings

Mengembalikan

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

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

Terbitkan telemetri dari komponen kembar digital, yang kemudian digunakan oleh satu atau banyak titik akhir tujuan (pelanggan) yang ditentukan di bawah.

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

Parameter

digitalTwinId

string

Id kembar digital yang akan dihapus.

componentName

string

Nama komponen DTDL.

payload

string

Payload telemetri aplikasi/json yang akan dikirim.

messageId

string

Id pesan.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<RestResponse>

Respons http.

publishTelemetry(string, any, string, OperationOptions)

Terbitkan telemetri dari kembar digital, yang kemudian dikonsumsi oleh satu atau banyak titik akhir tujuan (pelanggan) yang ditentukan di bawah.

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

Parameter

digitalTwinId

string

Id kembar digital yang akan dihapus.

payload

any

Payload telemetri aplikasi/json yang akan dikirim.

messageId

string

Id pesan.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<RestResponse>

Respons http.

queryTwins(string, number, OperationOptions & PageSettings)

Kueri untuk kembar digital.

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

Parameter

query

string

String kueri, dalam sintaks seperti SQL.

resultsPerPage

number

Jumlah maksimum item yang akan diambil per permintaan. Server dapat memilih untuk mengembalikan kurang dari maksimal yang diminta.

options

OperationOptions & PageSettings

Mengembalikan

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

Daftar hasil kueri yang dapat di-pageable.

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

Memperbarui properti komponen pada kembaran digital menggunakan patch JSON.

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

Parameter

digitalTwinId

string

Id kembar digital.

componentName

string

Komponen sedang diperbarui.

jsonPatch

any[]

Operasi application/json-patch+json yang akan dilakukan pada komponen digital twin yang ditentukan.

options

DigitalTwinsUpdateComponentOptionalParams

Opsi operasi yang diperluas termasuk ifMatch: Hanya lakukan operasi jika etag entitas cocok dengan salah satu etag yang disediakan atau * disediakan.

Mengembalikan

Promise<DigitalTwinsUpdateComponentResponse>

Respons http.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

Perbarui kembaran digital menggunakan patch json.

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

Parameter

digitalTwinId

string

Id kembar digital.

jsonPatch

any

Spesifikasi pembaruan yang dijelaskan oleh JSON Patch. Updates ke nilai properti dan elemen $model mungkin terjadi dalam permintaan yang sama. Operasi terbatas pada penambahan, penggantian, dan penghapusan.

options

DigitalTwinsUpdateOptionalParams

Opsi operasi yang diperluas termasuk ifMatch: Hanya lakukan operasi jika etag entitas cocok dengan salah satu etag yang disediakan atau * disediakan.

Mengembalikan

Promise<DigitalTwinsUpdateResponse>

Respons http.

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

Updates properti hubungan pada kembaran digital menggunakan patch JSON.

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

Parameter

digitalTwinId

string

Id kembar digital yang akan dihapus.

relationshipId

string

Id hubungan yang akan diperbarui.

jsonPatch

any[]

Operasi application/json-patch+json yang akan dilakukan pada hubungan kembar digital yang ditentukan.

options

DigitalTwinsUpdateRelationshipOptionalParams

Opsi operasi yang diperluas ifMatch: Hanya lakukan operasi jika etag entitas cocok dengan salah satu etag yang disediakan atau * disediakan.

Mengembalikan

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Membuat atau memperbarui kembar digital

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

Parameter

digitalTwinId

string

Id kembar digital untuk membuat atau memperbarui.

digitalTwinJson

string

Aplikasi/json digital twin untuk dibuat.

options

DigitalTwinsAddOptionalParams

Opsi operasi yang diperluas termasuk ifNoneMatch: Hanya lakukan operasi jika entitas belum ada.

Mengembalikan

Promise<DigitalTwinsAddResponse>

Aplikasi yang dibuat/json digital twin dan respons http.

upsertEventRoute(string, string, string, OperationOptions)

Membuat atau memperbarui rute peristiwa.

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

Parameter

eventRouteId

string

Id rute peristiwa untuk membuat atau memperbarui.

endpointId

string

Id titik akhir rute peristiwa ini terikat.

filter

string

Ekspresi yang menjelaskan peristiwa yang dirutekan ke titik akhir.

options

OperationOptions

Opsi operasi

Mengembalikan

Promise<RestResponse>

Respons http.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

Membuat atau memperbarui hubungan pada kembar digital.

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

Parameter

digitalTwinId

string

Id kembar digital sumber.

relationshipId

string

Id hubungan yang akan dibuat.

relationship

any

Hubungan aplikasi/json yang akan dibuat.

options

DigitalTwinsAddRelationshipOptionalParams

Opsi operasi yang diperluas termasuk ifNoneMatch: Hanya lakukan operasi jika entitas belum ada.

Mengembalikan

Promise<DigitalTwinsAddRelationshipResponse>