DigitalTwinsClient class

Paket:: @azure/digital-twins-core

Azure IoT DigitalTwins API istemcisi.

Oluşturucular

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

AzureDigitalTwinsAPI örneği oluşturur.

Örnek kullanım:

import { DefaultAzureCredential } from "@azure/identity";
import { DigitalTwinsClient } from "@azure/digital-twins-core";

const url = "<URL to Azure Digital Twins instance>";
const credential = new DefaultAzureCredential();
const serviceClient = new DigitalTwinsClient(url, credential);

Yöntemler

createModels(Record<string, unknown>[], OperationOptions)	Bir veya daha fazla oluşturma
decomissionModel(string, OperationOptions)	Bir json yaması kullanarak modelin yetkisini alma. Bir model kullanımdan kaldırıldığında, yeni dijital ikizler artık bu model tarafından tanımlanamaz. Ancak mevcut dijital ikizler bu modeli kullanmaya devam edebilir. Bir model kullanımdan alındıktan sonra yeniden alınmayabilir.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Dijital ikiz silme
deleteEventRoute(string, OperationOptions)	Olay rotasını silme.
deleteModel(string, OperationOptions)	Modeli silme.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Dijital ikizdeki bir ilişkiyi silme.
getComponent(string, string, OperationOptions)	Dijital ikizde bir bileşen alın.
getDigitalTwin(string, OperationOptions)	Dijital ikiz alma
getEventRoute(string, OperationOptions)	Bir olay yolu alın.
getModel(string, DigitalTwinModelsGetByIdOptionalParams)	Model meta verileri ve model tanımı dahil olmak üzere bir model alın.
getRelationship(string, string, OperationOptions)	Dijital ikizle ilişki edinin.
listEventRoutes(EventRoutesListOptionalParams)	Bir dijital ikiz örneğindeki olay yollarını listeleyin.
listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)	Dijital ikiz için tüm gelen ilişkileri alma.
listModels(DigitalTwinModelsListOptionalParams)	Modellerin listesini alma
listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)	Dijital ikiz için ilişkileri alma.
publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)	Bir dijital ikizin bileşeninden telemetri yayımlayın. Bu, altında tanımlanan bir veya birden çok hedef uç nokta (abone) tarafından kullanılır.
publishTelemetry(string, Record<string, unknown>, string, OperationOptions)	Bir dijital ikizden telemetri yayımlayın. Bu, altında tanımlanan bir veya birden çok hedef uç nokta (abone) tarafından kullanılır.
queryTwins(string, QueryQueryTwinsOptionalParams)	Dijital ikizler için sorgu.
updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)	JSON yaması kullanarak dijital ikizdeki bir bileşenin özelliklerini güncelleştirin.
updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)	JSON yaması kullanarak dijital ikizleri güncelleştirme.
updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)	JSON yaması kullanarak dijital ikiz üzerindeki bir ilişkinin özelliklerini güncelleştirir.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Dijital ikiz oluşturma veya güncelleştirme
upsertEventRoute(string, string, string, OperationOptions)	Olay yolu oluşturun veya güncelleştirin.
upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)	Dijital ikizde ilişki oluşturma veya güncelleştirme.

Oluşturucu Ayrıntıları

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

AzureDigitalTwinsAPI örneği oluşturur.

Örnek kullanım:

import { DefaultAzureCredential } from "@azure/identity";
import { DigitalTwinsClient } from "@azure/digital-twins-core";

const url = "<URL to Azure Digital Twins instance>";
const credential = new DefaultAzureCredential();
const serviceClient = new DigitalTwinsClient(url, credential);

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

Parametreler

endpointUrl: string

Hizmetin uç nokta URL'si.

credential: TokenCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılır.

options: DigitalTwinsClientOptions

Hizmet istemcisini yapılandırmak için kullanılır.

Yöntem Ayrıntıları

createModels(Record<string, unknown>[], OperationOptions)

Bir veya daha fazla oluşturma

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

Parametreler

dtdlModels: Record<string, unknown>[]

Oluşturulacak model kümesi. Her dize tam olarak bir modele karşılık gelir.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<DigitalTwinModelsAddResponse>

Oluşturulan application/json modelleri.

decomissionModel(string, OperationOptions)

Bir json yaması kullanarak modelin yetkisini alma. Bir model kullanımdan kaldırıldığında, yeni dijital ikizler artık bu model tarafından tanımlanamaz. Ancak mevcut dijital ikizler bu modeli kullanmaya devam edebilir. Bir model kullanımdan alındıktan sonra yeniden alınmayabilir.

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

Parametreler

modelId: string

Yetkisi alınacak modelin kimliği. özelliği değiştirilebilir.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<void>

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Dijital ikiz silme

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

Parametreler

digitalTwinId: string

Silinecek dijital ikizin kimliği.

options: DigitalTwinsDeleteOptionalParams

ifMatch dahil genişletilmiş işlem seçenekleri: Yalnızca varlığın etag'i sağlanan veya * sağlanan etag'lerden biriyle eşleşiyorsa işlemi gerçekleştirin.

Döndürülenler

Promise<void>

deleteEventRoute(string, OperationOptions)

Olay rotasını silme.

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

Parametreler

eventRouteId: string

Silinecek eventRoute kimliği.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<void>

deleteModel(string, OperationOptions)

Modeli silme.

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

Parametreler

modelId: string

Silinecek modelin kimliği.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<void>

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Dijital ikizdeki bir ilişkiyi silme.

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

Parametreler

digitalTwinId: string

Kaynak dijital ikizin kimliği.

relationshipId: string

Silinecek ilişkinin kimliği.

options: DigitalTwinsDeleteRelationshipOptionalParams

İşlem seçenekleri ifMatch: Yalnızca varlığın etag'i sağlanan etag'lerden biriyle eşleşiyorsa veya * ise işlemi gerçekleştirin

Döndürülenler

Promise<void>

getComponent(string, string, OperationOptions)

Dijital ikizde bir bileşen alın.

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

Parametreler

digitalTwinId: string

Dijital ikizin kimliği.

componentName: string

Alınan bileşen.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<DigitalTwinsGetComponentResponse>

Sağlanan componentName'e karşılık gelen bileşenin json dize gösterimi.

getDigitalTwin(string, OperationOptions)

Dijital ikiz alma

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

Parametreler

digitalTwinId: string

Dijital ikizin kimliği.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<DigitalTwinsGetByIdResponse>

application/json dijital ikizi.

getEventRoute(string, OperationOptions)

Bir olay yolu alın.

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

Parametreler

eventRouteId: string

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<EventRoute>

application/json olay rotası.

getModel(string, DigitalTwinModelsGetByIdOptionalParams)

Model meta verileri ve model tanımı dahil olmak üzere bir model alın.

function getModel(modelId: string, options?: DigitalTwinModelsGetByIdOptionalParams): Promise<DigitalTwinsModelData>

Parametreler

modelId: string

Modelin kimliği.

options: GetModelOptions

Bu işlem için seçenekler

Döndürülenler

Promise<DigitalTwinsModelData>

application/json modeli.

getRelationship(string, string, OperationOptions)

Dijital ikizle ilişki edinin.

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

Parametreler

digitalTwinId: string

Kaynak dijital ikizin kimliği.

relationshipId: string

Alınacak ilişkinin kimliği.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<DigitalTwinsGetRelationshipByIdResponse>

Belirtilen dijital ikize ait application/json ilişkilerinin sayfalanabilir listesi.

listEventRoutes(EventRoutesListOptionalParams)

Bir dijital ikiz örneğindeki olay yollarını listeleyin.

function listEventRoutes(options?: EventRoutesListOptionalParams): PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>

Parametreler

options: ListEventRoutesOptions

listEventRoutes için seçenekler.

Döndürülenler

PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>

application/json olay rotası.

listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)

Dijital ikiz için tüm gelen ilişkileri alma.

function listIncomingRelationships(digitalTwinId: string, options?: DigitalTwinsListIncomingRelationshipsOptionalParams): PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>

Parametreler

digitalTwinId: string

Dijital ikizin kimliği.

options: ListIncomingRelationshipsOptions

Döndürülenler

PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>

listModels(DigitalTwinModelsListOptionalParams)

Modellerin listesini alma

function listModels(options?: DigitalTwinModelsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>

Parametreler

options: ListModelsOptions

Modelleri listeleme seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>

Sayfalanabilir bir uygulama/json modelleri kümesi.

listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)

Dijital ikiz için ilişkileri alma.

function listRelationships(digitalTwinId: string, options?: DigitalTwinsListRelationshipsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>

Parametreler

digitalTwinId: string

Dijital ikizin kimliği.

options: ListRelationshipsOptions

Döndürülenler

PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>

publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)

Bir dijital ikizin bileşeninden telemetri yayımlayın. Bu, altında tanımlanan bir veya birden çok hedef uç nokta (abone) tarafından kullanılır.

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

Parametreler

digitalTwinId: string

Silinecek dijital ikizin kimliği.

componentName: string

DTDL bileşeninin adı.

payload: Record<string, unknown>

Gönderilecek uygulama/json telemetri yükü.

messageId: string

İleti kimliği.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<void>

publishTelemetry(string, Record<string, unknown>, string, OperationOptions)

Bir dijital ikizden telemetri yayımlayın. Bu, altında tanımlanan bir veya birden çok hedef uç nokta (abone) tarafından kullanılır.

function publishTelemetry(digitalTwinId: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>

Parametreler

digitalTwinId: string

Silinecek dijital ikizin kimliği.

payload: Record<string, unknown>

Gönderilecek uygulama/json telemetri yükü.

messageId: string

İleti kimliği.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<void>

queryTwins(string, QueryQueryTwinsOptionalParams)

Dijital ikizler için sorgu.

function queryTwins(query: string, options?: QueryQueryTwinsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>

Parametreler

query: string

SQL benzeri söz diziminde sorgu dizesi.

options: QueryTwinsOptions

Sorgu işlemi için seçenekler.

Döndürülenler

PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>

Sorgu sonuçlarının sayfalanabilir listesi.

updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)

JSON yaması kullanarak dijital ikizdeki bir bileşenin özelliklerini güncelleştirin.

function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentHeaders>

Parametreler

digitalTwinId: string

Dijital ikizin kimliği.

componentName: string

Güncelleştirilmekte olan bileşen.

jsonPatch: Record<string, unknown>[]

Belirtilen dijital ikizin bileşeninde gerçekleştirilecek application/json-patch+json işlemleri.

options: DigitalTwinsUpdateComponentOptionalParams

ifMatch dahil genişletilmiş işlem seçenekleri: Yalnızca varlığın etag'i sağlanan veya * sağlanan etag'lerden biriyle eşleşiyorsa işlemi gerçekleştirin.

Döndürülenler

Promise<DigitalTwinsUpdateComponentHeaders>

updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)

JSON yaması kullanarak dijital ikizleri güncelleştirme.

function updateDigitalTwin(digitalTwinId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateHeaders>

Parametreler

digitalTwinId: string

Dijital ikizin kimliği.

jsonPatch: Record<string, unknown>[]

JSON Düzeltme Eki tarafından açıklanan bir güncelleştirme belirtimi. Özellik değerlerine ve $model öğelerine yönelik güncelleştirmeler aynı istekte gerçekleşebilir. İşlemler ekleme, değiştirme ve kaldırma işlemleriyle sınırlıdır.

options: DigitalTwinsUpdateOptionalParams

ifMatch dahil genişletilmiş işlem seçenekleri: Yalnızca varlığın etag'i sağlanan veya * sağlanan etag'lerden biriyle eşleşiyorsa işlemi gerçekleştirin.

Döndürülenler

Promise<DigitalTwinsUpdateHeaders>

updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)

JSON yaması kullanarak dijital ikiz üzerindeki bir ilişkinin özelliklerini güncelleştirir.

function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipHeaders>

Parametreler

digitalTwinId: string

Silinecek dijital ikizin kimliği.

relationshipId: string

Güncelleştirilecek ilişkinin kimliği.

jsonPatch: Record<string, unknown>[]

Belirtilen dijital ikizin ilişkisinde gerçekleştirilecek application/json-patch+json işlemleri.

options: DigitalTwinsUpdateRelationshipOptionalParams

Genişletilmiş işlem seçenekleri ifMatch: Yalnızca varlığın etag'i sağlanan veya * sağlanan etag'lerden biriyle eşleşiyorsa işlemi gerçekleştirin.

Döndürülenler

Promise<DigitalTwinsUpdateRelationshipHeaders>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Dijital ikiz oluşturma veya güncelleştirme

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

Parametreler

digitalTwinId: string

Oluşturulacak veya güncelleştirilecek dijital ikizin kimliği.

digitalTwinJson: string

Oluşturulacak uygulama/json dijital ikizi.

options: DigitalTwinsAddOptionalParams

ifNoneMatch de dahil olmak üzere genişletilmiş işlem seçenekleri: Yalnızca varlık yoksa işlemi gerçekleştirin.

Döndürülenler

Promise<DigitalTwinsAddResponse>

Oluşturulan application/json dijital ikizi.

upsertEventRoute(string, string, string, OperationOptions)

Olay yolu oluşturun veya güncelleştirin.

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

Parametreler

eventRouteId: string

Oluşturulacak veya güncelleştirilecek olay yolunun kimliği.

endpointId: string

Bu olay yolunun bağlı olduğu uç noktanın kimliği.

filter: string

Uç noktaya yönlendirilen olayları açıklayan ifade.

options: OperationOptions

İşlem seçenekleri

Döndürülenler

Promise<void>

upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)

Dijital ikizde ilişki oluşturma veya güncelleştirme.

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

Parametreler

digitalTwinId: string

Kaynak dijital ikizin kimliği.

relationshipId: string

Oluşturulacak ilişkinin kimliği.

relationship: Record<string, unknown>

Oluşturulacak uygulama/json ilişkisi.

options: DigitalTwinsAddRelationshipOptionalParams

ifNoneMatch de dahil olmak üzere genişletilmiş işlem seçenekleri: Yalnızca varlık yoksa işlemi gerçekleştirin.

Döndürülenler

Promise<DigitalTwinsAddRelationshipResponse>