DigitalTwinsClient class

Paket:

@azure/digital-twins-core

Klient för Azure IoT DigitalTwins API.

Konstruktorer

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Skapar en instans av AzureDigitalTwinsAPI. Exempel på användning: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

Metoder

createModels(any[], OperationOptions)	Skapa en eller flera
decomissionModel(string, OperationOptions)	Inaktivera en modell med hjälp av en json-korrigering. När en modell inaktiveras kan nya digitala tvillingar inte längre definieras av den här modellen. Befintliga digitala tvillingar kan dock fortsätta att använda den här modellen. När en modell har inaktiverats kanske den inte återupptas.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Ta bort en digital tvilling
deleteEventRoute(string, OperationOptions)	Ta bort en händelseväg.
deleteModel(string, OperationOptions)	Ta bort en modell.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Ta bort en relation på en digital tvilling.
getComponent(string, string, OperationOptions)	Hämta en komponent på en digital tvilling.
getDigitalTwin(string, OperationOptions)	Hämta en digital tvilling
getEventRoute(string, OperationOptions)	Hämta en händelseväg.
getModel(string, boolean, OperationOptions)	Hämta en modell, inklusive modellmetadata och modelldefinitionen.
getRelationship(string, string, OperationOptions)	Skaffa en relation på en digital tvilling.
listEventRoutes(number, OperationOptions & PageSettings)	Visa en lista över händelsevägarna i en Digital Twins-instans.
listIncomingRelationships(string, OperationOptions & PageSettings)	Hämta alla inkommande relationer för en digital tvilling.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Hämta listan över modeller
listRelationships(string, OperationOptions & PageSettings)	Hämta relationer för en digital tvilling.
publishComponentTelemetry(string, string, string, string, OperationOptions)	Publicera telemetri från en digital tvillings komponent, som sedan används av en eller flera målslutpunkter (prenumeranter) som definierats under.
publishTelemetry(string, any, string, OperationOptions)	Publicera telemetri från en digital tvilling, som sedan används av en eller flera målslutpunkter (prenumeranter) som definierats under.
queryTwins(string, number, OperationOptions & PageSettings)	Fråga efter digitala tvillingar.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Uppdatera egenskaper för en komponent på en digital tvilling med hjälp av en JSON-korrigering.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Uppdatera en digital tvilling med hjälp av en json-korrigering.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Uppdateringar egenskaperna för en relation på en digital tvilling med hjälp av en JSON-korrigering.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Skapa eller uppdatera en digital tvilling
upsertEventRoute(string, string, string, OperationOptions)	Skapa eller uppdatera en händelseväg.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	Skapa eller uppdatera en relation på en digital tvilling.

Konstruktorinformation

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Skapar en instans av AzureDigitalTwinsAPI.

Exempel på användning:

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

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

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

Parametrar

endpointUrl

string

Slutpunkts-URL:en för tjänsten.

credential

TokenCredential

Används för att autentisera begäranden till tjänsten.

options

DigitalTwinsClientOptions

Används för att konfigurera tjänstklienten.

Metodinformation

createModels(any[], OperationOptions)

Skapa en eller flera

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

Parametrar

dtdlModels

any[]

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<DigitalTwinModelsAddResponse>

De skapade program-/json-modellerna och http-svaret.

decomissionModel(string, OperationOptions)

Inaktivera en modell med hjälp av en json-korrigering. När en modell inaktiveras kan nya digitala tvillingar inte längre definieras av den här modellen. Befintliga digitala tvillingar kan dock fortsätta att använda den här modellen. När en modell har inaktiverats kanske den inte återupptas.

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

Parametrar

modelId

string

ID:t för modellen som ska inaktiveras. egenskapen kan ersättas.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<RestResponse>

HTTP-svaret.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Ta bort en digital tvilling

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

Parametrar

digitalTwinId

string

ID för den digitala tvilling som ska tas bort.

options

DigitalTwinsDeleteOptionalParams

Alternativ för utökad åtgärd, inklusive ifMatch: Utför endast åtgärden om entitetens etag matchar en av de angivna etags eller * har angetts.

Returer

Promise<RestResponse>

HTTP-svaret.

deleteEventRoute(string, OperationOptions)

Ta bort en händelseväg.

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

Parametrar

eventRouteId

string

ID:t för den eventRoute som ska tas bort.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<RestResponse>

HTTP-svaret.

deleteModel(string, OperationOptions)

Ta bort en modell.

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

Parametrar

modelId

string

ID:t för modellen som ska tas bort.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<RestResponse>

HTTP-svaret.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Ta bort en relation på en digital tvilling.

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

Parametrar

digitalTwinId

string

ID för den digitala källtvillingen.

relationshipId

string

ID för relationen som ska tas bort.

options

DigitalTwinsDeleteRelationshipOptionalParams

Åtgärdsalternativen ifMatch: Utför endast åtgärden om entitetens etag matchar en av de angivna etags eller * är

Returer

Promise<RestResponse>

HTTP-svaret.

getComponent(string, string, OperationOptions)

Hämta en komponent på en digital tvilling.

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

Parametrar

digitalTwinId

string

ID för den digitala tvillingen.

componentName

string

Komponenten som hämtas.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<DigitalTwinsGetComponentResponse>

Json-strängrepresentation av komponenten som motsvarar det angivna componentName och HTTP-svaret.

getDigitalTwin(string, OperationOptions)

Hämta en digital tvilling

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

Parametrar

digitalTwinId

string

ID för den digitala tvillingen.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<DigitalTwinsGetByIdResponse>

Den digitala tvillingen application/json och http-svaret.

getEventRoute(string, OperationOptions)

Hämta en händelseväg.

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

Parametrar

eventRouteId

string

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<EventRoutesGetByIdResponse>

Application/json-händelsevägen och http-svaret.

getModel(string, boolean, OperationOptions)

Hämta en modell, inklusive modellmetadata och modelldefinitionen.

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

Parametrar

modelId

string

Modellens ID.

includeModelDefinition

boolean

options

OperationOptions

Alternativ för utökad åtgärd inklusive includeModelDefinition: När sant returneras modelldefinitionen som en del av resultatet. Standardvärde: false.

Returer

Promise<DigitalTwinModelsGetByIdResponse>

Application/json-modellen och http-svaret.

getRelationship(string, string, OperationOptions)

Skaffa en relation på en digital tvilling.

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

Parametrar

digitalTwinId

string

ID för den digitala källtvillingen.

relationshipId

string

ID för relationen som ska hämtas.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<DigitalTwinsGetRelationshipByIdResponse>

Den växlingsbara listan över program-/json-relationer som tillhör den angivna digitala tvillingen och http-svaret.

listEventRoutes(number, OperationOptions & PageSettings)

Visa en lista över händelsevägarna i en Digital Twins-instans.

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

Parametrar

resultsPerPage

number

Det maximala antalet objekt som ska hämtas per begäran. Servern kan välja att returnera mindre än det begärda maxvärdet.

options

OperationOptions & PageSettings

Returer

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

Application/json-händelsevägen och http-svaret.

listIncomingRelationships(string, OperationOptions & PageSettings)

Hämta alla inkommande relationer för en digital tvilling.

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

Parametrar

digitalTwinId

string

ID för den digitala tvillingen.

options

OperationOptions & PageSettings

Returer

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

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

Hämta listan över modeller

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

Parametrar

dependeciesFor

string[]

Modell-ID:t för att hämta beroenden. Om de utelämnas hämtas alla modeller.

includeModelDefinition

boolean

Om modelldefinitionen ska inkluderas i resultatet. Om det är falskt returneras endast modellmetadata.

resultsPerPage

number

Det maximala antalet objekt som ska hämtas per begäran. Servern kan välja att returnera mindre än det begärda maxvärdet.

options

OperationOptions & PageSettings

Returer

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

En växlingsbar uppsättning application/json-modeller och http-svaret.

listRelationships(string, OperationOptions & PageSettings)

Hämta relationer för en digital tvilling.

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

Parametrar

digitalTwinId

string

ID för den digitala tvillingen.

options

OperationOptions & PageSettings

Returer

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

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

Publicera telemetri från en digital tvillings komponent, som sedan används av en eller flera målslutpunkter (prenumeranter) som definierats under.

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

Parametrar

digitalTwinId

string

ID för den digitala tvilling som ska tas bort.

componentName

string

Namnet på DTDL-komponenten.

payload

string

Den program-/json-telemetrinyttolast som ska skickas.

messageId

string

Meddelande-ID:t.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<RestResponse>

HTTP-svaret.

publishTelemetry(string, any, string, OperationOptions)

Publicera telemetri från en digital tvilling, som sedan används av en eller flera målslutpunkter (prenumeranter) som definierats under.

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

Parametrar

digitalTwinId

string

ID för den digitala tvilling som ska tas bort.

payload

any

Den program-/json-telemetrinyttolast som ska skickas.

messageId

string

Meddelande-ID:t.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<RestResponse>

HTTP-svaret.

queryTwins(string, number, OperationOptions & PageSettings)

Fråga efter digitala tvillingar.

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

Parametrar

query

string

Frågesträngen i SQL-liknande syntax.

resultsPerPage

number

Det maximala antalet objekt som ska hämtas per begäran. Servern kan välja att returnera mindre än det begärda maxvärdet.

options

OperationOptions & PageSettings

Returer

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

Den växlingsbara listan med frågeresultat.

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

Uppdatera egenskaper för en komponent på en digital tvilling med hjälp av en JSON-korrigering.

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

Parametrar

digitalTwinId

string

ID för den digitala tvillingen.

componentName

string

Komponenten som uppdateras.

jsonPatch

any[]

De program-/json-patch+json-åtgärder som ska utföras på den angivna digitala tvillingens komponent.

options

DigitalTwinsUpdateComponentOptionalParams

Alternativ för utökad åtgärd, inklusive ifMatch: Utför endast åtgärden om entitetens etag matchar en av de angivna etags eller * har angetts.

Returer

Promise<DigitalTwinsUpdateComponentResponse>

HTTP-svaret.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

Uppdatera en digital tvilling med hjälp av en json-korrigering.

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

Parametrar

digitalTwinId

string

ID för den digitala tvillingen.

jsonPatch

any

En uppdateringsspecifikation som beskrivs av JSON Patch. Uppdateringar till egenskapsvärden och $model element kan inträffa i samma begäran. Åtgärderna är begränsade till att lägga till, ersätta och ta bort.

options

DigitalTwinsUpdateOptionalParams

Alternativ för utökad åtgärd, inklusive ifMatch: Utför endast åtgärden om entitetens etag matchar en av de angivna etags eller * har angetts.

Returer

Promise<DigitalTwinsUpdateResponse>

HTTP-svaret.

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

Uppdateringar egenskaperna för en relation på en digital tvilling med hjälp av en JSON-korrigering.

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

Parametrar

digitalTwinId

string

ID för den digitala tvilling som ska tas bort.

relationshipId

string

ID för relationen som ska uppdateras.

jsonPatch

any[]

De program-/json-patch+json-åtgärder som ska utföras på den angivna digitala tvillingens relation.

options

DigitalTwinsUpdateRelationshipOptionalParams

Alternativ för utökad åtgärd ifMatch: Utför endast åtgärden om entitetens etag matchar en av de angivna etags eller * har angetts.

Returer

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Skapa eller uppdatera en digital tvilling

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

Parametrar

digitalTwinId

string

ID:t för den digitala tvillingen som ska skapas eller uppdateras.

digitalTwinJson

string

Den digitala tvillingen application/json som ska skapas.

options

DigitalTwinsAddOptionalParams

Alternativ för utökad åtgärd, inklusive ifNoneMatch: Utför endast åtgärden om entiteten inte redan finns.

Returer

Promise<DigitalTwinsAddResponse>

Den skapade digitala tvillingen application/json och http-svaret.

upsertEventRoute(string, string, string, OperationOptions)

Skapa eller uppdatera en händelseväg.

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

Parametrar

eventRouteId

string

ID för händelsevägen för att skapa eller uppdatera.

endpointId

string

ID:t för den slutpunkt som den här händelsevägen är bunden till.

filter

string

Ett uttryck som beskriver de händelser som dirigeras till slutpunkten.

options

OperationOptions

Åtgärdsalternativen

Returer

Promise<RestResponse>

HTTP-svaret.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

Skapa eller uppdatera en relation på en digital tvilling.

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

Parametrar

digitalTwinId

string

ID för den digitala källtvillingen.

relationshipId

string

ID för relationen som ska skapas.

relationship

any

Den program-/json-relation som ska skapas.

options

DigitalTwinsAddRelationshipOptionalParams

Alternativ för utökad åtgärd, inklusive ifNoneMatch: Utför endast åtgärden om entiteten inte redan finns.

Returer

Promise<DigitalTwinsAddRelationshipResponse>