DigitalTwinsClient class

Paquet:

@azure/digital-twins-core

Client pour l’API Azure IoT DigitalTwins.

Constructeurs

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Crée une instance d’AzureDigitalTwinsAPI. Exemple d’utilisation : const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

Méthodes

createModels(any[], OperationOptions)	Créer un ou plusieurs
decomissionModel(string, OperationOptions)	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é.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Supprimer un jumeau numérique
deleteEventRoute(string, OperationOptions)	Supprimez un itinéraire d’événement.
deleteModel(string, OperationOptions)	Supprimez un modèle.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Supprimez une relation sur un jumeau numérique.
getComponent(string, string, OperationOptions)	Obtenir un composant sur un jumeau numérique.
getDigitalTwin(string, OperationOptions)	Obtenir un jumeau numérique
getEventRoute(string, OperationOptions)	Obtenir un itinéraire d’événement.
getModel(string, boolean, OperationOptions)	Obtenez un modèle, y compris les métadonnées du modèle et la définition du modèle.
getRelationship(string, string, OperationOptions)	Obtenir une relation sur un jumeau numérique.
listEventRoutes(number, OperationOptions & PageSettings)	Répertoriez les itinéraires d’événements dans une instance de jumeaux numériques.
listIncomingRelationships(string, OperationOptions & PageSettings)	Récupérez toutes les relations entrantes pour un jumeau numérique.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Obtenir la liste des modèles
listRelationships(string, OperationOptions & PageSettings)	Récupérer des relations pour un jumeau numérique.
publishComponentTelemetry(string, string, string, string, OperationOptions)	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.
publishTelemetry(string, any, string, OperationOptions)	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.
queryTwins(string, number, OperationOptions & PageSettings)	Rechercher des jumeaux numériques.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Mettez à jour les propriétés d’un composant sur un jumeau numérique à l’aide d’un correctif JSON.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Mettez à jour un jumeau numérique à l’aide d’un correctif json.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Met à jour les propriétés d’une relation sur un jumeau numérique à l’aide d’un correctif JSON.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Créer ou mettre à jour un jumeau numérique
upsertEventRoute(string, string, string, OperationOptions)	Créez ou mettez à jour un itinéraire d’événement.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	Créez ou mettez à jour une relation sur un jumeau numérique.

Détails du constructeur

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Crée une instance d’AzureDigitalTwinsAPI.

Exemple d’utilisation :

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

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

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

Paramètres

endpointUrl

string

URL du point de terminaison du service.

credential

TokenCredential

Utilisé pour authentifier les demandes auprès du service.

options

DigitalTwinsClientOptions

Utilisé pour configurer le client de service.

Détails de la méthode

createModels(any[], OperationOptions)

Créer un ou plusieurs

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

Paramètres

dtdlModels

any[]

options

OperationOptions

Options d’opération

Retours

Promise<DigitalTwinModelsAddResponse>

Modèles d’application/json créés et réponse http.

decomissionModel(string, OperationOptions)

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<RestResponse>

Paramètres

modelId

string

ID du modèle à désactiver. la propriété peut être remplacée.

options

OperationOptions

Options d’opération

Retours

Promise<RestResponse>

Réponse http.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Supprimer un jumeau numérique

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

Paramètres

digitalTwinId

string

ID du jumeau numérique à supprimer.

options

DigitalTwinsDeleteOptionalParams

Options d’opération étendues, notamment ifMatch : effectuez uniquement l’opération si l’etag de l’entité correspond à l’un des etags fournis ou * est fourni.

Retours

Promise<RestResponse>

Réponse http.

deleteEventRoute(string, OperationOptions)

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

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

Paramètres

eventRouteId

string

ID de l’eventRoute à supprimer.

options

OperationOptions

Options d’opération

Retours

Promise<RestResponse>

Réponse http.

deleteModel(string, OperationOptions)

Supprimez un modèle.

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

Paramètres

modelId

string

ID du modèle à supprimer.

options

OperationOptions

Options d’opération

Retours

Promise<RestResponse>

Réponse http.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Supprimez une relation sur un jumeau numérique.

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

Paramètres

digitalTwinId

string

ID du jumeau numérique source.

relationshipId

string

ID de la relation à supprimer.

options

DigitalTwinsDeleteRelationshipOptionalParams

Options d’opération ifMatch : effectuez uniquement l’opération si l’etag de l’entité correspond à l’un des etags fournis ou * est

Retours

Promise<RestResponse>

Réponse http.

getComponent(string, string, OperationOptions)

Obtenir un composant sur un jumeau numérique.

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

Paramètres

digitalTwinId

string

ID du jumeau numérique.

componentName

string

Composant récupéré.

options

OperationOptions

Options d’opération

Retours

Promise<DigitalTwinsGetComponentResponse>

Représentation sous forme de chaîne JSON du composant correspondant au componentName fourni et à la réponse HTTP.

getDigitalTwin(string, OperationOptions)

Obtenir un jumeau numérique

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

Paramètres

digitalTwinId

string

ID du jumeau numérique.

options

OperationOptions

Options d’opération

Retours

Promise<DigitalTwinsGetByIdResponse>

Jumeau numérique application/json et réponse http.

getEventRoute(string, OperationOptions)

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

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

Paramètres

eventRouteId

string

options

OperationOptions

Options d’opération

Retours

Promise<EventRoutesGetByIdResponse>

Itinéraire d’événement application/json et réponse http.

getModel(string, boolean, OperationOptions)

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

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

Paramètres

modelId

string

ID du modèle.

includeModelDefinition

boolean

options

OperationOptions

Options d’opération étendues, notamment includeModelDefinition : lorsque la valeur true, la définition du modèle est retournée dans le cadre du résultat. Valeur par défaut : false.

Retours

Promise<DigitalTwinModelsGetByIdResponse>

Modèle application/json et réponse http.

getRelationship(string, string, OperationOptions)

Obtenir une relation sur un jumeau numérique.

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

Paramètres

digitalTwinId

string

ID du jumeau numérique source.

relationshipId

string

ID de la relation à récupérer.

options

OperationOptions

Options d’opération

Retours

Promise<DigitalTwinsGetRelationshipByIdResponse>

Liste paginable des relations application/json appartenant au jumeau numérique spécifié et à la réponse http.

listEventRoutes(number, OperationOptions & PageSettings)

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

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

Paramètres

resultsPerPage

number

Nombre maximal d’éléments à récupérer par requête. Le serveur peut choisir de retourner moins que le nombre maximal demandé.

options

OperationOptions & PageSettings

Retours

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

Itinéraire d’événement application/json et réponse http.

listIncomingRelationships(string, OperationOptions & PageSettings)

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

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

Paramètres

digitalTwinId

string

ID du jumeau numérique.

options

OperationOptions & PageSettings

Retours

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

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

Obtenir la liste des modèles

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

Paramètres

dependeciesFor

string[]

ID de modèle à récupérer. S’il est omis, tous les modèles sont récupérés.

includeModelDefinition

boolean

Indique s’il faut inclure la définition du modèle dans le résultat. Si la valeur est false, seules les métadonnées du modèle sont retournées.

resultsPerPage

number

Nombre maximal d’éléments à récupérer par requête. Le serveur peut choisir de retourner moins que le nombre maximal demandé.

options

OperationOptions & PageSettings

Retours

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

Ensemble paginable de modèles application/json et de la réponse http.

listRelationships(string, OperationOptions & PageSettings)

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

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

Paramètres

digitalTwinId

string

ID du jumeau numérique.

options

OperationOptions & PageSettings

Retours

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

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

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: string, messageId: string, options?: OperationOptions): Promise<RestResponse>

Paramètres

digitalTwinId

string

ID du jumeau numérique à supprimer.

componentName

string

Nom du composant DTDL.

payload

string

Charge utile de télémétrie application/json à envoyer.

messageId

string

ID du message.

options

OperationOptions

Options d’opération

Retours

Promise<RestResponse>

Réponse http.

publishTelemetry(string, any, string, OperationOptions)

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: any, messageId: string, options?: OperationOptions): Promise<RestResponse>

Paramètres

digitalTwinId

string

ID du jumeau numérique à supprimer.

payload

any

Charge utile de télémétrie application/json à envoyer.

messageId

string

ID du message.

options

OperationOptions

Options d’opération

Retours

Promise<RestResponse>

Réponse http.

queryTwins(string, number, OperationOptions & PageSettings)

Rechercher des jumeaux numériques.

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

Paramètres

query

string

Chaîne de requête, dans la syntaxe de type SQL.

resultsPerPage

number

Nombre maximal d’éléments à récupérer par requête. Le serveur peut choisir de retourner moins que le nombre maximal demandé.

options

OperationOptions & PageSettings

Retours

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

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

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

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: any[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>

Paramètres

digitalTwinId

string

ID du jumeau numérique.

componentName

string

Composant mis à jour.

jsonPatch

any[]

Opérations application/json-patch+json à effectuer sur le composant du jumeau numérique spécifié.

options

DigitalTwinsUpdateComponentOptionalParams

Options d’opération étendues, notamment ifMatch : effectuez uniquement l’opération si l’etag de l’entité correspond à l’un des etags fournis ou * est fourni.

Retours

Promise<DigitalTwinsUpdateComponentResponse>

Réponse http.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

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

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

Paramètres

digitalTwinId

string

ID du jumeau numérique.

jsonPatch

any

Spécification de mise à jour décrite par JSON Patch. Les mises à jour apportées aux valeurs de propriété et $model éléments peuvent se produire dans la même requête. Les opérations sont limitées à l’ajout, au remplacement et à la suppression.

options

DigitalTwinsUpdateOptionalParams

Options d’opération étendues, notamment ifMatch : effectuez uniquement l’opération si l’etag de l’entité correspond à l’un des etags fournis ou * est fourni.

Retours

Promise<DigitalTwinsUpdateResponse>

Réponse http.

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

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: any[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipResponse>

Paramètres

digitalTwinId

string

ID du jumeau numérique à supprimer.

relationshipId

string

ID de la relation à mettre à jour.

jsonPatch

any[]

Opérations application/json-patch+json à effectuer sur la relation du jumeau numérique spécifié.

options

DigitalTwinsUpdateRelationshipOptionalParams

Options d’opération étendues ifMatch : effectuez uniquement l’opération si l’etag de l’entité correspond à l’un des etags fournis ou * est fourni.

Retours

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

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

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

Paramètres

digitalTwinId

string

ID du jumeau numérique à créer ou à mettre à jour.

digitalTwinJson

string

Jumeau numérique application/json à créer.

options

DigitalTwinsAddOptionalParams

Options d’opération étendues, notamment ifNoneMatch : effectuez uniquement l’opération si l’entité n’existe pas déjà.

Retours

Promise<DigitalTwinsAddResponse>

Jumeau numérique d’application/json créé et réponse http.

upsertEventRoute(string, string, string, OperationOptions)

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

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

Paramètres

eventRouteId

string

ID de l’itinéraire d’événement à créer ou à mettre à jour.

endpointId

string

L’ID du point de terminaison à lequel cet itinéraire d’événements est lié.

filter

string

Expression qui décrit les événements qui sont routés vers le point de terminaison.

options

OperationOptions

Options d’opération

Retours

Promise<RestResponse>

Réponse http.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

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

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

Paramètres

digitalTwinId

string

ID du jumeau numérique source.

relationshipId

string

ID de la relation à créer.

relationship

any

Relation application/json à créer.

options

DigitalTwinsAddRelationshipOptionalParams

Options d’opération étendues, notamment ifNoneMatch : effectuez uniquement l’opération si l’entité n’existe pas déjà.

Retours

Promise<DigitalTwinsAddRelationshipResponse>