Microsoft.Synapse workspaces/kustoPools/databases/dataConnections

The workspaces/kustoPools/databases/dataConnections resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections@2021-06-01-preview' = {
  name: 'string'
  location: 'string'
  kind: 'string'
  // For remaining properties, see workspaces/kustoPools/databases/dataConnections objects
}

workspaces/kustoPools/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

workspaces/kustoPools/databases/dataConnections

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-06-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
location Resource location. string
kind Set the object type EventGrid
EventHub
IotHub

EventGridDataConnection

Name Description Value
kind Kind of the endpoint for the data connection 'EventGrid'
properties Class representing the Kusto event grid connection properties. 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'
properties Class representing the Kusto event hub connection properties. EventHubConnectionProperties

EventHubConnectionProperties

Name Description Value
compression The 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'
properties Class representing the Kusto Iot hub 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