Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. kusto
  5. IotHubDataConnection

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.kusto.IotHubDataConnection

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Kusto (also known as Azure Data Explorer) IotHub Data Connection

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleCluster = new azure.kusto.Cluster("example", {
    name: "examplekustocluster",
    location: example.location,
    resourceGroupName: example.name,
    sku: {
        name: "Standard_D13_v2",
        capacity: 2,
    },
});
const exampleDatabase = new azure.kusto.Database("example", {
    name: "example-kusto-database",
    resourceGroupName: example.name,
    location: example.location,
    clusterName: exampleCluster.name,
    hotCachePeriod: "P7D",
    softDeletePeriod: "P31D",
});
const exampleIoTHub = new azure.iot.IoTHub("example", {
    name: "exampleIoTHub",
    resourceGroupName: example.name,
    location: example.location,
    sku: {
        name: "B1",
        capacity: 1,
    },
});
const exampleSharedAccessPolicy = new azure.iot.SharedAccessPolicy("example", {
    name: "example-shared-access-policy",
    resourceGroupName: example.name,
    iothubName: exampleIoTHub.name,
    registryRead: true,
});
const exampleConsumerGroup = new azure.iot.ConsumerGroup("example", {
    name: "example-consumer-group",
    resourceGroupName: example.name,
    iothubName: exampleIoTHub.name,
    eventhubEndpointName: "events",
});
const exampleIotHubDataConnection = new azure.kusto.IotHubDataConnection("example", {
    name: "my-kusto-iothub-data-connection",
    resourceGroupName: example.name,
    location: example.location,
    clusterName: exampleCluster.name,
    databaseName: exampleDatabase.name,
    iothubId: exampleIoTHub.id,
    consumerGroup: exampleConsumerGroup.name,
    sharedAccessPolicyName: exampleSharedAccessPolicy.name,
    eventSystemProperties: [
        "message-id",
        "sequence-number",
        "to",
    ],
    tableName: "my-table",
    mappingRuleName: "my-table-mapping",
    dataFormat: "JSON",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_cluster = azure.kusto.Cluster("example",
    name="examplekustocluster",
    location=example.location,
    resource_group_name=example.name,
    sku={
        "name": "Standard_D13_v2",
        "capacity": 2,
    })
example_database = azure.kusto.Database("example",
    name="example-kusto-database",
    resource_group_name=example.name,
    location=example.location,
    cluster_name=example_cluster.name,
    hot_cache_period="P7D",
    soft_delete_period="P31D")
example_io_t_hub = azure.iot.IoTHub("example",
    name="exampleIoTHub",
    resource_group_name=example.name,
    location=example.location,
    sku={
        "name": "B1",
        "capacity": 1,
    })
example_shared_access_policy = azure.iot.SharedAccessPolicy("example",
    name="example-shared-access-policy",
    resource_group_name=example.name,
    iothub_name=example_io_t_hub.name,
    registry_read=True)
example_consumer_group = azure.iot.ConsumerGroup("example",
    name="example-consumer-group",
    resource_group_name=example.name,
    iothub_name=example_io_t_hub.name,
    eventhub_endpoint_name="events")
example_iot_hub_data_connection = azure.kusto.IotHubDataConnection("example",
    name="my-kusto-iothub-data-connection",
    resource_group_name=example.name,
    location=example.location,
    cluster_name=example_cluster.name,
    database_name=example_database.name,
    iothub_id=example_io_t_hub.id,
    consumer_group=example_consumer_group.name,
    shared_access_policy_name=example_shared_access_policy.name,
    event_system_properties=[
        "message-id",
        "sequence-number",
        "to",
    ],
    table_name="my-table",
    mapping_rule_name="my-table-mapping",
    data_format="JSON")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/iot"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/kusto"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleCluster, err := kusto.NewCluster(ctx, "example", &kusto.ClusterArgs{
			Name:              pulumi.String("examplekustocluster"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku: &kusto.ClusterSkuArgs{
				Name:     pulumi.String("Standard_D13_v2"),
				Capacity: pulumi.Int(2),
			},
		})
		if err != nil {
			return err
		}
		exampleDatabase, err := kusto.NewDatabase(ctx, "example", &kusto.DatabaseArgs{
			Name:              pulumi.String("example-kusto-database"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			ClusterName:       exampleCluster.Name,
			HotCachePeriod:    pulumi.String("P7D"),
			SoftDeletePeriod:  pulumi.String("P31D"),
		})
		if err != nil {
			return err
		}
		exampleIoTHub, err := iot.NewIoTHub(ctx, "example", &iot.IoTHubArgs{
			Name:              pulumi.String("exampleIoTHub"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Sku: &iot.IoTHubSkuArgs{
				Name:     pulumi.String("B1"),
				Capacity: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		exampleSharedAccessPolicy, err := iot.NewSharedAccessPolicy(ctx, "example", &iot.SharedAccessPolicyArgs{
			Name:              pulumi.String("example-shared-access-policy"),
			ResourceGroupName: example.Name,
			IothubName:        exampleIoTHub.Name,
			RegistryRead:      pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleConsumerGroup, err := iot.NewConsumerGroup(ctx, "example", &iot.ConsumerGroupArgs{
			Name:                 pulumi.String("example-consumer-group"),
			ResourceGroupName:    example.Name,
			IothubName:           exampleIoTHub.Name,
			EventhubEndpointName: pulumi.String("events"),
		})
		if err != nil {
			return err
		}
		_, err = kusto.NewIotHubDataConnection(ctx, "example", &kusto.IotHubDataConnectionArgs{
			Name:                   pulumi.String("my-kusto-iothub-data-connection"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			ClusterName:            exampleCluster.Name,
			DatabaseName:           exampleDatabase.Name,
			IothubId:               exampleIoTHub.ID(),
			ConsumerGroup:          exampleConsumerGroup.Name,
			SharedAccessPolicyName: exampleSharedAccessPolicy.Name,
			EventSystemProperties: pulumi.StringArray{
				pulumi.String("message-id"),
				pulumi.String("sequence-number"),
				pulumi.String("to"),
			},
			TableName:       pulumi.String("my-table"),
			MappingRuleName: pulumi.String("my-table-mapping"),
			DataFormat:      pulumi.String("JSON"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleCluster = new Azure.Kusto.Cluster("example", new()
    {
        Name = "examplekustocluster",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = new Azure.Kusto.Inputs.ClusterSkuArgs
        {
            Name = "Standard_D13_v2",
            Capacity = 2,
        },
    });

    var exampleDatabase = new Azure.Kusto.Database("example", new()
    {
        Name = "example-kusto-database",
        ResourceGroupName = example.Name,
        Location = example.Location,
        ClusterName = exampleCluster.Name,
        HotCachePeriod = "P7D",
        SoftDeletePeriod = "P31D",
    });

    var exampleIoTHub = new Azure.Iot.IoTHub("example", new()
    {
        Name = "exampleIoTHub",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
        {
            Name = "B1",
            Capacity = 1,
        },
    });

    var exampleSharedAccessPolicy = new Azure.Iot.SharedAccessPolicy("example", new()
    {
        Name = "example-shared-access-policy",
        ResourceGroupName = example.Name,
        IothubName = exampleIoTHub.Name,
        RegistryRead = true,
    });

    var exampleConsumerGroup = new Azure.Iot.ConsumerGroup("example", new()
    {
        Name = "example-consumer-group",
        ResourceGroupName = example.Name,
        IothubName = exampleIoTHub.Name,
        EventhubEndpointName = "events",
    });

    var exampleIotHubDataConnection = new Azure.Kusto.IotHubDataConnection("example", new()
    {
        Name = "my-kusto-iothub-data-connection",
        ResourceGroupName = example.Name,
        Location = example.Location,
        ClusterName = exampleCluster.Name,
        DatabaseName = exampleDatabase.Name,
        IothubId = exampleIoTHub.Id,
        ConsumerGroup = exampleConsumerGroup.Name,
        SharedAccessPolicyName = exampleSharedAccessPolicy.Name,
        EventSystemProperties = new[]
        {
            "message-id",
            "sequence-number",
            "to",
        },
        TableName = "my-table",
        MappingRuleName = "my-table-mapping",
        DataFormat = "JSON",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.kusto.Cluster;
import com.pulumi.azure.kusto.ClusterArgs;
import com.pulumi.azure.kusto.inputs.ClusterSkuArgs;
import com.pulumi.azure.kusto.Database;
import com.pulumi.azure.kusto.DatabaseArgs;
import com.pulumi.azure.iot.IoTHub;
import com.pulumi.azure.iot.IoTHubArgs;
import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
import com.pulumi.azure.iot.SharedAccessPolicy;
import com.pulumi.azure.iot.SharedAccessPolicyArgs;
import com.pulumi.azure.iot.ConsumerGroup;
import com.pulumi.azure.iot.ConsumerGroupArgs;
import com.pulumi.azure.kusto.IotHubDataConnection;
import com.pulumi.azure.kusto.IotHubDataConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
            .name("examplekustocluster")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku(ClusterSkuArgs.builder()
                .name("Standard_D13_v2")
                .capacity(2)
                .build())
            .build());

        var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()
            .name("example-kusto-database")
            .resourceGroupName(example.name())
            .location(example.location())
            .clusterName(exampleCluster.name())
            .hotCachePeriod("P7D")
            .softDeletePeriod("P31D")
            .build());

        var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()
            .name("exampleIoTHub")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku(IoTHubSkuArgs.builder()
                .name("B1")
                .capacity("1")
                .build())
            .build());

        var exampleSharedAccessPolicy = new SharedAccessPolicy("exampleSharedAccessPolicy", SharedAccessPolicyArgs.builder()
            .name("example-shared-access-policy")
            .resourceGroupName(example.name())
            .iothubName(exampleIoTHub.name())
            .registryRead(true)
            .build());

        var exampleConsumerGroup = new ConsumerGroup("exampleConsumerGroup", ConsumerGroupArgs.builder()
            .name("example-consumer-group")
            .resourceGroupName(example.name())
            .iothubName(exampleIoTHub.name())
            .eventhubEndpointName("events")
            .build());

        var exampleIotHubDataConnection = new IotHubDataConnection("exampleIotHubDataConnection", IotHubDataConnectionArgs.builder()
            .name("my-kusto-iothub-data-connection")
            .resourceGroupName(example.name())
            .location(example.location())
            .clusterName(exampleCluster.name())
            .databaseName(exampleDatabase.name())
            .iothubId(exampleIoTHub.id())
            .consumerGroup(exampleConsumerGroup.name())
            .sharedAccessPolicyName(exampleSharedAccessPolicy.name())
            .eventSystemProperties(            
                "message-id",
                "sequence-number",
                "to")
            .tableName("my-table")
            .mappingRuleName("my-table-mapping")
            .dataFormat("JSON")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleCluster:
    type: azure:kusto:Cluster
    name: example
    properties:
      name: examplekustocluster
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku:
        name: Standard_D13_v2
        capacity: 2
  exampleDatabase:
    type: azure:kusto:Database
    name: example
    properties:
      name: example-kusto-database
      resourceGroupName: ${example.name}
      location: ${example.location}
      clusterName: ${exampleCluster.name}
      hotCachePeriod: P7D
      softDeletePeriod: P31D
  exampleIoTHub:
    type: azure:iot:IoTHub
    name: example
    properties:
      name: exampleIoTHub
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku:
        name: B1
        capacity: '1'
  exampleSharedAccessPolicy:
    type: azure:iot:SharedAccessPolicy
    name: example
    properties:
      name: example-shared-access-policy
      resourceGroupName: ${example.name}
      iothubName: ${exampleIoTHub.name}
      registryRead: true
  exampleConsumerGroup:
    type: azure:iot:ConsumerGroup
    name: example
    properties:
      name: example-consumer-group
      resourceGroupName: ${example.name}
      iothubName: ${exampleIoTHub.name}
      eventhubEndpointName: events
  exampleIotHubDataConnection:
    type: azure:kusto:IotHubDataConnection
    name: example
    properties:
      name: my-kusto-iothub-data-connection
      resourceGroupName: ${example.name}
      location: ${example.location}
      clusterName: ${exampleCluster.name}
      databaseName: ${exampleDatabase.name}
      iothubId: ${exampleIoTHub.id}
      consumerGroup: ${exampleConsumerGroup.name}
      sharedAccessPolicyName: ${exampleSharedAccessPolicy.name}
      eventSystemProperties:
        - message-id
        - sequence-number
        - to
      tableName: my-table
      mappingRuleName: my-table-mapping
      dataFormat: JSON
Copy

Create IotHubDataConnection Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IotHubDataConnection(name: string, args: IotHubDataConnectionArgs, opts?: CustomResourceOptions);
@overload
def IotHubDataConnection(resource_name: str,
                         args: IotHubDataConnectionArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def IotHubDataConnection(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         iothub_id: Optional[str] = None,
                         consumer_group: Optional[str] = None,
                         database_name: Optional[str] = None,
                         cluster_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         shared_access_policy_name: Optional[str] = None,
                         data_format: Optional[str] = None,
                         database_routing_type: Optional[str] = None,
                         event_system_properties: Optional[Sequence[str]] = None,
                         location: Optional[str] = None,
                         mapping_rule_name: Optional[str] = None,
                         name: Optional[str] = None,
                         table_name: Optional[str] = None)
func NewIotHubDataConnection(ctx *Context, name string, args IotHubDataConnectionArgs, opts ...ResourceOption) (*IotHubDataConnection, error)
public IotHubDataConnection(string name, IotHubDataConnectionArgs args, CustomResourceOptions? opts = null)
public IotHubDataConnection(String name, IotHubDataConnectionArgs args)
public IotHubDataConnection(String name, IotHubDataConnectionArgs args, CustomResourceOptions options)

type: azure:kusto:IotHubDataConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IotHubDataConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IotHubDataConnectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IotHubDataConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IotHubDataConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IotHubDataConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var iotHubDataConnectionResource = new Azure.Kusto.IotHubDataConnection("iotHubDataConnectionResource", new()
{
    IothubId = "string",
    ConsumerGroup = "string",
    DatabaseName = "string",
    ClusterName = "string",
    ResourceGroupName = "string",
    SharedAccessPolicyName = "string",
    DataFormat = "string",
    DatabaseRoutingType = "string",
    EventSystemProperties = new[]
    {
        "string",
    },
    Location = "string",
    MappingRuleName = "string",
    Name = "string",
    TableName = "string",
});
Copy
example, err := kusto.NewIotHubDataConnection(ctx, "iotHubDataConnectionResource", &kusto.IotHubDataConnectionArgs{
	IothubId:               pulumi.String("string"),
	ConsumerGroup:          pulumi.String("string"),
	DatabaseName:           pulumi.String("string"),
	ClusterName:            pulumi.String("string"),
	ResourceGroupName:      pulumi.String("string"),
	SharedAccessPolicyName: pulumi.String("string"),
	DataFormat:             pulumi.String("string"),
	DatabaseRoutingType:    pulumi.String("string"),
	EventSystemProperties: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location:        pulumi.String("string"),
	MappingRuleName: pulumi.String("string"),
	Name:            pulumi.String("string"),
	TableName:       pulumi.String("string"),
})
Copy
var iotHubDataConnectionResource = new IotHubDataConnection("iotHubDataConnectionResource", IotHubDataConnectionArgs.builder()
    .iothubId("string")
    .consumerGroup("string")
    .databaseName("string")
    .clusterName("string")
    .resourceGroupName("string")
    .sharedAccessPolicyName("string")
    .dataFormat("string")
    .databaseRoutingType("string")
    .eventSystemProperties("string")
    .location("string")
    .mappingRuleName("string")
    .name("string")
    .tableName("string")
    .build());
Copy
iot_hub_data_connection_resource = azure.kusto.IotHubDataConnection("iotHubDataConnectionResource",
    iothub_id="string",
    consumer_group="string",
    database_name="string",
    cluster_name="string",
    resource_group_name="string",
    shared_access_policy_name="string",
    data_format="string",
    database_routing_type="string",
    event_system_properties=["string"],
    location="string",
    mapping_rule_name="string",
    name="string",
    table_name="string")
Copy
const iotHubDataConnectionResource = new azure.kusto.IotHubDataConnection("iotHubDataConnectionResource", {
    iothubId: "string",
    consumerGroup: "string",
    databaseName: "string",
    clusterName: "string",
    resourceGroupName: "string",
    sharedAccessPolicyName: "string",
    dataFormat: "string",
    databaseRoutingType: "string",
    eventSystemProperties: ["string"],
    location: "string",
    mappingRuleName: "string",
    name: "string",
    tableName: "string",
});
Copy
type: azure:kusto:IotHubDataConnection
properties:
    clusterName: string
    consumerGroup: string
    dataFormat: string
    databaseName: string
    databaseRoutingType: string
    eventSystemProperties:
        - string
    iothubId: string
    location: string
    mappingRuleName: string
    name: string
    resourceGroupName: string
    sharedAccessPolicyName: string
    tableName: string
Copy

IotHubDataConnection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IotHubDataConnection resource accepts the following input properties:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
ConsumerGroup
This property is required.
Changes to this property will trigger replacement.
string
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
IothubId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
SharedAccessPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
DataFormat Changes to this property will trigger replacement. string
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
DatabaseRoutingType Changes to this property will trigger replacement. string
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
EventSystemProperties Changes to this property will trigger replacement. List<string>
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
Location Changes to this property will trigger replacement. string
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
MappingRuleName Changes to this property will trigger replacement. string
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
TableName Changes to this property will trigger replacement. string
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
ConsumerGroup
This property is required.
Changes to this property will trigger replacement.
string
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
IothubId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
SharedAccessPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
DataFormat Changes to this property will trigger replacement. string
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
DatabaseRoutingType Changes to this property will trigger replacement. string
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
EventSystemProperties Changes to this property will trigger replacement. []string
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
Location Changes to this property will trigger replacement. string
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
MappingRuleName Changes to this property will trigger replacement. string
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
TableName Changes to this property will trigger replacement. string
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
consumerGroup
This property is required.
Changes to this property will trigger replacement.
String
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
iothubId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
sharedAccessPolicyName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
dataFormat Changes to this property will trigger replacement. String
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
databaseRoutingType Changes to this property will trigger replacement. String
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
eventSystemProperties Changes to this property will trigger replacement. List<String>
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
location Changes to this property will trigger replacement. String
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
mappingRuleName Changes to this property will trigger replacement. String
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
tableName Changes to this property will trigger replacement. String
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
consumerGroup
This property is required.
Changes to this property will trigger replacement.
string
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
iothubId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
sharedAccessPolicyName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
dataFormat Changes to this property will trigger replacement. string
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
databaseRoutingType Changes to this property will trigger replacement. string
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
eventSystemProperties Changes to this property will trigger replacement. string[]
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
location Changes to this property will trigger replacement. string
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
mappingRuleName Changes to this property will trigger replacement. string
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
tableName Changes to this property will trigger replacement. string
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
consumer_group
This property is required.
Changes to this property will trigger replacement.
str
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
database_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
iothub_id
This property is required.
Changes to this property will trigger replacement.
str
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
shared_access_policy_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
data_format Changes to this property will trigger replacement. str
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
database_routing_type Changes to this property will trigger replacement. str
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
event_system_properties Changes to this property will trigger replacement. Sequence[str]
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
location Changes to this property will trigger replacement. str
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
mapping_rule_name Changes to this property will trigger replacement. str
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
table_name Changes to this property will trigger replacement. str
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
consumerGroup
This property is required.
Changes to this property will trigger replacement.
String
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
iothubId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
sharedAccessPolicyName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
dataFormat Changes to this property will trigger replacement. String
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
databaseRoutingType Changes to this property will trigger replacement. String
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
eventSystemProperties Changes to this property will trigger replacement. List<String>
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
location Changes to this property will trigger replacement. String
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
mappingRuleName Changes to this property will trigger replacement. String
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
tableName Changes to this property will trigger replacement. String
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the IotHubDataConnection resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing IotHubDataConnection Resource

Get an existing IotHubDataConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IotHubDataConnectionState, opts?: CustomResourceOptions): IotHubDataConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_name: Optional[str] = None,
        consumer_group: Optional[str] = None,
        data_format: Optional[str] = None,
        database_name: Optional[str] = None,
        database_routing_type: Optional[str] = None,
        event_system_properties: Optional[Sequence[str]] = None,
        iothub_id: Optional[str] = None,
        location: Optional[str] = None,
        mapping_rule_name: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        shared_access_policy_name: Optional[str] = None,
        table_name: Optional[str] = None) -> IotHubDataConnection
func GetIotHubDataConnection(ctx *Context, name string, id IDInput, state *IotHubDataConnectionState, opts ...ResourceOption) (*IotHubDataConnection, error)
public static IotHubDataConnection Get(string name, Input<string> id, IotHubDataConnectionState? state, CustomResourceOptions? opts = null)
public static IotHubDataConnection get(String name, Output<String> id, IotHubDataConnectionState state, CustomResourceOptions options)
resources:  _:    type: azure:kusto:IotHubDataConnection    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClusterName Changes to this property will trigger replacement. string
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
ConsumerGroup Changes to this property will trigger replacement. string
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
DataFormat Changes to this property will trigger replacement. string
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
DatabaseName Changes to this property will trigger replacement. string
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
DatabaseRoutingType Changes to this property will trigger replacement. string
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
EventSystemProperties Changes to this property will trigger replacement. List<string>
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
IothubId Changes to this property will trigger replacement. string
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
MappingRuleName Changes to this property will trigger replacement. string
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
SharedAccessPolicyName Changes to this property will trigger replacement. string
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
TableName Changes to this property will trigger replacement. string
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
ClusterName Changes to this property will trigger replacement. string
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
ConsumerGroup Changes to this property will trigger replacement. string
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
DataFormat Changes to this property will trigger replacement. string
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
DatabaseName Changes to this property will trigger replacement. string
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
DatabaseRoutingType Changes to this property will trigger replacement. string
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
EventSystemProperties Changes to this property will trigger replacement. []string
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
IothubId Changes to this property will trigger replacement. string
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
MappingRuleName Changes to this property will trigger replacement. string
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
SharedAccessPolicyName Changes to this property will trigger replacement. string
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
TableName Changes to this property will trigger replacement. string
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
clusterName Changes to this property will trigger replacement. String
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
consumerGroup Changes to this property will trigger replacement. String
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
dataFormat Changes to this property will trigger replacement. String
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
databaseName Changes to this property will trigger replacement. String
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
databaseRoutingType Changes to this property will trigger replacement. String
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
eventSystemProperties Changes to this property will trigger replacement. List<String>
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
iothubId Changes to this property will trigger replacement. String
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
mappingRuleName Changes to this property will trigger replacement. String
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
sharedAccessPolicyName Changes to this property will trigger replacement. String
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
tableName Changes to this property will trigger replacement. String
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
clusterName Changes to this property will trigger replacement. string
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
consumerGroup Changes to this property will trigger replacement. string
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
dataFormat Changes to this property will trigger replacement. string
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
databaseName Changes to this property will trigger replacement. string
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
databaseRoutingType Changes to this property will trigger replacement. string
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
eventSystemProperties Changes to this property will trigger replacement. string[]
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
iothubId Changes to this property will trigger replacement. string
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
mappingRuleName Changes to this property will trigger replacement. string
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
sharedAccessPolicyName Changes to this property will trigger replacement. string
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
tableName Changes to this property will trigger replacement. string
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
cluster_name Changes to this property will trigger replacement. str
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
consumer_group Changes to this property will trigger replacement. str
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
data_format Changes to this property will trigger replacement. str
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
database_name Changes to this property will trigger replacement. str
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
database_routing_type Changes to this property will trigger replacement. str
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
event_system_properties Changes to this property will trigger replacement. Sequence[str]
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
iothub_id Changes to this property will trigger replacement. str
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
mapping_rule_name Changes to this property will trigger replacement. str
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
shared_access_policy_name Changes to this property will trigger replacement. str
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
table_name Changes to this property will trigger replacement. str
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.
clusterName Changes to this property will trigger replacement. String
Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.
consumerGroup Changes to this property will trigger replacement. String
Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
dataFormat Changes to this property will trigger replacement. String
Specifies the data format of the IoTHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT and W3CLOGFILE. Changing this forces a new resource to be created.
databaseName Changes to this property will trigger replacement. String
Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
databaseRoutingType Changes to this property will trigger replacement. String
Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: Single, Multi. Changing this forces a new resource to be created. Defaults to Single.
eventSystemProperties Changes to this property will trigger replacement. List<String>
Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. Possible values are message-id, sequence-number, to, absolute-expiry-time, iothub-enqueuedtime, correlation-id, user-id, iothub-ack, iothub-connection-device-id, iothub-connection-auth-generation-id and iothub-connection-auth-method.
iothubId Changes to this property will trigger replacement. String
Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
The location where the Kusto Database should be created. Changing this forces a new resource to be created.
mappingRuleName Changes to this property will trigger replacement. String
Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
sharedAccessPolicyName Changes to this property will trigger replacement. String
Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created.
tableName Changes to this property will trigger replacement. String
Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created.

Import

Kusto IotHub Data Connections can be imported using the resource id, e.g.

$ pulumi import azure:kusto/iotHubDataConnection:IotHubDataConnection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Kusto/clusters/cluster1/databases/database1/dataConnections/dataConnection1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure