Digital Twins Instance - DigitalTwins Get
Get DigitalTwinsInstances resource.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}?api-version=2023-01-31URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string |
The name of the resource group that contains the DigitalTwinsInstance. |
|
resource
|
path | True |
string |
The name of the DigitalTwinsInstance. Regex pattern: |
|
subscription
|
path | True |
string |
The subscription identifier. |
|
api-version
|
query | True |
string |
Version of the DigitalTwinsInstance Management API. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null. |
|
| Other Status Codes |
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 a Digital |
|
Get a Digital |
|
Get a Digital |
Get a DigitalTwinsInstance resource
Sample Request
GET https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService?api-version=2023-01-31
Sample Response
{
"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-12-06T12:21:58.610Z",
"provisioningState": "Succeeded",
"hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
"publicNetworkAccess": "Enabled"
}
}Get a DigitalTwinsInstance resource with a private endpoint connection
Sample Request
GET https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService?api-version=2023-01-31
Sample Response
{
"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-12-06T12:21:58.610Z",
"provisioningState": "Succeeded",
"hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
"privateEndpointConnections": [
{
"id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/privateEndpointConnections/myPrivateConnection",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
},
"groupIds": [
"digitalTwinsInstance"
],
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request, thanks.",
"actionsRequired": "None"
}
}
}
],
"publicNetworkAccess": "Enabled"
}
}Get a DigitalTwinsInstance resource with identity
Sample Request
GET https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService?api-version=2023-01-31
Sample Response
{
"id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
"location": "westus2",
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"name": "myDigitalTwinsService",
"identity": {
"type": "SystemAssigned,UserAssigned",
"principalId": "544215a9-21d8-4fb5-8094-8efbcc311dd0",
"tenantId": "544215a9-21d8-4fb5-8094-8efbcc311dd0",
"userAssignedIdentities": {
"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {
"clientId": "544215a9-21d8-4fb5-8094-8efbcc311dd0",
"principalId": "50016170-c839-41ba-a724-51e9df440b9e"
}
}
},
"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-12-06T12:21:58.610Z",
"provisioningState": "Succeeded",
"hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
"publicNetworkAccess": "Enabled"
}
}Definitions
| Name | Description |
|---|---|
|
Connection |
The properties of a private endpoint connection. |
|
Connection |
The provisioning state. |
|
created |
The type of identity that created the resource. |
|
Digital |
The description of the DigitalTwins service. |
|
Digital |
The managed identity for the DigitalTwinsInstance. |
|
Digital |
The type of Managed Identity used by the DigitalTwinsInstance. |
|
Error |
Error definition. |
|
Error |
Error response. |
|
Private |
The private endpoint property of a private endpoint connection. |
|
Private |
The private endpoint connection of a Digital Twin. |
|
Private |
The connection state. |
|
Private |
The status of a private endpoint connection. |
|
provisioning |
The provisioning state. |
|
public |
Public network access for the DigitalTwinsInstance. |
|
System |
Metadata pertaining to creation and last modification of the resource. |
|
User |
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 |
The private endpoint. |
|
| privateLinkServiceConnectionState |
The connection state. |
|
| provisioningState |
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 |
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 |
The private endpoint connections. |
|
| properties.provisioningState |
The provisioning state. |
|
| properties.publicNetworkAccess |
Public network access for the DigitalTwinsInstance. |
|
| systemData |
Metadata pertaining to creation and last modification of the DigitalTwinsInstance. |
|
| tags |
object |
The resource tags. |
| type |
string |
The resource type. |
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 |
The type of Managed Identity used by the DigitalTwinsInstance. |
|
| userAssignedIdentities |
<string,
User |
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 |
Internal error details. |
|
| message |
string |
Description of the error. |
ErrorResponse
Error response.
| Name | Type | Description |
|---|---|---|
| error |
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 |
The connection properties. |
|
| 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 |
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
The provisioning state.
| Name | Type | Description |
|---|---|---|
| Canceled |
string |
|
| Deleted |
string |
|
| Deleting |
string |
|
| Failed |
string |
|
| Moving |
string |
|
| Provisioning |
string |
|
| Restoring |
string |
|
| Succeeded |
string |
|
| Suspending |
string |
|
| Updating |
string |
|
| Warning |
string |
publicNetworkAccess
Public network access for the DigitalTwinsInstance.
| Name | Type | Description |
|---|---|---|
| Disabled |
string |
|
| Enabled |
string |
SystemData
Metadata pertaining to creation and last modification of the resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string |
The timestamp of resource creation (UTC). |
| createdBy |
string |
The identity that created the resource. |
| createdByType |
The type of identity that created the resource. |
|
| lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
| lastModifiedBy |
string |
The identity that last modified the resource. |
| lastModifiedByType |
The type of identity that last modified the resource. |
UserAssignedIdentity
The information about the user assigned identity.
| Name | Type | Description |
|---|---|---|
| clientId |
string |
The client id of the User Assigned Identity Resource. |
| principalId |
string |
The object id of the User Assigned Identity Resource. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for