Digital Twins Instance - DigitalTwins List

Reference

Service:: Reference

API Version:: 2023-01-31

Get all the DigitalTwinsInstances in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances?api-version=2023-01-31

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	Version of the DigitalTwinsInstance Management API.

Responses

Name	Type	Description
200 OK	DigitalTwinsDescriptionListResult	This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DigitalTwinsInstances in the subscription.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

Get DigitalTwinsInstance resources by subscription

Sample request

HTTP

GET https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/digitalTwinsInstances?api-version=2023-01-31

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
      "location": "westus2",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
      "name": "myDigitalTwinsService",
      "systemData": {
        "createdBy": "user@example.com",
        "createdByType": "User",
        "createdAt": "2021-03-11T17:13:59.4037715Z",
        "lastModifiedBy": "d2baee3d-44c0-41b6-9961-92563de66a97",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
      },
      "properties": {
        "createdTime": "2019-11-19T12:55:05.229Z",
        "lastUpdatedTime": "2019-11-19T12:55:07.229Z",
        "provisioningState": "Succeeded",
        "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
        "publicNetworkAccess": "Enabled"
      }
    },
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg2/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService2",
      "location": "westus2",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
      "name": "myDigitalTwinsService2",
      "systemData": {
        "createdBy": "user@example.com",
        "createdByType": "User",
        "createdAt": "2021-03-11T17:14:59.4037715Z",
        "lastModifiedBy": "429f7e65-6d99-455e-a469-7a885be68642",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2021-03-11T17:15:02.5281409Z"
      },
      "properties": {
        "createdTime": "2019-11-19T12:55:05.229Z",
        "lastUpdatedTime": "2019-11-19T12:55:07.229Z",
        "provisioningState": "Provisioning",
        "hostName": null,
        "publicNetworkAccess": "Enabled"
      }
    }
  ]
}

Definitions

Name	Description
ConnectionProperties	The properties of a private endpoint connection.
ConnectionPropertiesProvisioningState	The provisioning state.
createdByType	The type of identity that created the resource.
DigitalTwinsDescription	The description of the DigitalTwins service.
DigitalTwinsDescriptionListResult	A list of DigitalTwins description objects with a next link.
DigitalTwinsIdentity	The managed identity for the DigitalTwinsInstance.
DigitalTwinsIdentityType	The type of Managed Identity used by the DigitalTwinsInstance.
ErrorDefinition	Error definition.
ErrorResponse	Error response.
PrivateEndpoint	The private endpoint property of a private endpoint connection.
PrivateEndpointConnection	The private endpoint connection of a Digital Twin.
PrivateLinkServiceConnectionState	The connection state.
PrivateLinkServiceConnectionStatus	The status of a private endpoint connection.
provisioningState	The provisioning state.
publicNetworkAccess	Public network access for the DigitalTwinsInstance.
SystemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	The information about the user assigned identity.

ConnectionProperties

The properties of a private endpoint connection.

Name	Type	Description
groupIds	string[]	The list of group ids for the private endpoint connection.
privateEndpoint	PrivateEndpoint	The private endpoint.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	The connection state.
provisioningState	ConnectionPropertiesProvisioningState	The provisioning state.

ConnectionPropertiesProvisioningState

The provisioning state.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsDescription

The description of the DigitalTwins service.

Name	Type	Description
id	string	The resource identifier.
identity	DigitalTwinsIdentity	The managed identity for the DigitalTwinsInstance.
location	string	The resource location.
name	string	The resource name.
properties.createdTime	string	Time when DigitalTwinsInstance was created.
properties.hostName	string	Api endpoint to work with DigitalTwinsInstance.
properties.lastUpdatedTime	string	Time when DigitalTwinsInstance was updated.
properties.privateEndpointConnections	PrivateEndpointConnection[]	The private endpoint connections.
properties.provisioningState	provisioningState	The provisioning state.
properties.publicNetworkAccess	publicNetworkAccess	Public network access for the DigitalTwinsInstance.
systemData	SystemData	Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
tags	object	The resource tags.
type	string	The resource type.

DigitalTwinsDescriptionListResult

A list of DigitalTwins description objects with a next link.

Name	Type	Description
nextLink	string	The link used to get the next page of DigitalTwins description objects.
value	DigitalTwinsDescription[]	A list of DigitalTwins description objects.

DigitalTwinsIdentity

The managed identity for the DigitalTwinsInstance.

Name	Type	Description
principalId	string	The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
tenantId	string	The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
type	DigitalTwinsIdentityType	The type of Managed Identity used by the DigitalTwinsInstance.
userAssignedIdentities	<string, UserAssignedIdentity>	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. .

DigitalTwinsIdentityType

The type of Managed Identity used by the DigitalTwinsInstance.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ErrorDefinition

Error definition.

Name	Type	Description
code	string	Service specific error code which serves as the substatus for the HTTP error code.
details	ErrorDefinition[]	Internal error details.
message	string	Description of the error.

ErrorResponse

Error response.

Name	Type	Description
error	ErrorDefinition	Error description

PrivateEndpoint

The private endpoint property of a private endpoint connection.

Name	Type	Description
id	string	The resource identifier.

PrivateEndpointConnection

The private endpoint connection of a Digital Twin.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties	ConnectionProperties	The connection properties.
systemData	SystemData	Metadata pertaining to creation and last modification of the private endpoint connection.
type	string	The resource type.

PrivateLinkServiceConnectionState

The connection state.

Name	Type	Description
actionsRequired	string	Actions required for a private endpoint connection.
description	string	The description for the current state of a private endpoint connection.
status	PrivateLinkServiceConnectionStatus	The status of a private endpoint connection.

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

provisioningState