DigitalTwinsClient class

Crée une instance d’AzureDigitalTwinsAPI.

Exemple d’utilisation :

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)

Paramètres

Créer un ou plusieurs

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

Paramètres

Retours

Les modèles application/json créés.

Désaffectez un modèle à l’aide d’un correctif json. Lorsqu’un modèle est désactivé, de nouveaux jumeaux numériques ne pourront plus être définis par ce modèle. Toutefois, les jumeaux numériques existants peuvent continuer à utiliser ce modèle. Une fois qu’un modèle est désactivé, il se peut qu’il ne soit pas réaffecté.

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

Paramètres

Retours

Supprimer un jumeau numérique

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

Paramètres

Retours

Supprimez un itinéraire d’événement.

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

Paramètres

Retours

Supprimez un modèle.

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

Paramètres

Retours

Supprimez une relation sur un jumeau numérique.

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

Paramètres

Retours

Obtenir un composant sur un jumeau numérique.

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

Paramètres

Retours

Représentation sous forme de chaîne JSON du composant correspondant au componentName fourni.

Obtenir un jumeau numérique

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

Paramètres

Retours

Le jumeau numérique application/json.

Obtenir un itinéraire d’événement.

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

Paramètres

Retours

L’itinéraire de l’événement application/json.

Obtenez un modèle, y compris les métadonnées du modèle et la définition du modèle.

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

Paramètres

Retours

Le modèle application/json.

Obtenir une relation sur un jumeau numérique.

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

Paramètres

Retours

Liste paginable des relations application/json appartenant au jumeau numérique spécifié.

Répertoriez les itinéraires d’événements dans une instance de jumeaux numériques.

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

Paramètres

Retours

L’itinéraire de l’événement application/json.

Récupérez toutes les relations entrantes pour un jumeau numérique.

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

Paramètres

Retours

Obtenir la liste des modèles

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

Paramètres

Retours

Un ensemble paginable de modèles application/json.

Récupérer des relations pour un jumeau numérique.

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

Paramètres

Retours

Publiez les données de télémétrie à partir du composant d’un jumeau numérique, qui est ensuite consommé par un ou plusieurs points de terminaison de destination (abonnés) définis sous.

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

Paramètres

Retours

Publiez les données de télémétrie à partir d’un jumeau numérique, qui est ensuite consommée par un ou plusieurs points de terminaison de destination (abonnés) définis sous.

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

Paramètres

Retours

Rechercher des jumeaux numériques.

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

Paramètres

Retours

Liste paginable des résultats de la requête.

Mettez à jour les propriétés d’un composant sur un jumeau numérique à l’aide d’un correctif JSON.

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

Paramètres

Retours

Mettez à jour un jumeau numérique à l’aide d’un correctif json.

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

Paramètres

Retours

Met à jour les propriétés d’une relation sur un jumeau numérique à l’aide d’un correctif JSON.

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

Paramètres

Retours

Créer ou mettre à jour un jumeau numérique

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

Paramètres

Retours

L’application/jumeau numérique json créé.

Créez ou mettez à jour un itinéraire d’événement.

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

Paramètres

Retours

Créez ou mettez à jour une relation sur un jumeau numérique.

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

Paramètres

Retours