azure logo
Azure Classic v5.38.0, Mar 21 23

azure.kusto.EventhubDataConnection

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

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

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

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

    var eventhubNs = new Azure.EventHub.EventHubNamespace("eventhubNs", new()
    {
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "Standard",
    });

    var eventhub = new Azure.EventHub.EventHub("eventhub", new()
    {
        NamespaceName = eventhubNs.Name,
        ResourceGroupName = example.Name,
        PartitionCount = 1,
        MessageRetention = 1,
    });

    var consumerGroup = new Azure.EventHub.ConsumerGroup("consumerGroup", new()
    {
        NamespaceName = eventhubNs.Name,
        EventhubName = eventhub.Name,
        ResourceGroupName = example.Name,
    });

    var eventhubConnection = new Azure.Kusto.EventhubDataConnection("eventhubConnection", new()
    {
        ResourceGroupName = example.Name,
        Location = example.Location,
        ClusterName = cluster.Name,
        DatabaseName = database.Name,
        EventhubId = eventhub.Id,
        ConsumerGroup = consumerGroup.Name,
        TableName = "my-table",
        MappingRuleName = "my-table-mapping",
        DataFormat = "JSON",
    });

    //(Optional)
});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/eventhub"
	"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 {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		cluster, err := kusto.NewCluster(ctx, "cluster", &kusto.ClusterArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku: &kusto.ClusterSkuArgs{
				Name:     pulumi.String("Standard_D13_v2"),
				Capacity: pulumi.Int(2),
			},
		})
		if err != nil {
			return err
		}
		database, err := kusto.NewDatabase(ctx, "database", &kusto.DatabaseArgs{
			ResourceGroupName: example.Name,
			Location:          example.Location,
			ClusterName:       cluster.Name,
			HotCachePeriod:    pulumi.String("P7D"),
			SoftDeletePeriod:  pulumi.String("P31D"),
		})
		if err != nil {
			return err
		}
		eventhubNs, err := eventhub.NewEventHubNamespace(ctx, "eventhubNs", &eventhub.EventHubNamespaceArgs{
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("Standard"),
		})
		if err != nil {
			return err
		}
		eventhub, err := eventhub.NewEventHub(ctx, "eventhub", &eventhub.EventHubArgs{
			NamespaceName:     eventhubNs.Name,
			ResourceGroupName: example.Name,
			PartitionCount:    pulumi.Int(1),
			MessageRetention:  pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		consumerGroup, err := eventhub.NewConsumerGroup(ctx, "consumerGroup", &eventhub.ConsumerGroupArgs{
			NamespaceName:     eventhubNs.Name,
			EventhubName:      eventhub.Name,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		_, err = kusto.NewEventhubDataConnection(ctx, "eventhubConnection", &kusto.EventhubDataConnectionArgs{
			ResourceGroupName: example.Name,
			Location:          example.Location,
			ClusterName:       cluster.Name,
			DatabaseName:      database.Name,
			EventhubId:        eventhub.ID(),
			ConsumerGroup:     consumerGroup.Name,
			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.eventhub.EventHubNamespace;
import com.pulumi.azure.eventhub.EventHubNamespaceArgs;
import com.pulumi.azure.eventhub.EventHub;
import com.pulumi.azure.eventhub.EventHubArgs;
import com.pulumi.azure.eventhub.ConsumerGroup;
import com.pulumi.azure.eventhub.ConsumerGroupArgs;
import com.pulumi.azure.kusto.EventhubDataConnection;
import com.pulumi.azure.kusto.EventhubDataConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

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

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

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

        var eventhubNs = new EventHubNamespace("eventhubNs", EventHubNamespaceArgs.builder()        
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("Standard")
            .build());

        var eventhub = new EventHub("eventhub", EventHubArgs.builder()        
            .namespaceName(eventhubNs.name())
            .resourceGroupName(example.name())
            .partitionCount(1)
            .messageRetention(1)
            .build());

        var consumerGroup = new ConsumerGroup("consumerGroup", ConsumerGroupArgs.builder()        
            .namespaceName(eventhubNs.name())
            .eventhubName(eventhub.name())
            .resourceGroupName(example.name())
            .build());

        var eventhubConnection = new EventhubDataConnection("eventhubConnection", EventhubDataConnectionArgs.builder()        
            .resourceGroupName(example.name())
            .location(example.location())
            .clusterName(cluster.name())
            .databaseName(database.name())
            .eventhubId(eventhub.id())
            .consumerGroup(consumerGroup.name())
            .tableName("my-table")
            .mappingRuleName("my-table-mapping")
            .dataFormat("JSON")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West Europe")
cluster = azure.kusto.Cluster("cluster",
    location=example.location,
    resource_group_name=example.name,
    sku=azure.kusto.ClusterSkuArgs(
        name="Standard_D13_v2",
        capacity=2,
    ))
database = azure.kusto.Database("database",
    resource_group_name=example.name,
    location=example.location,
    cluster_name=cluster.name,
    hot_cache_period="P7D",
    soft_delete_period="P31D")
eventhub_ns = azure.eventhub.EventHubNamespace("eventhubNs",
    location=example.location,
    resource_group_name=example.name,
    sku="Standard")
eventhub = azure.eventhub.EventHub("eventhub",
    namespace_name=eventhub_ns.name,
    resource_group_name=example.name,
    partition_count=1,
    message_retention=1)
consumer_group = azure.eventhub.ConsumerGroup("consumerGroup",
    namespace_name=eventhub_ns.name,
    eventhub_name=eventhub.name,
    resource_group_name=example.name)
eventhub_connection = azure.kusto.EventhubDataConnection("eventhubConnection",
    resource_group_name=example.name,
    location=example.location,
    cluster_name=cluster.name,
    database_name=database.name,
    eventhub_id=eventhub.id,
    consumer_group=consumer_group.name,
    table_name="my-table",
    mapping_rule_name="my-table-mapping",
    data_format="JSON")
#(Optional)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {location: "West Europe"});
const cluster = new azure.kusto.Cluster("cluster", {
    location: example.location,
    resourceGroupName: example.name,
    sku: {
        name: "Standard_D13_v2",
        capacity: 2,
    },
});
const database = new azure.kusto.Database("database", {
    resourceGroupName: example.name,
    location: example.location,
    clusterName: cluster.name,
    hotCachePeriod: "P7D",
    softDeletePeriod: "P31D",
});
const eventhubNs = new azure.eventhub.EventHubNamespace("eventhubNs", {
    location: example.location,
    resourceGroupName: example.name,
    sku: "Standard",
});
const eventhub = new azure.eventhub.EventHub("eventhub", {
    namespaceName: eventhubNs.name,
    resourceGroupName: example.name,
    partitionCount: 1,
    messageRetention: 1,
});
const consumerGroup = new azure.eventhub.ConsumerGroup("consumerGroup", {
    namespaceName: eventhubNs.name,
    eventhubName: eventhub.name,
    resourceGroupName: example.name,
});
const eventhubConnection = new azure.kusto.EventhubDataConnection("eventhubConnection", {
    resourceGroupName: example.name,
    location: example.location,
    clusterName: cluster.name,
    databaseName: database.name,
    eventhubId: eventhub.id,
    consumerGroup: consumerGroup.name,
    tableName: "my-table",
    mappingRuleName: "my-table-mapping",
    dataFormat: "JSON",
});
//(Optional)
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  cluster:
    type: azure:kusto:Cluster
    properties:
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku:
        name: Standard_D13_v2
        capacity: 2
  database:
    type: azure:kusto:Database
    properties:
      resourceGroupName: ${example.name}
      location: ${example.location}
      clusterName: ${cluster.name}
      hotCachePeriod: P7D
      softDeletePeriod: P31D
  eventhubNs:
    type: azure:eventhub:EventHubNamespace
    properties:
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: Standard
  eventhub:
    type: azure:eventhub:EventHub
    properties:
      namespaceName: ${eventhubNs.name}
      resourceGroupName: ${example.name}
      partitionCount: 1
      messageRetention: 1
  consumerGroup:
    type: azure:eventhub:ConsumerGroup
    properties:
      namespaceName: ${eventhubNs.name}
      eventhubName: ${eventhub.name}
      resourceGroupName: ${example.name}
  eventhubConnection:
    type: azure:kusto:EventhubDataConnection
    properties:
      resourceGroupName: ${example.name}
      location: ${example.location}
      clusterName: ${cluster.name}
      databaseName: ${database.name}
      eventhubId: ${eventhub.id}
      consumerGroup: ${consumerGroup.name}
      tableName: my-table
      #(Optional)
      mappingRuleName: my-table-mapping
      #(Optional)
      dataFormat: JSON

Create EventhubDataConnection Resource

new EventhubDataConnection(name: string, args: EventhubDataConnectionArgs, opts?: CustomResourceOptions);
@overload
def EventhubDataConnection(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           cluster_name: Optional[str] = None,
                           compression: 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,
                           eventhub_id: Optional[str] = None,
                           identity_id: Optional[str] = None,
                           location: Optional[str] = None,
                           mapping_rule_name: Optional[str] = None,
                           name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           table_name: Optional[str] = None)
@overload
def EventhubDataConnection(resource_name: str,
                           args: EventhubDataConnectionArgs,
                           opts: Optional[ResourceOptions] = None)
func NewEventhubDataConnection(ctx *Context, name string, args EventhubDataConnectionArgs, opts ...ResourceOption) (*EventhubDataConnection, error)
public EventhubDataConnection(string name, EventhubDataConnectionArgs args, CustomResourceOptions? opts = null)
public EventhubDataConnection(String name, EventhubDataConnectionArgs args)
public EventhubDataConnection(String name, EventhubDataConnectionArgs args, CustomResourceOptions options)
type: azure:kusto:EventhubDataConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EventhubDataConnectionArgs
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 EventhubDataConnectionArgs
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 EventhubDataConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EventhubDataConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EventhubDataConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EventhubDataConnection 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 EventhubDataConnection 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 EventHub 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.

EventhubId string

Specifies the resource id of the EventHub 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.

Compression string

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

DataFormat string

Specifies the data format of the EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, TXT, and W3CLOGFILE.

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 a list of system properties for the Event Hub.

IdentityId string

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

EventhubId string

Specifies the resource id of the EventHub 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.

Compression string

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

DataFormat string

Specifies the data format of the EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, TXT, and W3CLOGFILE.

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 a list of system properties for the Event Hub.

IdentityId string

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

eventhubId String

Specifies the resource id of the EventHub 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.

compression String

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

dataFormat String

Specifies the data format of the EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, TXT, and W3CLOGFILE.

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 a list of system properties for the Event Hub.

identityId String

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

eventhubId string

Specifies the resource id of the EventHub 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.

compression string

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

dataFormat string

Specifies the data format of the EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, TXT, and W3CLOGFILE.

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 a list of system properties for the Event Hub.

identityId string

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

eventhub_id str

Specifies the resource id of the EventHub 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.

compression str

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

data_format str

Specifies the data format of the EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, TXT, and W3CLOGFILE.

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 a list of system properties for the Event Hub.

identity_id str

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

eventhubId String

Specifies the resource id of the EventHub 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.

compression String

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

dataFormat String

Specifies the data format of the EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, TXT, and W3CLOGFILE.

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 a list of system properties for the Event Hub.

identityId String

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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 EventHub 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 EventhubDataConnection 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 EventhubDataConnection Resource

Get an existing EventhubDataConnection 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?: EventhubDataConnectionState, opts?: CustomResourceOptions): EventhubDataConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_name: Optional[str] = None,
        compression: 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,
        eventhub_id: Optional[str] = None,
        identity_id: Optional[str] = None,
        location: Optional[str] = None,
        mapping_rule_name: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        table_name: Optional[str] = None) -> EventhubDataConnection
func GetEventhubDataConnection(ctx *Context, name string, id IDInput, state *EventhubDataConnectionState, opts ...ResourceOption) (*EventhubDataConnection, error)
public static EventhubDataConnection Get(string name, Input<string> id, EventhubDataConnectionState? state, CustomResourceOptions? opts = null)
public static EventhubDataConnection get(String name, Output<String> id, EventhubDataConnectionState 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.

Compression string

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

ConsumerGroup string

Specifies the EventHub 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 EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, 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.

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 a list of system properties for the Event Hub.

EventhubId string

Specifies the resource id of the EventHub this data connection will use for ingestion. Changing this forces a new resource to be created.

IdentityId string

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

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.

Compression string

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

ConsumerGroup string

Specifies the EventHub 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 EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, 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.

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 a list of system properties for the Event Hub.

EventhubId string

Specifies the resource id of the EventHub this data connection will use for ingestion. Changing this forces a new resource to be created.

IdentityId string

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

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.

compression String

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

consumerGroup String

Specifies the EventHub 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 EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, 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.

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 a list of system properties for the Event Hub.

eventhubId String

Specifies the resource id of the EventHub this data connection will use for ingestion. Changing this forces a new resource to be created.

identityId String

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

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.

compression string

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

consumerGroup string

Specifies the EventHub 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 EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, 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.

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 a list of system properties for the Event Hub.

eventhubId string

Specifies the resource id of the EventHub this data connection will use for ingestion. Changing this forces a new resource to be created.

identityId string

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

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.

compression str

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

consumer_group str

Specifies the EventHub 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 EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, 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.

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 a list of system properties for the Event Hub.

eventhub_id str

Specifies the resource id of the EventHub this data connection will use for ingestion. Changing this forces a new resource to be created.

identity_id str

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

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.

compression String

Specifies compression type for the connection. Allowed values: GZip and None. Defaults to None. Changing this forces a new resource to be created.

consumerGroup String

Specifies the EventHub 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 EventHub messages. Allowed values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSVE, TSV, 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.

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 a list of system properties for the Event Hub.

eventhubId String

Specifies the resource id of the EventHub this data connection will use for ingestion. Changing this forces a new resource to be created.

identityId String

The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.

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

tableName String

Specifies the target table name used for the message ingestion. Table must exist before resource is created.

Import

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

 $ pulumi import azure:kusto/eventhubDataConnection:EventhubDataConnection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Kusto/clusters/cluster1/databases/database1/dataConnections/eventHubConnection1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.