DigitalTwinsClient class
Client voor Azure IoT DigitalTwins-API.
Constructors
| Digital |
Hiermee maakt u een exemplaar van AzureDigitalTwinsAPI. Voorbeeldgebruik: |
Methoden
| create |
Een of meer maken |
| decomission |
Een model uit bedrijf nemen met behulp van een json-patch. Wanneer een model buiten gebruik wordt gesteld, kunnen nieuwe digitale dubbels niet meer worden gedefinieerd door dit model. Bestaande digitale dubbels kunnen dit model echter blijven gebruiken. Zodra een model buiten gebruik is gesteld, wordt het mogelijk niet opnieuw toegewezen. |
| delete |
Een digitale dubbel verwijderen |
| delete |
Een gebeurtenisroute verwijderen. |
| delete |
Een model verwijderen. |
| delete |
Een relatie op een digitale dubbel verwijderen. |
| get |
Haal een onderdeel op een digitale dubbel. |
| get |
Een digitale dubbel ophalen |
| get |
Haal een gebeurtenisroute op. |
| get |
Haal een model op, inclusief de metagegevens van het model en de modeldefinitie. |
| get |
Krijg een relatie op een digitale dubbel. |
| list |
Geef de gebeurtenisroutes weer in een exemplaar van digitale dubbels. |
| list |
Haal alle binnenkomende relaties voor een digitale dubbel op. |
| list |
De lijst met modellen ophalen |
| list |
Relaties voor een digitale dubbel ophalen. |
| publish |
Publiceer telemetrie van het onderdeel van een digitale dubbel, dat vervolgens wordt gebruikt door een of meer doeleindpunten (abonnees) die zijn gedefinieerd onder. |
| publish |
Publiceer telemetrie van een digitale dubbel, die vervolgens wordt gebruikt door een of meer doeleindpunten (abonnees) die zijn gedefinieerd onder. |
| query |
Query's uitvoeren op digitale dubbels. |
| update |
Werk eigenschappen van een onderdeel op een digitale dubbel bij met behulp van een JSON-patch. |
| update |
Een digitale dubbel bijwerken met behulp van een json-patch. |
| update |
Werkt de eigenschappen van een relatie op een digitale dubbel bij met behulp van een JSON-patch. |
| upsert |
Een digitale dubbel maken of bijwerken |
| upsert |
Een gebeurtenisroute maken of bijwerken. |
| upsert |
Een relatie op een digitale dubbel maken of bijwerken. |
Constructordetails
DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)
Hiermee maakt u een exemplaar van AzureDigitalTwinsAPI.
Voorbeeldgebruik:
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)Parameters
- endpointUrl
-
string
De eindpunt-URL van de service.
- credential
- TokenCredential
Wordt gebruikt voor het verifiëren van aanvragen voor de service.
- options
- DigitalTwinsClientOptions
Wordt gebruikt om de serviceclient te configureren.
Methodedetails
createModels(Record<string, unknown>[], OperationOptions)
Een of meer maken
function createModels(dtdlModels: Record<string, unknown>[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>Parameters
- dtdlModels
-
Record<string, unknown>[]
De set modellen om te maken. Elke string komt overeen met precies één model.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<DigitalTwinModelsAddResponse>
De gemaakte applicatie/json-modellen.
decomissionModel(string, OperationOptions)
Een model uit bedrijf nemen met behulp van een json-patch. Wanneer een model buiten gebruik wordt gesteld, kunnen nieuwe digitale dubbels niet meer worden gedefinieerd door dit model. Bestaande digitale dubbels kunnen dit model echter blijven gebruiken. Zodra een model buiten gebruik is gesteld, wordt het mogelijk niet opnieuw toegewezen.
function decomissionModel(modelId: string, options?: OperationOptions): Promise<void>Parameters
- modelId
-
string
De id van het model dat moet worden uit bedrijf genomen. de eigenschap kan worden vervangen.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<void>
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)
Een digitale dubbel verwijderen
function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<void>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel die moet worden verwijderd.
- options
- DigitalTwinsDeleteOptionalParams
Uitgebreide bewerkingsopties, waaronder ifMatch: voer de bewerking alleen uit als de etag van de entiteit overeenkomt met een van de opgegeven etags of *.
Retouren
Promise<void>
deleteEventRoute(string, OperationOptions)
Een gebeurtenisroute verwijderen.
function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<void>Parameters
- eventRouteId
-
string
De id van de eventRoute die u wilt verwijderen.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<void>
deleteModel(string, OperationOptions)
Een model verwijderen.
function deleteModel(modelId: string, options?: OperationOptions): Promise<void>Parameters
- modelId
-
string
De id van het model dat moet worden verwijderd.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<void>
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)
Een relatie op een digitale dubbel verwijderen.
function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<void>Parameters
- digitalTwinId
-
string
De id van de digitale brondubbel.
- relationshipId
-
string
De id van de relatie die moet worden verwijderd.
De bewerkingsopties ifMatch: voer de bewerking alleen uit als de etag van de entiteit overeenkomt met een van de opgegeven etags of * is
Retouren
Promise<void>
getComponent(string, string, OperationOptions)
Haal een onderdeel op een digitale dubbel.
function getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel.
- componentName
-
string
Het onderdeel wordt opgehaald.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<DigitalTwinsGetComponentResponse>
Json-tekenreeksweergave van de component die overeenkomt met de opgegeven componentName.
getDigitalTwin(string, OperationOptions)
Een digitale dubbel ophalen
function getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<DigitalTwinsGetByIdResponse>
De digitale tweeling van de applicatie/json.
getEventRoute(string, OperationOptions)
Haal een gebeurtenisroute op.
function getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoute>Parameters
- eventRouteId
-
string
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<EventRoute>
De applicatie/json event route.
getModel(string, DigitalTwinModelsGetByIdOptionalParams)
Haal een model op, inclusief de metagegevens van het model en de modeldefinitie.
function getModel(modelId: string, options?: DigitalTwinModelsGetByIdOptionalParams): Promise<DigitalTwinsModelData>Parameters
- modelId
-
string
De id van het model.
- options
- GetModelOptions
Opties voor deze bewerking
Retouren
Promise<DigitalTwinsModelData>
Het applicatie/json-model.
getRelationship(string, string, OperationOptions)
Krijg een relatie op een digitale dubbel.
function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>Parameters
- digitalTwinId
-
string
De id van de digitale brondubbel.
- relationshipId
-
string
De id van de relatie die moet worden opgehaald.
- options
- OperationOptions
De bewerkingsopties
Retouren
De bladerbare lijst met applicatie/json-relaties die behoren tot de opgegeven digitale tweeling.
listEventRoutes(EventRoutesListOptionalParams)
Geef de gebeurtenisroutes weer in een exemplaar van digitale dubbels.
function listEventRoutes(options?: EventRoutesListOptionalParams): PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>Parameters
- options
- ListEventRoutesOptions
Opties voor listEventRoutes.
Retouren
De applicatie/json event route.
listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)
Haal alle binnenkomende relaties voor een digitale dubbel op.
function listIncomingRelationships(digitalTwinId: string, options?: DigitalTwinsListIncomingRelationshipsOptionalParams): PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel.
- options
- ListIncomingRelationshipsOptions
Retouren
listModels(DigitalTwinModelsListOptionalParams)
De lijst met modellen ophalen
function listModels(options?: DigitalTwinModelsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>Parameters
- options
- ListModelsOptions
Opties voor het weergeven van modellen.
Retouren
Een pagebare set applicatie/json-modellen.
listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)
Relaties voor een digitale dubbel ophalen.
function listRelationships(digitalTwinId: string, options?: DigitalTwinsListRelationshipsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel.
- options
- ListRelationshipsOptions
Retouren
PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>
publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)
Publiceer telemetrie van het onderdeel van een digitale dubbel, dat vervolgens wordt gebruikt door een of meer doeleindpunten (abonnees) die zijn gedefinieerd onder.
function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel die moet worden verwijderd.
- componentName
-
string
De naam van het DTDL-onderdeel.
- payload
-
Record<string, unknown>
De nettolading van de toepassing/json-telemetrie die moet worden verzonden.
- messageId
-
string
De bericht-id.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<void>
publishTelemetry(string, Record<string, unknown>, string, OperationOptions)
Publiceer telemetrie van een digitale dubbel, die vervolgens wordt gebruikt door een of meer doeleindpunten (abonnees) die zijn gedefinieerd onder.
function publishTelemetry(digitalTwinId: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel die moet worden verwijderd.
- payload
-
Record<string, unknown>
De nettolading van de toepassing/json-telemetrie die moet worden verzonden.
- messageId
-
string
De bericht-id.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<void>
queryTwins(string, QueryQueryTwinsOptionalParams)
Query's uitvoeren op digitale dubbels.
function queryTwins(query: string, options?: QueryQueryTwinsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>Parameters
- query
-
string
De querytekenreeks, in sql-achtige syntaxis.
- options
- QueryTwinsOptions
Opties voor de querybewerking.
Retouren
PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>
De paginabare lijst met queryresultaten.
updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)
Werk eigenschappen van een onderdeel op een digitale dubbel bij met behulp van een JSON-patch.
function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentHeaders>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel.
- componentName
-
string
Het onderdeel dat wordt bijgewerkt.
- jsonPatch
-
Record<string, unknown>[]
De toepassings-/json-patch+json-bewerkingen die moeten worden uitgevoerd op het opgegeven onderdeel van de digitale dubbel.
Uitgebreide bewerkingsopties, waaronder ifMatch: voer de bewerking alleen uit als de etag van de entiteit overeenkomt met een van de opgegeven etags of *.
Retouren
Promise<DigitalTwinsUpdateComponentHeaders>
updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)
Een digitale dubbel bijwerken met behulp van een json-patch.
function updateDigitalTwin(digitalTwinId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateHeaders>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel.
- jsonPatch
-
Record<string, unknown>[]
Een updatespecificatie die wordt beschreven door JSON Patch. Updates voor eigenschapswaarden en $model elementen kunnen plaatsvinden in dezelfde aanvraag. Bewerkingen zijn beperkt tot toevoegen, vervangen en verwijderen.
- options
- DigitalTwinsUpdateOptionalParams
Uitgebreide bewerkingsopties, waaronder ifMatch: voer de bewerking alleen uit als de etag van de entiteit overeenkomt met een van de opgegeven etags of *.
Retouren
Promise<DigitalTwinsUpdateHeaders>
updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)
Werkt de eigenschappen van een relatie op een digitale dubbel bij met behulp van een JSON-patch.
function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipHeaders>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel die moet worden verwijderd.
- relationshipId
-
string
De id van de relatie die moet worden bijgewerkt.
- jsonPatch
-
Record<string, unknown>[]
De toepassings-/json-patch+json-bewerkingen die moeten worden uitgevoerd op de opgegeven relatie van de digitale dubbel.
Uitgebreide bewerkingsopties ifMatch: voer de bewerking alleen uit als de etag van de entiteit overeenkomt met een van de opgegeven etags of *.
Retouren
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)
Een digitale dubbel maken of bijwerken
function upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: DigitalTwinsAddOptionalParams): Promise<DigitalTwinsAddResponse>Parameters
- digitalTwinId
-
string
De id van de digitale dubbel die moet worden gemaakt of bijgewerkt.
- digitalTwinJson
-
string
De digitale dubbel van de toepassing/json die moet worden gemaakt.
- options
- DigitalTwinsAddOptionalParams
Uitgebreide bewerkingsopties, waaronder ifNoneMatch: voer de bewerking alleen uit als de entiteit nog niet bestaat.
Retouren
Promise<DigitalTwinsAddResponse>
De gemaakte applicatie/json digitale tweeling.
upsertEventRoute(string, string, string, OperationOptions)
Een gebeurtenisroute maken of bijwerken.
function upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<void>Parameters
- eventRouteId
-
string
De id van de gebeurtenisroute die moet worden gemaakt of bijgewerkt.
- endpointId
-
string
De id van het eindpunt waaraan deze gebeurtenisroute is gebonden.
- filter
-
string
Een expressie die de gebeurtenissen beschrijft die naar het eindpunt worden gerouteerd.
- options
- OperationOptions
De bewerkingsopties
Retouren
Promise<void>
upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)
Een relatie op een digitale dubbel maken of bijwerken.
function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: Record<string, unknown>, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>Parameters
- digitalTwinId
-
string
De id van de digitale brondubbel.
- relationshipId
-
string
De id van de relatie die moet worden gemaakt.
- relationship
-
Record<string, unknown>
De toepassings-/json-relatie die moet worden gemaakt.
Uitgebreide bewerkingsopties, waaronder ifNoneMatch: voer de bewerking alleen uit als de entiteit nog niet bestaat.
Retouren
Promise<DigitalTwinsAddRelationshipResponse>