Package version
Creates an instance of AzureDigitalTwinsAPI.
Example usage:
const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core");
const client = new DigitalTwinsClient(
"<endpoint>",
new DefaultAzureCredential();
);The endpoint URL of the service.
Used to authenticate requests to the service.
Used to configure the service client.
Create one or many
The operation options
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.
The Id of the model to decommission. property can be replaced.
The operation options
The http response.
Delete a digital twin
The Id of the digital twin to delete.
Extended operation options including ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
The http response.
Delete an event route.
The Id of the eventRoute to delete.
The operation options
The http response.
Delete a model.
The Id of the model to delete.
The operation options
The http response.
Delete a relationship on a digital twin.
The Id of the source digital twin.
The Id of the relationship to delete.
The operation options ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is
The http response.
Get a component on a digital twin.
The Id of the digital twin.
The component being retrieved.
The operation options
Json string representation of the component corresponding to the provided componentName and the HTTP response.
Get a digital twin
The Id of the digital twin.
The operation options
The application/json digital twin and the http response.
Get an event route.
The operation options
The application/json event route and the http response.
Get a model, including the model metadata and the model definition.
The Id of the model.
Extended operation options including includeModelDefinition: When true the model definition will be returned as part of the result. Default value: false.
The application/json model and the http response.
Get a relationship on a digital twin.
The Id of the source digital twin.
The Id of the relationship to retrieve.
The operation options
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.
The maximum number of items to retrieve per request. The server may choose to return less than the requested max.
The application/json event route and the http response.
Retrieve all incoming relationships for a digital twin.
The Id of the digital twin.
Get the list of models
The model Ids to have dependencies retrieved. If omitted, all models are retrieved.
Whether to include the model definition in the result. If false, only the model metadata will be returned.
The maximum number of items to retrieve per request. The server may choose to return less than the requested max.
A pageable set of application/json models and the http response.
Retrieve relationships for a digital twin.
The Id of the digital twin.
Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under.
The Id of the digital twin to delete.
The name of the DTDL component.
The application/json telemetry payload to be sent.
The message Id.
The operation options
The http response.
Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under.
The Id of the digital twin to delete.
The application/json telemetry payload to be sent.
The message Id.
The operation options
The http response.
Query for digital twins.
The query string, in SQL-like syntax.
The maximum number of items to retrieve per request. The server may choose to return less than the requested max.
The pageable list of query results.
Update properties of a component on a digital twin using a JSON patch.
The Id of the digital twin.
The component being updated.
The application/json-patch+json operations to be performed on the specified digital twin's component.
Extended operation options including ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
The http response.
Update a digital twin using a json patch.
The Id of the digital twin.
An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove.
Extended operation options including ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
The http response.
Updates the properties of a relationship on a digital twin using a JSON patch.
The Id of the digital twin to delete.
The Id of the relationship to be updated.
The application/json-patch+json operations to be performed on the specified digital twin's relationship.
Extended operation options ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
Create or update a digital twin
The Id of the digital twin to create or update.
The application/json digital twin to create.
Extended operation options including ifNoneMatch: Only perform the operation if the entity does not already exist.
The created application/json digital twin and the http response.
Create or update an event route.
The Id of the event route to create or update.
The id of the endpoint this event route is bound to.
An expression which describes the events which are routed to the endpoint.
The operation options
The http response.
Create or update a relationship on a digital twin.
The Id of the source digital twin.
The Id of the relationship to create.
The application/json relationship to be created.
Extended operation options including ifNoneMatch: Only perform the operation if the entity does not already exist.
Generated using TypeDoc
Client for Azure IoT DigitalTwins API.