Microsoft.DigitalTwins digitalTwinsInstances/timeSeriesDatabaseConnections

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections",
  "apiVersion": "2023-01-31",
  "name": "string",
  "properties": {
    "identity": {
      "type": "string",
      "userAssignedIdentity": "string"
    },
    "connectionType": "string"
    // For remaining properties, see TimeSeriesDatabaseConnectionProperties objects
  }
}

TimeSeriesDatabaseConnectionProperties objects

Set the connectionType property to specify the type of object.

For AzureDataExplorer, use:

  "connectionType": "AzureDataExplorer",
  "adxDatabaseName": "string",
  "adxEndpointUri": "string",
  "adxRelationshipLifecycleEventsTableName": "string",
  "adxResourceId": "string",
  "adxTableName": "string",
  "adxTwinLifecycleEventsTableName": "string",
  "eventHubConsumerGroup": "string",
  "eventHubEndpointUri": "string",
  "eventHubEntityPath": "string",
  "eventHubNamespaceResourceId": "string",
  "recordPropertyAndItemRemovals": "string"

Property values

digitalTwinsInstances/timeSeriesDatabaseConnections

Name Description Value
type The resource type 'Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections'
apiVersion The resource api version '2023-01-31'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Properties of a specific time series database connection. TimeSeriesDatabaseConnectionProperties

TimeSeriesDatabaseConnectionProperties

Name Description Value
identity Managed identity properties for the time series database connection resource. ManagedIdentityReference
connectionType Set the object type AzureDataExplorer (required)

ManagedIdentityReference

Name Description Value
type The type of managed identity used. 'SystemAssigned'
'UserAssigned'
userAssignedIdentity The user identity ARM resource id if the managed identity type is 'UserAssigned'. string

AzureDataExplorerConnectionProperties

Name Description Value
connectionType The type of time series connection resource. 'AzureDataExplorer' (required)
adxDatabaseName The name of the Azure Data Explorer database. string (required)
adxEndpointUri The URI of the Azure Data Explorer endpoint. string (required)
adxRelationshipLifecycleEventsTableName The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified. string
adxResourceId The resource ID of the Azure Data Explorer cluster. string (required)
adxTableName The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents. string
adxTwinLifecycleEventsTableName The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified. string
eventHubConsumerGroup The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default. string
eventHubEndpointUri The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb:// string (required)
eventHubEntityPath The EventHub name in the EventHub namespace for identity-based authentication. string (required)
eventHubNamespaceResourceId The resource ID of the EventHub namespace. string (required)
recordPropertyAndItemRemovals Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX. 'false'
'true'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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