Class EventhubDataConnection

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var rg = new Azure.Core.ResourceGroup("rg", new Azure.Core.ResourceGroupArgs
    {
        Location = "East US",
    });
    var cluster = new Azure.Kusto.Cluster("cluster", new Azure.Kusto.ClusterArgs
    {
        Location = rg.Location,
        ResourceGroupName = rg.Name,
        Sku = new Azure.Kusto.Inputs.ClusterSkuArgs
        {
            Name = "Standard_D13_v2",
            Capacity = 2,
        },
    });
    var database = new Azure.Kusto.Database("database", new Azure.Kusto.DatabaseArgs
    {
        ResourceGroupName = rg.Name,
        Location = rg.Location,
        ClusterName = cluster.Name,
        HotCachePeriod = "P7D",
        SoftDeletePeriod = "P31D",
    });
    var eventhubNs = new Azure.EventHub.EventHubNamespace("eventhubNs", new Azure.EventHub.EventHubNamespaceArgs
    {
        Location = rg.Location,
        ResourceGroupName = rg.Name,
        Sku = "Standard",
    });
    var eventhub = new Azure.EventHub.EventHub("eventhub", new Azure.EventHub.EventHubArgs
    {
        NamespaceName = eventhubNs.Name,
        ResourceGroupName = rg.Name,
        PartitionCount = 1,
        MessageRetention = 1,
    });
    var consumerGroup = new Azure.EventHub.ConsumerGroup("consumerGroup", new Azure.EventHub.ConsumerGroupArgs
    {
        NamespaceName = eventhubNs.Name,
        EventhubName = eventhub.Name,
        ResourceGroupName = rg.Name,
    });
    var eventhubConnection = new Azure.Kusto.EventhubDataConnection("eventhubConnection", new Azure.Kusto.EventhubDataConnectionArgs
    {
        ResourceGroupName = rg.Name,
        Location = rg.Location,
        ClusterName = cluster.Name,
        DatabaseName = database.Name,
        EventhubId = azurerm_eventhub.Evenhub.Id,
        ConsumerGroup = consumerGroup.Name,
        TableName = "my-table",
        MappingRuleName = "my-table-mapping",
        DataFormat = "JSON",
    });
    //(Optional)
}

}

Inheritance

System.Object

Resource

CustomResource

EventhubDataConnection

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Kusto

Assembly: Pulumi.Azure.dll

Syntax

public class EventhubDataConnection : CustomResource

Constructors

EventhubDataConnection(String, EventhubDataConnectionArgs, CustomResourceOptions)

Create a EventhubDataConnection resource with the given unique name, arguments, and options.

Declaration

public EventhubDataConnection(string name, EventhubDataConnectionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EventhubDataConnectionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ClusterName

Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created.

Declaration

public Output<string> ClusterName { get; }

Property Value

Type	Description
Output<System.String>

ConsumerGroup

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

Declaration

public Output<string> ConsumerGroup { get; }

Property Value

Type	Description
Output<System.String>

DatabaseName

Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created.

Declaration

public Output<string> DatabaseName { get; }

Property Value

Type	Description
Output<System.String>

DataFormat

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

Declaration

public Output<string> DataFormat { get; }

Property Value

Type	Description
Output<System.String>

EventhubId

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

Declaration

public Output<string> EventhubId { get; }

Property Value

Type	Description
Output<System.String>

Location

The location where the Kusto Database should be created. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

MappingRuleName

Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created.

Declaration

public Output<string> MappingRuleName { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the Kusto EventHub Data Connection to create. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

TableName

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

Declaration

public Output<string> TableName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, EventhubDataConnectionState, CustomResourceOptions)

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

Declaration

public static EventhubDataConnection Get(string name, Input<string> id, EventhubDataConnectionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EventhubDataConnectionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
EventhubDataConnection