Microsoft.Kusto clusters/databases/dataConnections 2020-09-18

Article
01/13/2024

Bicep resource definition

The clusters/databases/dataConnections 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.Kusto/clusters/databases/dataConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Kusto/clusters/databases/dataConnections@2020-09-18' = {
  name: 'string'
  location: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  // For remaining properties, see clusters/databases/dataConnections objects
}

clusters/databases/dataConnections objects

Set the kind property to specify the type of object.

For EventGrid, use:

  kind: 'EventGrid'
  properties: {
    blobStorageEventType: 'string'
    consumerGroup: 'string'
    dataFormat: 'string'
    eventHubResourceId: 'string'
    ignoreFirstRecord: bool
    mappingRuleName: 'string'
    storageAccountResourceId: 'string'
    tableName: 'string'
  }

For EventHub, use:

  kind: 'EventHub'
  properties: {
    compression: 'string'
    consumerGroup: 'string'
    dataFormat: 'string'
    eventHubResourceId: 'string'
    eventSystemProperties: [
      'string'
    ]
    mappingRuleName: 'string'
    tableName: 'string'
  }

For IotHub, use:

  kind: 'IotHub'
  properties: {
    consumerGroup: 'string'
    dataFormat: 'string'
    eventSystemProperties: [
      'string'
    ]
    iotHubResourceId: 'string'
    mappingRuleName: 'string'
    sharedAccessPolicyName: 'string'
    tableName: 'string'
  }

Property values

clusters/databases/dataConnections

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
location	Resource location.	string
kind	Set the object type	EventGrid EventHub IotHub (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: databases

EventGridDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	'EventGrid' (required)
properties	The properties of the Event Grid data connection.	EventGridConnectionProperties

EventGridConnectionProperties

Name	Description	Value
blobStorageEventType	The name of blob storage event type to process.	'Microsoft.Storage.BlobCreated' 'Microsoft.Storage.BlobRenamed'
consumerGroup	The event hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	'APACHEAVRO' 'AVRO' 'CSV' 'JSON' 'MULTIJSON' 'ORC' 'PARQUET' 'PSV' 'RAW' 'SCSV' 'SINGLEJSON' 'SOHSV' 'TSV' 'TSVE' 'TXT' 'W3CLOGFILE'
eventHubResourceId	The resource ID where the event grid is configured to send events.	string (required)
ignoreFirstRecord	A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file	bool
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
storageAccountResourceId	The resource ID of the storage account where the data resides.	string (required)
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

EventHubDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	'EventHub' (required)
properties	The Event Hub data connection properties to validate.	EventHubConnectionProperties

EventHubConnectionProperties

Name	Description	Value
compression	The event hub messages compression type	'GZip' 'None'
consumerGroup	The event hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	'APACHEAVRO' 'AVRO' 'CSV' 'JSON' 'MULTIJSON' 'ORC' 'PARQUET' 'PSV' 'RAW' 'SCSV' 'SINGLEJSON' 'SOHSV' 'TSV' 'TSVE' 'TXT' 'W3CLOGFILE'
eventHubResourceId	The resource ID of the event hub to be used to create a data connection.	string (required)
eventSystemProperties	System properties of the event hub	string[]
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

IotHubDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	'IotHub' (required)
properties	The Iot Hub data connection properties.	IotHubConnectionProperties

IotHubConnectionProperties

Name	Description	Value
consumerGroup	The iot hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	'APACHEAVRO' 'AVRO' 'CSV' 'JSON' 'MULTIJSON' 'ORC' 'PARQUET' 'PSV' 'RAW' 'SCSV' 'SINGLEJSON' 'SOHSV' 'TSV' 'TSVE' 'TXT' 'W3CLOGFILE'
eventSystemProperties	System properties of the iot hub	string[]
iotHubResourceId	The resource ID of the Iot hub to be used to create a data connection.	string (required)
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
sharedAccessPolicyName	The name of the share access policy	string (required)
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Azure Data Explorer DB with Cosmos DB connection	Deploy Azure Data Explorer DB with Cosmos DB connection.
Deploy Azure Data Explorer db with Event Grid connection	Deploy Azure Data Explorer db with Event Grid connection.
Deploy Azure Data Explorer db with Event Hub connection	Deploy Azure Data Explorer db with Event Hub connection.

ARM template resource definition

The clusters/databases/dataConnections 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.Kusto/clusters/databases/dataConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Kusto/clusters/databases/dataConnections",
  "apiVersion": "2020-09-18",
  "name": "string",
  "location": "string",
  "kind": "string",
  // For remaining properties, see clusters/databases/dataConnections objects
}

clusters/databases/dataConnections objects

Set the kind property to specify the type of object.

For EventGrid, use:

  "kind": "EventGrid",
  "properties": {
    "blobStorageEventType": "string",
    "consumerGroup": "string",
    "dataFormat": "string",
    "eventHubResourceId": "string",
    "ignoreFirstRecord": "bool",
    "mappingRuleName": "string",
    "storageAccountResourceId": "string",
    "tableName": "string"
  }

For EventHub, use:

  "kind": "EventHub",
  "properties": {
    "compression": "string",
    "consumerGroup": "string",
    "dataFormat": "string",
    "eventHubResourceId": "string",
    "eventSystemProperties": [ "string" ],
    "mappingRuleName": "string",
    "tableName": "string"
  }

For IotHub, use:

  "kind": "IotHub",
  "properties": {
    "consumerGroup": "string",
    "dataFormat": "string",
    "eventSystemProperties": [ "string" ],
    "iotHubResourceId": "string",
    "mappingRuleName": "string",
    "sharedAccessPolicyName": "string",
    "tableName": "string"
  }

Property values

clusters/databases/dataConnections

Name	Description	Value
type	The resource type	'Microsoft.Kusto/clusters/databases/dataConnections'
apiVersion	The resource api version	'2020-09-18'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
location	Resource location.	string
kind	Set the object type	EventGrid EventHub IotHub (required)

EventGridDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	'EventGrid' (required)
properties	The properties of the Event Grid data connection.	EventGridConnectionProperties

EventGridConnectionProperties

Name	Description	Value
blobStorageEventType	The name of blob storage event type to process.	'Microsoft.Storage.BlobCreated' 'Microsoft.Storage.BlobRenamed'
consumerGroup	The event hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	'APACHEAVRO' 'AVRO' 'CSV' 'JSON' 'MULTIJSON' 'ORC' 'PARQUET' 'PSV' 'RAW' 'SCSV' 'SINGLEJSON' 'SOHSV' 'TSV' 'TSVE' 'TXT' 'W3CLOGFILE'
eventHubResourceId	The resource ID where the event grid is configured to send events.	string (required)
ignoreFirstRecord	A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file	bool
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
storageAccountResourceId	The resource ID of the storage account where the data resides.	string (required)
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

EventHubDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	'EventHub' (required)
properties	The Event Hub data connection properties to validate.	EventHubConnectionProperties

EventHubConnectionProperties

Name	Description	Value
compression	The event hub messages compression type	'GZip' 'None'
consumerGroup	The event hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	'APACHEAVRO' 'AVRO' 'CSV' 'JSON' 'MULTIJSON' 'ORC' 'PARQUET' 'PSV' 'RAW' 'SCSV' 'SINGLEJSON' 'SOHSV' 'TSV' 'TSVE' 'TXT' 'W3CLOGFILE'
eventHubResourceId	The resource ID of the event hub to be used to create a data connection.	string (required)
eventSystemProperties	System properties of the event hub	string[]
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

IotHubDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	'IotHub' (required)
properties	The Iot Hub data connection properties.	IotHubConnectionProperties

IotHubConnectionProperties

Name	Description	Value
consumerGroup	The iot hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	'APACHEAVRO' 'AVRO' 'CSV' 'JSON' 'MULTIJSON' 'ORC' 'PARQUET' 'PSV' 'RAW' 'SCSV' 'SINGLEJSON' 'SOHSV' 'TSV' 'TSVE' 'TXT' 'W3CLOGFILE'
eventSystemProperties	System properties of the iot hub	string[]
iotHubResourceId	The resource ID of the Iot hub to be used to create a data connection.	string (required)
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
sharedAccessPolicyName	The name of the share access policy	string (required)
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Azure Data Explorer DB with Cosmos DB connection	Deploy Azure Data Explorer DB with Cosmos DB connection.
Deploy Azure Data Explorer db with Event Grid connection	Deploy Azure Data Explorer db with Event Grid connection.
Deploy Azure Data Explorer db with Event Hub connection	Deploy Azure Data Explorer db with Event Hub connection.

Terraform (AzAPI provider) resource definition

The clusters/databases/dataConnections 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.Kusto/clusters/databases/dataConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters/databases/dataConnections@2020-09-18"
  name = "string"
  location = "string"
  parent_id = "string"
  // For remaining properties, see clusters/databases/dataConnections objects
  body = jsonencode({
    kind = "string"
  })
}

clusters/databases/dataConnections objects

Set the kind property to specify the type of object.

For EventGrid, use:

  kind = "EventGrid"
  properties = {
    blobStorageEventType = "string"
    consumerGroup = "string"
    dataFormat = "string"
    eventHubResourceId = "string"
    ignoreFirstRecord = bool
    mappingRuleName = "string"
    storageAccountResourceId = "string"
    tableName = "string"
  }

For EventHub, use:

  kind = "EventHub"
  properties = {
    compression = "string"
    consumerGroup = "string"
    dataFormat = "string"
    eventHubResourceId = "string"
    eventSystemProperties = [
      "string"
    ]
    mappingRuleName = "string"
    tableName = "string"
  }

For IotHub, use:

  kind = "IotHub"
  properties = {
    consumerGroup = "string"
    dataFormat = "string"
    eventSystemProperties = [
      "string"
    ]
    iotHubResourceId = "string"
    mappingRuleName = "string"
    sharedAccessPolicyName = "string"
    tableName = "string"
  }

Property values

clusters/databases/dataConnections

Name	Description	Value
type	The resource type	"Microsoft.Kusto/clusters/databases/dataConnections@2020-09-18"
name	The resource name	string (required)
location	Resource location.	string
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: databases
kind	Set the object type	EventGrid EventHub IotHub (required)

EventGridDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	"EventGrid" (required)
properties	The properties of the Event Grid data connection.	EventGridConnectionProperties

EventGridConnectionProperties

Name	Description	Value
blobStorageEventType	The name of blob storage event type to process.	"Microsoft.Storage.BlobCreated" "Microsoft.Storage.BlobRenamed"
consumerGroup	The event hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	"APACHEAVRO" "AVRO" "CSV" "JSON" "MULTIJSON" "ORC" "PARQUET" "PSV" "RAW" "SCSV" "SINGLEJSON" "SOHSV" "TSV" "TSVE" "TXT" "W3CLOGFILE"
eventHubResourceId	The resource ID where the event grid is configured to send events.	string (required)
ignoreFirstRecord	A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file	bool
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
storageAccountResourceId	The resource ID of the storage account where the data resides.	string (required)
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

EventHubDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	"EventHub" (required)
properties	The Event Hub data connection properties to validate.	EventHubConnectionProperties

EventHubConnectionProperties

Name	Description	Value
compression	The event hub messages compression type	"GZip" "None"
consumerGroup	The event hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	"APACHEAVRO" "AVRO" "CSV" "JSON" "MULTIJSON" "ORC" "PARQUET" "PSV" "RAW" "SCSV" "SINGLEJSON" "SOHSV" "TSV" "TSVE" "TXT" "W3CLOGFILE"
eventHubResourceId	The resource ID of the event hub to be used to create a data connection.	string (required)
eventSystemProperties	System properties of the event hub	string[]
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

IotHubDataConnection

Name	Description	Value
kind	Kind of the endpoint for the data connection	"IotHub" (required)
properties	The Iot Hub data connection properties.	IotHubConnectionProperties

IotHubConnectionProperties

Name	Description	Value
consumerGroup	The iot hub consumer group.	string (required)
dataFormat	The data format of the message. Optionally the data format can be added to each message.	"APACHEAVRO" "AVRO" "CSV" "JSON" "MULTIJSON" "ORC" "PARQUET" "PSV" "RAW" "SCSV" "SINGLEJSON" "SOHSV" "TSV" "TSVE" "TXT" "W3CLOGFILE"
eventSystemProperties	System properties of the iot hub	string[]
iotHubResourceId	The resource ID of the Iot hub to be used to create a data connection.	string (required)
mappingRuleName	The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.	string
sharedAccessPolicyName	The name of the share access policy	string (required)
tableName	The table where the data should be ingested. Optionally the table information can be added to each message.	string

Share via

Microsoft.Kusto clusters/databases/dataConnections 2020-09-18

Bicep resource definition

Resource format

clusters/databases/dataConnections objects

Property values

clusters/databases/dataConnections

EventGridDataConnection

EventGridConnectionProperties

EventHubDataConnection

EventHubConnectionProperties

IotHubDataConnection

IotHubConnectionProperties

Quickstart templates

ARM template resource definition

Resource format

clusters/databases/dataConnections objects

Property values

clusters/databases/dataConnections

EventGridDataConnection

EventGridConnectionProperties

EventHubDataConnection

EventHubConnectionProperties

IotHubDataConnection

IotHubConnectionProperties

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

clusters/databases/dataConnections objects

Property values

clusters/databases/dataConnections

EventGridDataConnection

EventGridConnectionProperties

EventHubDataConnection

EventHubConnectionProperties

IotHubDataConnection

IotHubConnectionProperties

Feedback

Additional resources