Azure Digital Twins Explorer (preview)

This article contains information about the Azure Digital Twins Explorer, including its use cases and an overview of its features. For detailed steps on using each feature, see Use Azure Digital Twins Explorer (preview).

Azure Digital Twins Explorer is a developer tool for visualizing and interacting with the data in your Azure Digital Twins instance, including your models and twin graph.

Here's a view of the explorer window, showing models and twins that have been populated for a sample graph:

Screenshot of Azure Digital Twins Explorer showing sample models and twins.

The visual interface is a great tool for exploring and understanding the shape of your graph and model set. It also allows you to make pointed, on the spot changes to individual twins and relationships.

When to use

Azure Digital Twins Explorer is a visual tool designed for users who want to explore their twin graph, and modify twins and relationships in the context of their graph.

Developers may find this tool especially useful in the following scenarios:

  • Exploration: Use the explorer to learn about Azure Digital Twins and the way it represents your real-world environment. Import sample models and graphs that you can view and edit to familiarize yourself with the service. For guided steps to get started using Azure Digital Twins Explorer, see Get started with Azure Digital Twins Explorer.
  • Development: Use the explorer to view and validate your twin graph. You can also use it to investigate specific properties of models, twins, and relationships. Make on the spot modifications to your graph and its data. For detailed instructions on how to use each feature, see Use Azure Digital Twins Explorer.

The explorer's main purpose is to help you visualize and understand your graph, and update your graph as needed. For large-scale solutions and for work that should be repeated or automated, consider using the APIs and SDKs to interact with your instance through code instead.

How to access

The main way to access Azure Digital Twins Explorer is through the Azure portal.

To open Azure Digital Twins Explorer for an Azure Digital Twins instance, first navigate to the instance in the portal, by searching for its name in the portal search bar.

Next, select the Open Azure Digital Twins Explorer (preview) button.

Screenshot of the Azure portal showing the Overview page for an Azure Digital Twins instance. There's a highlight around the Open Azure Digital Twins Explorer (preview) button.

This will open Azure Digital Twins Explorer in a new tab. If this is your first time using the Explorer, you'll see a welcome modal summarizing its key features.

Azure Digital Twins Explorer might automatically connect to your instance. If not, you'll see the following screen asking you to specify an Azure Digital Twins URL. (If you don't see this box on your screen, Azure Digital Twins Explorer has already completed this step automatically.)

Screenshot of Azure Digital Twins Explorer. The Azure Digital Twins URL modal displays an empty editable box for the Azure Digital Twins URL.

If you see this box, enter https:// into the field, followed by the host name of your instance (this can be found back on the instance's Overview page in the portal). These values together make up the instance URL. Select Save to connect to your instance.

Note

The hosted Azure Digital Twins Explorer can only access Azure Digital Twins instances with public access enabled. If you're using Private Link to restrict access to your instance through a private endpoint, you can use Azure functions to deploy the Azure Digital Twins Explorer codebase privately in the cloud. For instructions on how to do this, see Azure Digital Twins Explorer: Running in the cloud.

Features and capabilities

Azure Digital Twins Explorer is organized into panels, each with a different set of capabilities for exploring and managing your models, twins, and relationships.

The sections of the explorer are as follows:

  • Query Explorer: Run queries against the twin graph and see the visual results in the Twin Graph panel.
  • Models: View a list of your models and perform model actions such as add, remove, and view model details.
  • Twins: View a list of your twins and their associated relationships.
  • Twin Graph: Visualize your twins and relationships as a customizable twin graph. Create and delete twins and relationships, and view or edit their properties.
  • Model Graph: Visualize your models and the ways they're interconnected in the form of a customizable model graph.

Screenshot of Azure Digital Twins Explorer, with a highlight around each of the panels described above.

For detailed instructions on how to use each feature, see Use Azure Digital Twins Explorer.

Note

Currently, Azure Digital Twins Explorer fully supports DTDL v2 models and supports limited functionality for DTDL v3 models. In Azure Digital Twins Explorer, DTDL v3 models can be viewed in the Models panel, and twins created with DTDL v3 models can be viewed and edited (including those with array properties). However, DTDL v3 models won't show up in the Model Graph panel, and they can't be imported using Azure Digital Twins Explorer. To import DTDL v3 models to your instance, use another developer interface like the APIs and SDKs or the Azure CLI.

How to contribute

Azure Digital Twins Explorer is an open-source tool that welcomes contributions to the code and documentation. The hosted application is deployed regularly from a source code repository in GitHub.

To view the source code for the tool and read detailed instructions on how to contribute to the code, visit its GitHub repository: digital-twins-explorer.

To view instructions for contributing to this documentation, review our contributor guide.

Other considerations

Region support

Azure Digital Twins Explorer is available for use with all instances of Azure Digital Twins in all supported regions.

During public preview, however, data may be sent for processing through different regions than the region where the instance is hosted. To avoid data being routed in this way in situations where data sovereignty is a concern, you can download the open source code to create a locally hosted version of the explorer on your own machine.

Billing

Azure Digital Twins Explorer is a free tool for interacting with the Azure Digital Twins service. While the tool itself is free, costs may be incurred during use when requests are sent to the Azure Digital Twins service, which follows these pricing guidelines: Azure Digital Twins pricing.

Next steps

Learn how to use Azure Digital Twins Explorer's features in detail: Use Azure Digital Twins Explorer.