The digitalTwinsInstances resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.DigitalTwins/digitalTwinsInstances resource, add the following JSON to your template.
{
"type": "Microsoft.DigitalTwins/digitalTwinsInstances",
"apiVersion": "2023-01-31",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"privateEndpointConnections": [
{
"properties": {
"groupIds": [ "string" ],
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DigitalTwins/digitalTwinsInstances' |
apiVersion | The resource api version | '2023-01-31' |
name | The resource name | string (required) |
location | The resource location. | string (required) |
tags | The resource tags. | Dictionary of tag names and values. See Tags in templates |
identity | The managed identity for the DigitalTwinsInstance. | DigitalTwinsIdentity |
properties | DigitalTwins instance properties. | DigitalTwinsProperties |
Name | Description | Value |
---|---|---|
type | The type of Managed Identity used by the DigitalTwinsInstance. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
userAssignedIdentities | 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}'. . |
object |
Name | Description | Value |
---|---|---|
privateEndpointConnections | The private endpoint connections. | PrivateEndpointConnection[] |
publicNetworkAccess | Public network access for the DigitalTwinsInstance. | 'Disabled' 'Enabled' |
Name | Description | Value |
---|---|---|
properties | The connection properties. | ConnectionProperties (required) |
Name | Description | Value |
---|---|---|
groupIds | The list of group ids for the private endpoint connection. | string[] |
privateEndpoint | The private endpoint. | PrivateEndpoint |
privateLinkServiceConnectionState | The connection state. | ConnectionPropertiesPrivateLinkServiceConnectionStat... |
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
Name | Description | Value |
---|---|---|
actionsRequired | Actions required for a private endpoint connection. | string |
description | The description for the current state of a private endpoint connection. | string (required) |
status | The status of a private endpoint connection. | 'Approved' 'Disconnected' 'Pending' 'Rejected' (required) |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Azure Digital Twins with Function and Private Link service |
This template creates an Azure Digital Twins service configured with a Virtual Network connected Azure Function that can communicate through a Private Link Endpoint to Digital Twins. It also creates a Private DNS Zone to allow seamless hostname resolution of the Digital Twins Endpoint from the Virtual Network to the Private Endpoint internal subnet IP address. The hostname is stored as a setting to the Azure Function with name 'ADT_ENDPOINT'. |
Azure Digital Twins with Time Data History Connection |
This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster |