Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The clusters/databases/eventhubconnections 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/eventhubconnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Kusto/clusters/databases/eventhubconnections@2018-09-07-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
consumerGroup: 'string'
dataFormat: 'string'
eventHubResourceId: 'string'
mappingRuleName: 'string'
tableName: 'string'
}
}
Property Values
Microsoft.Kusto/clusters/databases/eventhubconnections
| Name | Description | Value |
|---|---|---|
| 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 |
| 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:
- 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/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
Microsoft.Kusto/clusters/databases/eventhubconnections
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-09-07-preview' |
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Class representing the Kusto event hub connection properties. | EventHubConnectionProperties |
| type | The resource type | 'Microsoft.Kusto/clusters/databases/eventhubconnections' |
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 |
Usage Examples
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"
parent_id = "string"
location = "string"
body = {
properties = {
consumerGroup = "string"
dataFormat = "string"
eventHubResourceId = "string"
mappingRuleName = "string"
tableName = "string"
}
}
}
Property Values
Microsoft.Kusto/clusters/databases/eventhubconnections
| Name | Description | Value |
|---|---|---|
| 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 |
| properties | Class representing the Kusto event hub connection properties. | EventHubConnectionProperties |
| type | The resource type | "Microsoft.Kusto/clusters/databases/eventhubconnections@2018-09-07-preview" |
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 |