DigitalTwinsClient class

Balíček:

@azure/digital-twins-core

Klient pro rozhraní API Azure IoT DigitalTwins

Konstruktory

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Vytvoří instanci AzureDigitalTwinsAPI. Příklad použití: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

Metody

createModels(any[], OperationOptions)	Vytvoření jednoho nebo několika
decomissionModel(string, OperationOptions)	Vyřazení modelu z provozu pomocí opravy JSON Když se model vyřadí z provozu, nebudou už moci být novými digitálními dvojčaty definovány tímto modelem. Stávající digitální dvojčata však mohou tento model nadále používat. Jakmile se model vyřadí z provozu, nemusí se znovu překompisovat.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Odstranění digitálního dvojčete
deleteEventRoute(string, OperationOptions)	Odstraňte trasu události.
deleteModel(string, OperationOptions)	Odstraňte model.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Odstranění relace u digitálního dvojčete
getComponent(string, string, OperationOptions)	Získejte součást digitálního dvojčete.
getDigitalTwin(string, OperationOptions)	Získání digitálního dvojčete
getEventRoute(string, OperationOptions)	Získejte trasu události.
getModel(string, boolean, OperationOptions)	Získejte model, včetně metadat modelu a definice modelu.
getRelationship(string, string, OperationOptions)	Získejte vztah k digitálnímu dvojčeti.
listEventRoutes(number, OperationOptions & PageSettings)	Vypište trasy událostí v instanci digitálních dvojčat.
listIncomingRelationships(string, OperationOptions & PageSettings)	Načtěte všechny příchozí relace pro digitální dvojče.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Získání seznamu modelů
listRelationships(string, OperationOptions & PageSettings)	Načtení relací pro digitální dvojče.
publishComponentTelemetry(string, string, string, string, OperationOptions)	Publikujte telemetrii ze komponenty digitálního dvojčete, která se pak spotřebovává jedním nebo mnoha cílovými koncovými body (odběrateli) definovanými v části.
publishTelemetry(string, any, string, OperationOptions)	Publikujte telemetrii z digitálního dvojčete, které pak využívá jeden nebo mnoho cílových koncových bodů (odběratelů) definovaných v rámci.
queryTwins(string, number, OperationOptions & PageSettings)	Dotaz na digitální dvojčata
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Aktualizujte vlastnosti komponenty v digitálním dvojčeti pomocí opravy JSON.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Aktualizujte digitální dvojče pomocí opravy JSON.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Aktualizuje vlastnosti relace u digitálního dvojčete pomocí opravy JSON.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Vytvoření nebo aktualizace digitálního dvojčete
upsertEventRoute(string, string, string, OperationOptions)	Vytvořte nebo aktualizujte trasu události.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	Vytvořte nebo aktualizujte relaci u digitálního dvojčete.

Podrobnosti konstruktoru

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Vytvoří instanci AzureDigitalTwinsAPI.

Příklad použití:

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

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

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

Parametry

endpointUrl

string

Adresa URL koncového bodu služby.

credential

TokenCredential

Používá se k ověřování požadavků na službu.

options

DigitalTwinsClientOptions

Slouží ke konfiguraci klienta služby.

Podrobnosti metody

createModels(any[], OperationOptions)

Vytvoření jednoho nebo několika

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

Parametry

dtdlModels

any[]

options

OperationOptions

Možnosti operace

Návraty

Promise<DigitalTwinModelsAddResponse>

Vytvořené modely application/json a odpověď HTTP.

decomissionModel(string, OperationOptions)

Vyřazení modelu z provozu pomocí opravy JSON Když se model vyřadí z provozu, nebudou už moci být novými digitálními dvojčaty definovány tímto modelem. Stávající digitální dvojčata však mohou tento model nadále používat. Jakmile se model vyřadí z provozu, nemusí se znovu překompisovat.

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

Parametry

modelId

string

ID modelu, který se má vyřadit z provozu. vlastnost lze nahradit.

options

OperationOptions

Možnosti operace

Návraty

Promise<RestResponse>

Odpověď HTTP.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Odstranění digitálního dvojčete

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

Parametry

digitalTwinId

string

ID digitálního dvojčete, které chcete odstranit.

options

DigitalTwinsDeleteOptionalParams

Rozšířené možnosti operace, včetně ifMatch: Proveďte operaci pouze v případě, že etag entity odpovídá některé ze zadaných značek nebo * je k dispozici.

Návraty

Promise<RestResponse>

Odpověď HTTP.

deleteEventRoute(string, OperationOptions)

Odstraňte trasu události.

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

Parametry

eventRouteId

string

ID událostiRoute, která se má odstranit.

options

OperationOptions

Možnosti operace

Návraty

Promise<RestResponse>

Odpověď HTTP.

deleteModel(string, OperationOptions)

Odstraňte model.

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

Parametry

modelId

string

ID modelu, který chcete odstranit.

options

OperationOptions

Možnosti operace

Návraty

Promise<RestResponse>

Odpověď HTTP.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Odstranění relace u digitálního dvojčete

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

Parametry

digitalTwinId

string

ID zdrojového digitálního dvojčete.

relationshipId

string

ID relace, která se má odstranit.

options

DigitalTwinsDeleteRelationshipOptionalParams

Možnosti operace ifMatch: Proveďte operaci pouze v případě, že etag entity odpovídá některé ze zadaných značek nebo * je

Návraty

Promise<RestResponse>

Odpověď HTTP.

getComponent(string, string, OperationOptions)

Získejte součást digitálního dvojčete.

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

Parametry

digitalTwinId

string

ID digitálního dvojčete.

componentName

string

Načítá se komponenta.

options

OperationOptions

Možnosti operace

Návraty

Promise<DigitalTwinsGetComponentResponse>

Řetězcová reprezentace komponenty json odpovídající zadanému názvu komponenty a odpovědi HTTP.

getDigitalTwin(string, OperationOptions)

Získání digitálního dvojčete

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

Parametry

digitalTwinId

string

ID digitálního dvojčete.

options

OperationOptions

Možnosti operace

Návraty

Promise<DigitalTwinsGetByIdResponse>

Digitální dvojče application/json a odpověď HTTP.

getEventRoute(string, OperationOptions)

Získejte trasu události.

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

Parametry

eventRouteId

string

options

OperationOptions

Možnosti operace

Návraty

Promise<EventRoutesGetByIdResponse>

Trasa události application/json a odpověď HTTP.

getModel(string, boolean, OperationOptions)

Získejte model, včetně metadat modelu a definice modelu.

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

Parametry

modelId

string

ID modelu.

includeModelDefinition

boolean

options

OperationOptions

Rozšířené možnosti operace, včetně includeModelDefinition: Pokud je true definice modelu bude vrácena jako součást výsledku. Výchozí hodnota: false.

Návraty

Promise<DigitalTwinModelsGetByIdResponse>

Model application/json a odpověď HTTP.

getRelationship(string, string, OperationOptions)

Získejte vztah k digitálnímu dvojčeti.

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

Parametry

digitalTwinId

string

ID zdrojového digitálního dvojčete.

relationshipId

string

ID relace, která se má načíst.

options

OperationOptions

Možnosti operace

Návraty

Promise<DigitalTwinsGetRelationshipByIdResponse>

Stránkovatelný seznam relací application/json patřících zadanému digitálnímu dvojčeti a odpovědi HTTP.

listEventRoutes(number, OperationOptions & PageSettings)

Vypište trasy událostí v instanci digitálních dvojčat.

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

Parametry

resultsPerPage

number

Maximální počet položek, které se mají načíst na požadavek. Server se může rozhodnout vrátit méně, než je požadované maximum.

options

OperationOptions & PageSettings

Návraty

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

Trasa události application/json a odpověď HTTP.

listIncomingRelationships(string, OperationOptions & PageSettings)

Načtěte všechny příchozí relace pro digitální dvojče.

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

Parametry

digitalTwinId

string

ID digitálního dvojčete.

options

OperationOptions & PageSettings

Návraty

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

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

Získání seznamu modelů

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

Parametry

dependeciesFor

string[]

ID modelu, které mají být načteny závislosti. Pokud tento parametr vynecháte, načtou se všechny modely.

includeModelDefinition

boolean

Zda se má do výsledku zahrnout definice modelu. Pokud je false, vrátí se pouze metadata modelu.

resultsPerPage

number

Maximální počet položek, které se mají načíst na požadavek. Server se může rozhodnout vrátit méně, než je požadované maximum.

options

OperationOptions & PageSettings

Návraty

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

Stránkovatelná sada modelů application/json a odpověď HTTP.

listRelationships(string, OperationOptions & PageSettings)

Načtení relací pro digitální dvojče.

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

Parametry

digitalTwinId

string

ID digitálního dvojčete.

options

OperationOptions & PageSettings

Návraty

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

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

Publikujte telemetrii ze komponenty digitálního dvojčete, která se pak spotřebovává jedním nebo mnoha cílovými koncovými body (odběrateli) definovanými v části.

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

Parametry

digitalTwinId

string

ID digitálního dvojčete, které chcete odstranit.

componentName

string

Název komponenty DTDL.

payload

string

Datová část telemetrie application/json, která se má odeslat.

messageId

string

ID zprávy.

options

OperationOptions

Možnosti operace

Návraty

Promise<RestResponse>

Odpověď HTTP.

publishTelemetry(string, any, string, OperationOptions)

Publikujte telemetrii z digitálního dvojčete, které pak využívá jeden nebo mnoho cílových koncových bodů (odběratelů) definovaných v rámci.

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

Parametry

digitalTwinId

string

ID digitálního dvojčete, které chcete odstranit.

payload

any

Datová část telemetrie application/json, která se má odeslat.

messageId

string

ID zprávy.

options

OperationOptions

Možnosti operace

Návraty

Promise<RestResponse>

Odpověď HTTP.

queryTwins(string, number, OperationOptions & PageSettings)

Dotaz na digitální dvojčata

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

Parametry

query

string

Řetězec dotazu v syntaxi podobné JAZYKu SQL.

resultsPerPage

number

Maximální počet položek, které se mají načíst na požadavek. Server se může rozhodnout vrátit méně, než je požadované maximum.

options

OperationOptions & PageSettings

Návraty

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

Stránkovatelný seznam výsledků dotazu.

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

Aktualizujte vlastnosti komponenty v digitálním dvojčeti pomocí opravy JSON.

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

Parametry

digitalTwinId

string

ID digitálního dvojčete.

componentName

string

Komponenta, která se aktualizuje.

jsonPatch

any[]

Operace application/json-patch+json, které se mají provést u zadané komponenty digitálního dvojčete.

options

DigitalTwinsUpdateComponentOptionalParams

Rozšířené možnosti operace, včetně ifMatch: Proveďte operaci pouze v případě, že etag entity odpovídá některé ze zadaných značek nebo * je k dispozici.

Návraty

Promise<DigitalTwinsUpdateComponentResponse>

Odpověď HTTP.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

Aktualizujte digitální dvojče pomocí opravy JSON.

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

Parametry

digitalTwinId

string

ID digitálního dvojčete.

jsonPatch

any

Specifikace aktualizace popsaná opravou JSON. Aktualizace hodnot vlastností a $model elementů můžou nastat ve stejném požadavku. Operace jsou omezené na přidání, nahrazení a odebrání.

options

DigitalTwinsUpdateOptionalParams

Rozšířené možnosti operace, včetně ifMatch: Proveďte operaci pouze v případě, že etag entity odpovídá některé ze zadaných značek nebo * je k dispozici.

Návraty

Promise<DigitalTwinsUpdateResponse>

Odpověď HTTP.

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

Aktualizuje vlastnosti relace u digitálního dvojčete pomocí opravy JSON.

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

Parametry

digitalTwinId

string

ID digitálního dvojčete, které chcete odstranit.

relationshipId

string

ID relace, která se má aktualizovat.

jsonPatch

any[]

Operace application/json-patch+json, které se mají provést u zadané relace digitálního dvojčete.

options

DigitalTwinsUpdateRelationshipOptionalParams

Rozšířené možnosti operace ifMatch: Proveďte operaci pouze v případě, že etag entity odpovídá některé ze zadaných značek nebo * je k dispozici.

Návraty

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Vytvoření nebo aktualizace digitálního dvojčete

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

Parametry

digitalTwinId

string

ID digitálního dvojčete, které se má vytvořit nebo aktualizovat.

digitalTwinJson

string

Vytvoření digitálního dvojčete application/json

options

DigitalTwinsAddOptionalParams

Rozšířené možnosti operace, včetně ifNoneMatch: Proveďte operaci pouze v případě, že entita ještě neexistuje.

Návraty

Promise<DigitalTwinsAddResponse>

Vytvoření digitálního dvojčete application/json a odpovědi HTTP.

upsertEventRoute(string, string, string, OperationOptions)

Vytvořte nebo aktualizujte trasu události.

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

Parametry

eventRouteId

string

ID trasy události, která se má vytvořit nebo aktualizovat.

endpointId

string

ID koncového bodu, ke které je tato trasa události vázána.

filter

string

Výraz, který popisuje události směrované do koncového bodu.

options

OperationOptions

Možnosti operace

Návraty

Promise<RestResponse>

Odpověď HTTP.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

Vytvořte nebo aktualizujte relaci u digitálního dvojčete.

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

Parametry

digitalTwinId

string

ID zdrojového digitálního dvojčete.

relationshipId

string

ID relace, která se má vytvořit.

relationship

any

Relace application/json, která se má vytvořit.

options

DigitalTwinsAddRelationshipOptionalParams

Rozšířené možnosti operace, včetně ifNoneMatch: Proveďte operaci pouze v případě, že entita ještě neexistuje.

Návraty

Promise<DigitalTwinsAddRelationshipResponse>