1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. kusto
  6. IotHubDataConnection

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

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

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
            {
                Location = "West Europe",
            });
            var exampleCluster = new Azure.Kusto.Cluster("exampleCluster", new Azure.Kusto.ClusterArgs
            {
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
                Sku = new Azure.Kusto.Inputs.ClusterSkuArgs
                {
                    Name = "Standard_D13_v2",
                    Capacity = 2,
                },
            });
            var exampleDatabase = new Azure.Kusto.Database("exampleDatabase", new Azure.Kusto.DatabaseArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                Location = exampleResourceGroup.Location,
                ClusterName = exampleCluster.Name,
                HotCachePeriod = "P7D",
                SoftDeletePeriod = "P31D",
            });
            var exampleIoTHub = new Azure.Iot.IoTHub("exampleIoTHub", new Azure.Iot.IoTHubArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                Location = exampleResourceGroup.Location,
                Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
                {
                    Name = "B1",
                    Capacity = 1,
                },
            });
            var exampleSharedAccessPolicy = new Azure.Iot.SharedAccessPolicy("exampleSharedAccessPolicy", new Azure.Iot.SharedAccessPolicyArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                IothubName = exampleIoTHub.Name,
                RegistryRead = true,
            });
            var exampleConsumerGroup = new Azure.Iot.ConsumerGroup("exampleConsumerGroup", new Azure.Iot.ConsumerGroupArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                IothubName = exampleIoTHub.Name,
                EventhubEndpointName = "events",
            });
            var exampleIotHubDataConnection = new Azure.Kusto.IotHubDataConnection("exampleIotHubDataConnection", new Azure.Kusto.IotHubDataConnectionArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                Location = exampleResourceGroup.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",
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/iot"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/kusto"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleCluster, err := kusto.NewCluster(ctx, "exampleCluster", &kusto.ClusterArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			Sku: &kusto.ClusterSkuArgs{
    				Name:     pulumi.String("Standard_D13_v2"),
    				Capacity: pulumi.Int(2),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleDatabase, err := kusto.NewDatabase(ctx, "exampleDatabase", &kusto.DatabaseArgs{
    			ResourceGroupName: exampleResourceGroup.Name,
    			Location:          exampleResourceGroup.Location,
    			ClusterName:       exampleCluster.Name,
    			HotCachePeriod:    pulumi.String("P7D"),
    			SoftDeletePeriod:  pulumi.String("P31D"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleIoTHub, err := iot.NewIoTHub(ctx, "exampleIoTHub", &iot.IoTHubArgs{
    			ResourceGroupName: exampleResourceGroup.Name,
    			Location:          exampleResourceGroup.Location,
    			Sku: &iot.IoTHubSkuArgs{
    				Name:     pulumi.String("B1"),
    				Capacity: pulumi.Int(1),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleSharedAccessPolicy, err := iot.NewSharedAccessPolicy(ctx, "exampleSharedAccessPolicy", &iot.SharedAccessPolicyArgs{
    			ResourceGroupName: exampleResourceGroup.Name,
    			IothubName:        exampleIoTHub.Name,
    			RegistryRead:      pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		exampleConsumerGroup, err := iot.NewConsumerGroup(ctx, "exampleConsumerGroup", &iot.ConsumerGroupArgs{
    			ResourceGroupName:    exampleResourceGroup.Name,
    			IothubName:           exampleIoTHub.Name,
    			EventhubEndpointName: pulumi.String("events"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = kusto.NewIotHubDataConnection(ctx, "exampleIotHubDataConnection", &kusto.IotHubDataConnectionArgs{
    			ResourceGroupName:      exampleResourceGroup.Name,
    			Location:               exampleResourceGroup.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
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleCluster = new azure.kusto.Cluster("exampleCluster", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        sku: {
            name: "Standard_D13_v2",
            capacity: 2,
        },
    });
    const exampleDatabase = new azure.kusto.Database("exampleDatabase", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        clusterName: exampleCluster.name,
        hotCachePeriod: "P7D",
        softDeletePeriod: "P31D",
    });
    const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        sku: {
            name: "B1",
            capacity: "1",
        },
    });
    const exampleSharedAccessPolicy = new azure.iot.SharedAccessPolicy("exampleSharedAccessPolicy", {
        resourceGroupName: exampleResourceGroup.name,
        iothubName: exampleIoTHub.name,
        registryRead: true,
    });
    const exampleConsumerGroup = new azure.iot.ConsumerGroup("exampleConsumerGroup", {
        resourceGroupName: exampleResourceGroup.name,
        iothubName: exampleIoTHub.name,
        eventhubEndpointName: "events",
    });
    const exampleIotHubDataConnection = new azure.kusto.IotHubDataConnection("exampleIotHubDataConnection", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.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",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_cluster = azure.kusto.Cluster("exampleCluster",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        sku=azure.kusto.ClusterSkuArgs(
            name="Standard_D13_v2",
            capacity=2,
        ))
    example_database = azure.kusto.Database("exampleDatabase",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        cluster_name=example_cluster.name,
        hot_cache_period="P7D",
        soft_delete_period="P31D")
    example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        sku=azure.iot.IoTHubSkuArgs(
            name="B1",
            capacity=1,
        ))
    example_shared_access_policy = azure.iot.SharedAccessPolicy("exampleSharedAccessPolicy",
        resource_group_name=example_resource_group.name,
        iothub_name=example_io_t_hub.name,
        registry_read=True)
    example_consumer_group = azure.iot.ConsumerGroup("exampleConsumerGroup",
        resource_group_name=example_resource_group.name,
        iothub_name=example_io_t_hub.name,
        eventhub_endpoint_name="events")
    example_iot_hub_data_connection = azure.kusto.IotHubDataConnection("exampleIotHubDataConnection",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.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")
    

    Example coming soon!

    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,
                             cluster_name: Optional[str] = None,
                             consumer_group: Optional[str] = None,
                             database_name: Optional[str] = None,
                             iothub_id: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             shared_access_policy_name: Optional[str] = None,
                             data_format: 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 string
    The unique name of the resource.
    args IotHubDataConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args IotHubDataConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IotHubDataConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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()
    {
        ClusterName = "string",
        ConsumerGroup = "string",
        DatabaseName = "string",
        IothubId = "string",
        ResourceGroupName = "string",
        SharedAccessPolicyName = "string",
        DataFormat = "string",
        EventSystemProperties = new[]
        {
            "string",
        },
        Location = "string",
        MappingRuleName = "string",
        Name = "string",
        TableName = "string",
    });
    
    example, err := kusto.NewIotHubDataConnection(ctx, "iotHubDataConnectionResource", &kusto.IotHubDataConnectionArgs{
    	ClusterName:            pulumi.String("string"),
    	ConsumerGroup:          pulumi.String("string"),
    	DatabaseName:           pulumi.String("string"),
    	IothubId:               pulumi.String("string"),
    	ResourceGroupName:      pulumi.String("string"),
    	SharedAccessPolicyName: pulumi.String("string"),
    	DataFormat:             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"),
    })
    
    var iotHubDataConnectionResource = new IotHubDataConnection("iotHubDataConnectionResource", IotHubDataConnectionArgs.builder()
        .clusterName("string")
        .consumerGroup("string")
        .databaseName("string")
        .iothubId("string")
        .resourceGroupName("string")
        .sharedAccessPolicyName("string")
        .dataFormat("string")
        .eventSystemProperties("string")
        .location("string")
        .mappingRuleName("string")
        .name("string")
        .tableName("string")
        .build());
    
    iot_hub_data_connection_resource = azure.kusto.IotHubDataConnection("iotHubDataConnectionResource",
        cluster_name="string",
        consumer_group="string",
        database_name="string",
        iothub_id="string",
        resource_group_name="string",
        shared_access_policy_name="string",
        data_format="string",
        event_system_properties=["string"],
        location="string",
        mapping_rule_name="string",
        name="string",
        table_name="string")
    
    const iotHubDataConnectionResource = new azure.kusto.IotHubDataConnection("iotHubDataConnectionResource", {
        clusterName: "string",
        consumerGroup: "string",
        databaseName: "string",
        iothubId: "string",
        resourceGroupName: "string",
        sharedAccessPolicyName: "string",
        dataFormat: "string",
        eventSystemProperties: ["string"],
        location: "string",
        mappingRuleName: "string",
        name: "string",
        tableName: "string",
    });
    
    type: azure:kusto:IotHubDataConnection
    properties:
        clusterName: string
        consumerGroup: string
        dataFormat: string
        databaseName: string
        eventSystemProperties:
            - string
        iothubId: string
        location: string
        mappingRuleName: string
        name: string
        resourceGroupName: string
        sharedAccessPolicyName: string
        tableName: string
    

    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 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 string
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    DatabaseName 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 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 string
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    SharedAccessPolicyName 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 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.
    EventSystemProperties List<string>
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    Location string
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    MappingRuleName string
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    Name string
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    TableName string
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    ClusterName 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 string
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    DatabaseName 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 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 string
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    SharedAccessPolicyName 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 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.
    EventSystemProperties []string
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    Location string
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    MappingRuleName string
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    Name string
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    TableName string
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    clusterName 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 String
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    databaseName 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 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 String
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    sharedAccessPolicyName 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 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.
    eventSystemProperties List<String>
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    location String
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    mappingRuleName String
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    name String
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    tableName String
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    clusterName 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 string
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    databaseName 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 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 string
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    sharedAccessPolicyName 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 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.
    eventSystemProperties string[]
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    location string
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    mappingRuleName string
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    name string
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    tableName string
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    cluster_name 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 str
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    database_name 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 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 str
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    shared_access_policy_name 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 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.
    event_system_properties Sequence[str]
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    location str
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    mapping_rule_name str
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    name str
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    table_name str
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    clusterName 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 String
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    databaseName 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 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 String
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    sharedAccessPolicyName 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 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.
    eventSystemProperties List<String>
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    location String
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    mappingRuleName String
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    name String
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    tableName String
    Specifies the target table name used for the message ingestion. Table must exist before resource is 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,
            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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 string
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    DataFormat 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.
    DatabaseName string
    Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
    EventSystemProperties List<string>
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    IothubId 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 string
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    MappingRuleName string
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    Name string
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    ResourceGroupName string
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    SharedAccessPolicyName 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 string
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    ClusterName 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 string
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    DataFormat 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.
    DatabaseName string
    Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
    EventSystemProperties []string
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    IothubId 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 string
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    MappingRuleName string
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    Name string
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    ResourceGroupName string
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    SharedAccessPolicyName 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 string
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    clusterName 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 String
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    dataFormat 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.
    databaseName String
    Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
    eventSystemProperties List<String>
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    iothubId 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 String
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    mappingRuleName String
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    name String
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    resourceGroupName String
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    sharedAccessPolicyName 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 String
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    clusterName 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 string
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    dataFormat 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.
    databaseName string
    Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
    eventSystemProperties string[]
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    iothubId 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 string
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    mappingRuleName string
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    name string
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    resourceGroupName string
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    sharedAccessPolicyName 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 string
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    cluster_name 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 str
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    data_format 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.
    database_name str
    Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
    event_system_properties Sequence[str]
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    iothub_id 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 str
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    mapping_rule_name str
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    name str
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    resource_group_name str
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    shared_access_policy_name 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 str
    Specifies the target table name used for the message ingestion. Table must exist before resource is created.
    clusterName 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 String
    Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created.
    dataFormat 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.
    databaseName String
    Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.
    eventSystemProperties List<String>
    Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created.
    iothubId 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 String
    The location where the Kusto Database should be created. Changing this forces a new resource to be created.
    mappingRuleName String
    Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.
    name String
    The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created.
    resourceGroupName String
    Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.
    sharedAccessPolicyName 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 String
    Specifies the target table name used for the message ingestion. Table must exist before resource is 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
    

    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.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial