The workspaces/kustoPools/databases/dataConnections resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections resource, add the following JSON to your template.
{
"type": "Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections",
"apiVersion": "2021-06-01-preview",
"name": "string",
"location": "string",
"kind": "string",
// For remaining properties, see 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" ],
"managedIdentityResourceId": "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"
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections' |
apiVersion | The resource api version | '2021-06-01-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 |
kind | Set the object type | EventGrid EventHub IotHub (required) |
Name | Description | Value |
---|---|---|
kind | Kind of the endpoint for the data connection | 'EventGrid' (required) |
properties | The properties of the Event Grid data connection. | 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 |
Name | Description | Value |
---|---|---|
kind | Kind of the endpoint for the data connection | 'EventHub' (required) |
properties | The Event Hub data connection properties to validate. | 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[] |
managedIdentityResourceId | The resource ID of a managed identity (system or user assigned) to be used to authenticate with 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 |
Name | Description | Value |
---|---|---|
kind | Kind of the endpoint for the data connection | 'IotHub' (required) |
properties | The Iot Hub data connection properties. | 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 |