Share via

Microsoft.Kusto clusters/databases/dataConnections 2019-01-21

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Kusto/clusters/databases/dataConnections@2019-01-21' = {
  location: 'string'
  name: 'string'
  kind: 'string'
  // For remaining properties, see Microsoft.Kusto/clusters/databases/dataConnections objects
}

Microsoft.Kusto/clusters/databases/dataConnections objects

Set the kind property to specify the type of object.

For EventGrid, use:

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

For EventHub, use:

{
  kind: 'EventHub'
  properties: {
    consumerGroup: 'string'
    dataFormat: 'string'
    eventHubResourceId: 'string'
    mappingRuleName: 'string'
    tableName: 'string'
  }
}

Property values

EventGridConnectionProperties

Name Description Value
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. 'AVRO'
'CSV'
'JSON'
'MULTIJSON'
'PSV'
'RAW'
'SCSV'
'SINGLEJSON'
'SOHSV'
'TSV'
'TXT' (required)
eventHubResourceId The resource ID where the event grid is configured to send events. string (required)
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 (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

EventHubConnectionProperties

Name Description Value
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. 'AVRO'
'CSV'
'JSON'
'MULTIJSON'
'PSV'
'RAW'
'SCSV'
'SINGLEJSON'
'SOHSV'
'TSV'
'TXT'
eventHubResourceId The resource ID of the event 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
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

Microsoft.Kusto/clusters/databases/dataConnections

Name Description Value
kind Set to 'EventGrid' for type EventGridDataConnection. Set to 'EventHub' for type EventHubDataConnection. 'EventGrid'
'EventHub' (required)
location Resource location. string
name The resource name string (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: clusters/databases

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File 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:

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.

{
  "location": "string",
  "name": "string",
  "kind": "string"
  // For remaining properties, see Microsoft.Kusto/clusters/databases/dataConnections objects
}

Microsoft.Kusto/clusters/databases/dataConnections objects

Set the kind property to specify the type of object.

For EventGrid, use:

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

For EventHub, use:

{
  "kind": "EventHub",
  "properties": {
    "consumerGroup": "string",
    "dataFormat": "string",
    "eventHubResourceId": "string",
    "mappingRuleName": "string",
    "tableName": "string"
  }
}

Property values

EventGridConnectionProperties

Name Description Value
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. 'AVRO'
'CSV'
'JSON'
'MULTIJSON'
'PSV'
'RAW'
'SCSV'
'SINGLEJSON'
'SOHSV'
'TSV'
'TXT' (required)
eventHubResourceId The resource ID where the event grid is configured to send events. string (required)
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 (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

EventHubConnectionProperties

Name Description Value
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. 'AVRO'
'CSV'
'JSON'
'MULTIJSON'
'PSV'
'RAW'
'SCSV'
'SINGLEJSON'
'SOHSV'
'TSV'
'TXT'
eventHubResourceId The resource ID of the event 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
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

Microsoft.Kusto/clusters/databases/dataConnections

Name Description Value
apiVersion The api version '2019-01-21'
kind Set to 'EventGrid' for type EventGridDataConnection. Set to 'EventHub' for type EventHubDataConnection. 'EventGrid'
'EventHub' (required)
location Resource location. string
name The resource name string (required)
type The resource type 'Microsoft.Kusto/clusters/databases/dataConnections'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy Azure Data Explorer DB with Cosmos DB connection

Deploy to Azure		 Deploy Azure Data Explorer DB with Cosmos DB connection.
Deploy Azure Data Explorer db with Event Grid connection

Deploy to Azure		 Deploy Azure Data Explorer db with Event Grid connection.
Deploy Azure Data Explorer db with Event Hub connection

Deploy to Azure		 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" {
  location = "string"
  name = "string"
  kind = "string"
  // For remaining properties, see Microsoft.Kusto/clusters/databases/dataConnections objects
}

Microsoft.Kusto/clusters/databases/dataConnections objects

Set the kind property to specify the type of object.

For EventGrid, use:

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

For EventHub, use:

{
  kind = "EventHub"
  properties = {
    consumerGroup = "string"
    dataFormat = "string"
    eventHubResourceId = "string"
    mappingRuleName = "string"
    tableName = "string"
  }
}

Property values

EventGridConnectionProperties

Name Description Value
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. 'AVRO'
'CSV'
'JSON'
'MULTIJSON'
'PSV'
'RAW'
'SCSV'
'SINGLEJSON'
'SOHSV'
'TSV'
'TXT' (required)
eventHubResourceId The resource ID where the event grid is configured to send events. string (required)
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 (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

EventHubConnectionProperties

Name Description Value
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. 'AVRO'
'CSV'
'JSON'
'MULTIJSON'
'PSV'
'RAW'
'SCSV'
'SINGLEJSON'
'SOHSV'
'TSV'
'TXT'
eventHubResourceId The resource ID of the event 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
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

Microsoft.Kusto/clusters/databases/dataConnections

Name Description Value
kind Set to 'EventGrid' for type EventGridDataConnection. Set to 'EventHub' for type EventHubDataConnection. 'EventGrid'
'EventHub' (required)
location Resource location. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: clusters/databases
type The resource type "Microsoft.Kusto/clusters/databases/dataConnections@2019-01-21"