Microsoft.Kusto clusters/databases/eventhubconnections

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Kusto/clusters/databases/eventhubconnections@2018-09-07-preview' = {
  name: 'string'
  location: 'string'
  parent: resourceSymbolicName
  properties: {
    consumerGroup: 'string'
    dataFormat: 'string'
    eventHubResourceId: 'string'
    mappingRuleName: 'string'
    tableName: 'string'
  }
}

Property values

clusters/databases/eventhubconnections

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
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
properties Class representing the Kusto event hub connection properties. EventHubConnectionProperties

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. 'CSV'
'JSON'
'MULTIJSON'
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

ARM template resource definition

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

{
  "type": "Microsoft.Kusto/clusters/databases/eventhubconnections",
  "apiVersion": "2018-09-07-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "consumerGroup": "string",
    "dataFormat": "string",
    "eventHubResourceId": "string",
    "mappingRuleName": "string",
    "tableName": "string"
  }
}

Property values

clusters/databases/eventhubconnections

Name Description Value
type The resource type 'Microsoft.Kusto/clusters/databases/eventhubconnections'
apiVersion The resource api version '2018-09-07-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location Resource location. string
properties Class representing the Kusto event hub connection properties. EventHubConnectionProperties

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. 'CSV'
'JSON'
'MULTIJSON'
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

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Kusto/clusters/databases/eventhubconnections@2018-09-07-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      consumerGroup = "string"
      dataFormat = "string"
      eventHubResourceId = "string"
      mappingRuleName = "string"
      tableName = "string"
    }
  })
}

Property values

clusters/databases/eventhubconnections

Name Description Value
type The resource type "Microsoft.Kusto/clusters/databases/eventhubconnections@2018-09-07-preview"
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
properties Class representing the Kusto event hub connection properties. EventHubConnectionProperties

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. "CSV"
"JSON"
"MULTIJSON"
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