Microsoft.DigitalTwins digitalTwinsInstances 2020-10-31

• Latest
• 2023-01-31
• 2022-10-31
• 2022-05-31
• 2020-12-01
• 2020-10-31

Bicep resource definition

The digitalTwinsInstances resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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-10-31' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {}
}

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
properties	DigitalTwins instance properties.	DigitalTwinsProperties

DigitalTwinsProperties

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

Quickstart templates

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

ARM template resource definition

The digitalTwinsInstances resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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-10-31",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {}
}

Property values

digitalTwinsInstances

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

DigitalTwinsProperties

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

Quickstart templates

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

Terraform (AzAPI provider) resource definition

The digitalTwinsInstances resource type can be deployed with operations that target:

• 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-10-31"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {}
  })
}

Property values

digitalTwinsInstances

Name	Description	Value
type	The resource type	"Microsoft.DigitalTwins/digitalTwinsInstances@2020-10-31"
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.
properties	DigitalTwins instance properties.	DigitalTwinsProperties

DigitalTwinsProperties

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