Microsoft.DigitalTwins digitalTwinsInstances 2020-12-01

Bicep resource definition

The digitalTwinsInstances resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DigitalTwins/digitalTwinsInstances resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DigitalTwins/digitalTwinsInstances@2020-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
  }
}

Property values

digitalTwinsInstances

Name Description Value
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

DigitalTwinsIdentity

Name Description Value
type The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. 'None'
'SystemAssigned'

DigitalTwinsProperties

Name Description Value
privateEndpointConnections PrivateEndpointConnection[]
publicNetworkAccess Public network access for the DigitalTwinsInstance. 'Disabled'
'Enabled'

PrivateEndpointConnection

Name Description Value
properties PrivateEndpointConnectionProperties (required)

PrivateEndpointConnectionProperties

Name Description Value
groupIds The list of group ids for the private endpoint connection. string[]
privateEndpoint ConnectionPropertiesPrivateEndpoint
privateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionStat...

ConnectionPropertiesPrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ConnectionPropertiesPrivateLinkServiceConnectionState

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)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Digital Twins with Function and Private Link service

Deploy to Azure
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

Deploy to Azure
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

ARM template resource definition

The digitalTwinsInstances resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DigitalTwins/digitalTwinsInstances resource, add the following JSON to your template.

{
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "apiVersion": "2020-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string"
  }
}

Property values

digitalTwinsInstances

Name Description Value
type The resource type 'Microsoft.DigitalTwins/digitalTwinsInstances'
apiVersion The resource api version '2020-12-01'
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

DigitalTwinsIdentity

Name Description Value
type The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. 'None'
'SystemAssigned'

DigitalTwinsProperties

Name Description Value
privateEndpointConnections PrivateEndpointConnection[]
publicNetworkAccess Public network access for the DigitalTwinsInstance. 'Disabled'
'Enabled'

PrivateEndpointConnection

Name Description Value
properties PrivateEndpointConnectionProperties (required)

PrivateEndpointConnectionProperties

Name Description Value
groupIds The list of group ids for the private endpoint connection. string[]
privateEndpoint ConnectionPropertiesPrivateEndpoint
privateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionStat...

ConnectionPropertiesPrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ConnectionPropertiesPrivateLinkServiceConnectionState

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)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Digital Twins with Function and Private Link service

Deploy to Azure
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

Deploy to Azure
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

Terraform (AzAPI provider) resource definition

The digitalTwinsInstances resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DigitalTwins/digitalTwinsInstances resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DigitalTwins/digitalTwinsInstances@2020-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
    }
  })
}

Property values

digitalTwinsInstances

Name Description Value
type The resource type "Microsoft.DigitalTwins/digitalTwinsInstances@2020-12-01"
name The resource name string (required)
location The resource location. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags The resource tags. Dictionary of tag names and values.
identity The managed identity for the DigitalTwinsInstance. DigitalTwinsIdentity
properties DigitalTwins instance properties. DigitalTwinsProperties

DigitalTwinsIdentity

Name Description Value
type The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. "SystemAssigned"

DigitalTwinsProperties

Name Description Value
privateEndpointConnections PrivateEndpointConnection[]
publicNetworkAccess Public network access for the DigitalTwinsInstance. "Disabled"
"Enabled"

PrivateEndpointConnection

Name Description Value
properties PrivateEndpointConnectionProperties (required)

PrivateEndpointConnectionProperties

Name Description Value
groupIds The list of group ids for the private endpoint connection. string[]
privateEndpoint ConnectionPropertiesPrivateEndpoint
privateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionStat...

ConnectionPropertiesPrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ConnectionPropertiesPrivateLinkServiceConnectionState

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)