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

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

azure.kusto.IotHubDataConnection

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

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

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleCluster = new Azure.Kusto.Cluster("exampleCluster", new()
        {
            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()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            ClusterName = exampleCluster.Name,
            HotCachePeriod = "P7D",
            SoftDeletePeriod = "P31D",
        });
    
        var exampleIoTHub = new Azure.Iot.IoTHub("exampleIoTHub", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
            {
                Name = "B1",
                Capacity = 1,
            },
        });
    
        var exampleSharedAccessPolicy = new Azure.Iot.SharedAccessPolicy("exampleSharedAccessPolicy", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            IothubName = exampleIoTHub.Name,
            RegistryRead = true,
        });
    
        var exampleConsumerGroup = new Azure.Iot.ConsumerGroup("exampleConsumerGroup", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            IothubName = exampleIoTHub.Name,
            EventhubEndpointName = "events",
        });
    
        var exampleIotHubDataConnection = new Azure.Kusto.IotHubDataConnection("exampleIotHubDataConnection", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.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",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/iot"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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
    	})
    }
    
    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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()        
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .sku(ClusterSkuArgs.builder()
                    .name("Standard_D13_v2")
                    .capacity(2)
                    .build())
                .build());
    
            var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .clusterName(exampleCluster.name())
                .hotCachePeriod("P7D")
                .softDeletePeriod("P31D")
                .build());
    
            var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .sku(IoTHubSkuArgs.builder()
                    .name("B1")
                    .capacity("1")
                    .build())
                .build());
    
            var exampleSharedAccessPolicy = new SharedAccessPolicy("exampleSharedAccessPolicy", SharedAccessPolicyArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .iothubName(exampleIoTHub.name())
                .registryRead(true)
                .build());
    
            var exampleConsumerGroup = new ConsumerGroup("exampleConsumerGroup", ConsumerGroupArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .iothubName(exampleIoTHub.name())
                .eventhubEndpointName("events")
                .build());
    
            var exampleIotHubDataConnection = new IotHubDataConnection("exampleIotHubDataConnection", IotHubDataConnectionArgs.builder()        
                .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")
                .build());
    
        }
    }
    
    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")
    
    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",
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleCluster:
        type: azure:kusto:Cluster
        properties:
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
          sku:
            name: Standard_D13_v2
            capacity: 2
      exampleDatabase:
        type: azure:kusto:Database
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          clusterName: ${exampleCluster.name}
          hotCachePeriod: P7D
          softDeletePeriod: P31D
      exampleIoTHub:
        type: azure:iot:IoTHub
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          sku:
            name: B1
            capacity: '1'
      exampleSharedAccessPolicy:
        type: azure:iot:SharedAccessPolicy
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          iothubName: ${exampleIoTHub.name}
          registryRead: true
      exampleConsumerGroup:
        type: azure:iot:ConsumerGroup
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          iothubName: ${exampleIoTHub.name}
          eventhubEndpointName: events
      exampleIotHubDataConnection:
        type: azure:kusto:IotHubDataConnection
        properties:
          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
    

    Create IotHubDataConnection Resource

    new IotHubDataConnection(name: string, args: IotHubDataConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def IotHubDataConnection(resource_name: 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)
    @overload
    def IotHubDataConnection(resource_name: str,
                             args: IotHubDataConnectionArgs,
                             opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    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. Changing this forces a new resource to be created.

    DatabaseRoutingType 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.

    EventSystemProperties 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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be created.

    DatabaseRoutingType 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.

    EventSystemProperties []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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be created.

    databaseRoutingType 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.

    eventSystemProperties 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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be created.

    databaseRoutingType 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.

    eventSystemProperties 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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be created.

    database_routing_type 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.

    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. 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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be created.

    databaseRoutingType 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.

    eventSystemProperties 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 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. Changing this forces a new resource to be 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. 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)
    Resource lookup is not supported in YAML
    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. 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.

    DatabaseRoutingType 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.

    EventSystemProperties 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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. 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.

    DatabaseRoutingType 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.

    EventSystemProperties []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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. 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.

    databaseRoutingType 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.

    eventSystemProperties 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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. 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.

    databaseRoutingType 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.

    eventSystemProperties 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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. 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.

    database_routing_type 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.

    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. 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 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. Changing this forces a new resource to be 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. Changing this forces a new resource to be 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. 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.

    databaseRoutingType 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.

    eventSystemProperties 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 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. Changing this forces a new resource to be 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. 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
    

    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.

    Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi