Microsoft.Kusto clusters/databases/dataConnections template reference

07/31/2020
2 minutes to read

Template format

To create a Microsoft.Kusto/clusters/databases/dataConnections resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Kusto/clusters/databases/dataConnections",
  "apiVersion": "2019-05-15",
  "location": "string",
  "kind": "string",
  "properties": see-variations-below
}

For EventGrid object, use:

{
  "storageAccountResourceId": "string",
  "eventHubResourceId": "string",
  "consumerGroup": "string",
  "tableName": "string",
  "mappingRuleName": "string",
  "dataFormat": "string"
}

For EventHub object, use:

{
  "eventHubResourceId": "string",
  "consumerGroup": "string",
  "tableName": "string",
  "mappingRuleName": "string",
  "dataFormat": "string",
  "eventSystemProperties": [
  ]
}

For IotHub object, use:

{
  "IotHubResourceId": "string",
  "consumerGroup": "string",
  "tableName": "string",
  "mappingRuleName": "string",
  "dataFormat": "string",
  "eventSystemProperties": [
  ],
  "sharedAccessPolicyName": "string"
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Kusto/clusters/databases/dataConnections object

Name	Type	Required	Value
name	string	Yes	The name of the data connection.
type	enum	Yes	dataConnections -or- Microsoft.Kusto/clusters/databases/dataConnections See Set name and type for child resources.
apiVersion	enum	Yes	2019-05-15
location	string	No	Resource location.
kind	string	Yes	Kind of the endpoint for the data connection - EventHub, IotHub, or EventGrid
properties	object	Yes	EventGrid object, EventHub object, or IotHub object

EventGrid object

Name	Type	Required	Value
storageAccountResourceId	string	Yes	The resource ID of the storage account where the data resides.
eventHubResourceId	string	Yes	The resource ID where the event grid is configured to send events.
consumerGroup	string	Yes	The event hub consumer group.
tableName	string	Yes	The table where the data should be ingested. Optionally the table information can be added to each message.
mappingRuleName	string	No	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
dataFormat	enum	Yes	The data format of the message. Optionally the data format can be added to each message. - MULTIJSON, JSON,CSV, TSV, SCSV, SOHSV, PSV, TXT, RAW, SINGLEJSON, AVRO, TSVE

EventHub object

Name	Type	Required	Value
eventHubResourceId	string	Yes	The resource ID of the event hub to be used to create a data connection.
consumerGroup	string	Yes	The event hub consumer group.
tableName	string	No	The table where the data should be ingested. Optionally the table information can be added to each message.
mappingRuleName	string	No	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
dataFormat	enum	No	The data format of the message. Optionally the data format can be added to each message. - MULTIJSON, JSON,CSV, TSV, SCSV, SOHSV, PSV, TXT, RAW, SINGLEJSON, AVRO, TSVE
eventSystemProperties	array	No	The event hub system properties.

IotHub object

Name	Type	Required	Value
IotHubResourceId	string	Yes	The resource ID of the iot hub to be used to create a data connection.
consumerGroup	string	Yes	The iot hub consumer group.
tableName	string	No	The table where the data should be ingested. Optionally the table information can be added to each message.
mappingRuleName	string	No	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message."
dataFormat	enum	No	The data format of the message. Optionally the data format can be added to each message. - MULTIJSON, JSON,CSV, TSV, SCSV, SOHSV, PSV, TXT, RAW, SINGLEJSON, AVRO, TSVE
eventSystemProperties	array	No	The iot hub system properties.
sharedAccessPolicyName	string	Yes	The name of the shared access policy.