DigitalTwinsClient class

Creates an instance of AzureDigitalTwinsAPI.

Example usage:

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

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

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

Parameters

Create one or many

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

Parameters

Returns

The created application/json models and the http response.

Decommission a model using a json patch. When a model is decommissioned, new digital twins will no longer be able to be defined by this model. However, existing digital twins may continue to use this model. Once a model is decommissioned, it may not be recommissioned.

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

Parameters

Returns

The http response.

Delete a digital twin

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

Parameters

Returns

The http response.

Delete an event route.

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

Parameters

Returns

The http response.

Delete a model.

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

Parameters

Returns

The http response.

Delete a relationship on a digital twin.

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

Parameters

Returns

The http response.

Get a component on a digital twin.

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

Parameters

Returns

Json string representation of the component corresponding to the provided componentName and the HTTP response.

Get a digital twin

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

Parameters

Returns

The application/json digital twin and the http response.

Get an event route.

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

Parameters

Returns

The application/json event route and the http response.

Get a model, including the model metadata and the model definition.

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

Parameters

Returns

The application/json model and the http response.

Get a relationship on a digital twin.

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

Parameters

Returns

The pageable list of application/json relationships belonging to the specified digital twin and the http response.

List the event routes in a digital twins instance.

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

Parameters

Returns

The application/json event route and the http response.

Retrieve all incoming relationships for a digital twin.

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

Parameters

Returns

Get the list of models

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

Parameters

Returns

A pageable set of application/json models and the http response.

Retrieve relationships for a digital twin.

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

Parameters

Returns

Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under.

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

Parameters

Returns

The http response.

Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under.

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

Parameters

Returns

The http response.

Query for digital twins.

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

Parameters

Returns

The pageable list of query results.

Update properties of a component on a digital twin using a JSON patch.

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

Parameters

Returns

The http response.

Update a digital twin using a json patch.

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

Parameters

Returns

The http response.

Updates the properties of a relationship on a digital twin using a JSON patch.

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

Parameters

Returns

Create or update a digital twin

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

Parameters

Returns

The created application/json digital twin and the http response.

Create or update an event route.

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

Parameters

Returns

The http response.

Create or update a relationship on a digital twin.

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

Parameters

Returns