Microsoft.Kusto clusters/databases/dataConnections 2022-02-01
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@2022-02-01' = {
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'
databaseRouting: 'string'
dataFormat: 'string'
eventGridResourceId: 'string'
eventHubResourceId: 'string'
ignoreFirstRecord: bool
managedIdentityResourceId: 'string'
mappingRuleName: 'string'
storageAccountResourceId: 'string'
tableName: 'string'
}
For EventHub, use:
kind: 'EventHub'
properties: {
compression: 'string'
consumerGroup: 'string'
databaseRouting: 'string'
dataFormat: 'string'
eventHubResourceId: 'string'
eventSystemProperties: [
'string'
]
managedIdentityResourceId: 'string'
mappingRuleName: 'string'
tableName: 'string'
}
For IotHub, use:
kind: 'IotHub'
properties: {
consumerGroup: 'string'
databaseRouting: '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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | 'Multi' 'Single' |
| 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' |
| eventGridResourceId | The resource ID of the event grid that is subscribed to the storage account events. | string |
| 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 |
| managedIdentityResourceId | Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. | string |
| 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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | 'Multi' 'Single' |
| 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[] |
| managedIdentityResourceId | Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. | 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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | 'Multi' 'Single' |
| 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 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": "2022-02-01",
"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",
"databaseRouting": "string",
"dataFormat": "string",
"eventGridResourceId": "string",
"eventHubResourceId": "string",
"ignoreFirstRecord": "bool",
"managedIdentityResourceId": "string",
"mappingRuleName": "string",
"storageAccountResourceId": "string",
"tableName": "string"
}
For EventHub, use:
"kind": "EventHub",
"properties": {
"compression": "string",
"consumerGroup": "string",
"databaseRouting": "string",
"dataFormat": "string",
"eventHubResourceId": "string",
"eventSystemProperties": [ "string" ],
"managedIdentityResourceId": "string",
"mappingRuleName": "string",
"tableName": "string"
}
For IotHub, use:
"kind": "IotHub",
"properties": {
"consumerGroup": "string",
"databaseRouting": "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 | '2022-02-01' |
| 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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | 'Multi' 'Single' |
| 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' |
| eventGridResourceId | The resource ID of the event grid that is subscribed to the storage account events. | string |
| 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 |
| managedIdentityResourceId | Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. | string |
| 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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | 'Multi' 'Single' |
| 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[] |
| managedIdentityResourceId | Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. | 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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | 'Multi' 'Single' |
| 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 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@2022-02-01"
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"
databaseRouting = "string"
dataFormat = "string"
eventGridResourceId = "string"
eventHubResourceId = "string"
ignoreFirstRecord = bool
managedIdentityResourceId = "string"
mappingRuleName = "string"
storageAccountResourceId = "string"
tableName = "string"
}
For EventHub, use:
kind = "EventHub"
properties = {
compression = "string"
consumerGroup = "string"
databaseRouting = "string"
dataFormat = "string"
eventHubResourceId = "string"
eventSystemProperties = [
"string"
]
managedIdentityResourceId = "string"
mappingRuleName = "string"
tableName = "string"
}
For IotHub, use:
kind = "IotHub"
properties = {
consumerGroup = "string"
databaseRouting = "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@2022-02-01" |
| 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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | "Multi" "Single" |
| 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" |
| eventGridResourceId | The resource ID of the event grid that is subscribed to the storage account events. | string |
| 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 |
| managedIdentityResourceId | Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. | string |
| 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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | "Multi" "Single" |
| 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[] |
| managedIdentityResourceId | Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. | 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) |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | "Multi" "Single" |
| 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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for