1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. EventHubConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.75.0 published on Saturday, Nov 30, 2024 by Pulumi

azure-native.kusto.EventHubConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.75.0 published on Saturday, Nov 30, 2024 by Pulumi

    Class representing an event hub connection. Azure REST API version: 2018-09-07-preview. Prior API version in Azure Native 1.x: 2018-09-07-preview.

    Example Usage

    KustoEventHubConnectionsCreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var eventHubConnection = new AzureNative.Kusto.EventHubConnection("eventHubConnection", new()
        {
            ClusterName = "KustoClusterRPTest4",
            ConsumerGroup = "testConsumerGroup1",
            DatabaseName = "KustoDatabase8",
            EventHubConnectionName = "kustoeventhubconnection1",
            EventHubResourceId = "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
            Location = "westus",
            ResourceGroupName = "kustorptest",
        });
    
    });
    
    package main
    
    import (
    	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := kusto.NewEventHubConnection(ctx, "eventHubConnection", &kusto.EventHubConnectionArgs{
    			ClusterName:            pulumi.String("KustoClusterRPTest4"),
    			ConsumerGroup:          pulumi.String("testConsumerGroup1"),
    			DatabaseName:           pulumi.String("KustoDatabase8"),
    			EventHubConnectionName: pulumi.String("kustoeventhubconnection1"),
    			EventHubResourceId:     pulumi.String("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
    			Location:               pulumi.String("westus"),
    			ResourceGroupName:      pulumi.String("kustorptest"),
    		})
    		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.azurenative.kusto.EventHubConnection;
    import com.pulumi.azurenative.kusto.EventHubConnectionArgs;
    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 eventHubConnection = new EventHubConnection("eventHubConnection", EventHubConnectionArgs.builder()
                .clusterName("KustoClusterRPTest4")
                .consumerGroup("testConsumerGroup1")
                .databaseName("KustoDatabase8")
                .eventHubConnectionName("kustoeventhubconnection1")
                .eventHubResourceId("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1")
                .location("westus")
                .resourceGroupName("kustorptest")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    event_hub_connection = azure_native.kusto.EventHubConnection("eventHubConnection",
        cluster_name="KustoClusterRPTest4",
        consumer_group="testConsumerGroup1",
        database_name="KustoDatabase8",
        event_hub_connection_name="kustoeventhubconnection1",
        event_hub_resource_id="/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
        location="westus",
        resource_group_name="kustorptest")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const eventHubConnection = new azure_native.kusto.EventHubConnection("eventHubConnection", {
        clusterName: "KustoClusterRPTest4",
        consumerGroup: "testConsumerGroup1",
        databaseName: "KustoDatabase8",
        eventHubConnectionName: "kustoeventhubconnection1",
        eventHubResourceId: "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
        location: "westus",
        resourceGroupName: "kustorptest",
    });
    
    resources:
      eventHubConnection:
        type: azure-native:kusto:EventHubConnection
        properties:
          clusterName: KustoClusterRPTest4
          consumerGroup: testConsumerGroup1
          databaseName: KustoDatabase8
          eventHubConnectionName: kustoeventhubconnection1
          eventHubResourceId: /subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1
          location: westus
          resourceGroupName: kustorptest
    

    Create EventHubConnection Resource

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

    Constructor syntax

    new EventHubConnection(name: string, args: EventHubConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def EventHubConnection(resource_name: str,
                           args: EventHubConnectionArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def EventHubConnection(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           cluster_name: Optional[str] = None,
                           consumer_group: Optional[str] = None,
                           database_name: Optional[str] = None,
                           event_hub_resource_id: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           data_format: Optional[Union[str, DataFormat]] = None,
                           event_hub_connection_name: Optional[str] = None,
                           location: Optional[str] = None,
                           mapping_rule_name: Optional[str] = None,
                           table_name: Optional[str] = None)
    func NewEventHubConnection(ctx *Context, name string, args EventHubConnectionArgs, opts ...ResourceOption) (*EventHubConnection, error)
    public EventHubConnection(string name, EventHubConnectionArgs args, CustomResourceOptions? opts = null)
    public EventHubConnection(String name, EventHubConnectionArgs args)
    public EventHubConnection(String name, EventHubConnectionArgs args, CustomResourceOptions options)
    
    type: azure-native:kusto:EventHubConnection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

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

    var eventHubConnectionResource = new AzureNative.Kusto.EventHubConnection("eventHubConnectionResource", new()
    {
        ClusterName = "string",
        ConsumerGroup = "string",
        DatabaseName = "string",
        EventHubResourceId = "string",
        ResourceGroupName = "string",
        DataFormat = "string",
        EventHubConnectionName = "string",
        Location = "string",
        MappingRuleName = "string",
        TableName = "string",
    });
    
    example, err := kusto.NewEventHubConnection(ctx, "eventHubConnectionResource", &kusto.EventHubConnectionArgs{
    	ClusterName:            pulumi.String("string"),
    	ConsumerGroup:          pulumi.String("string"),
    	DatabaseName:           pulumi.String("string"),
    	EventHubResourceId:     pulumi.String("string"),
    	ResourceGroupName:      pulumi.String("string"),
    	DataFormat:             pulumi.String("string"),
    	EventHubConnectionName: pulumi.String("string"),
    	Location:               pulumi.String("string"),
    	MappingRuleName:        pulumi.String("string"),
    	TableName:              pulumi.String("string"),
    })
    
    var eventHubConnectionResource = new EventHubConnection("eventHubConnectionResource", EventHubConnectionArgs.builder()
        .clusterName("string")
        .consumerGroup("string")
        .databaseName("string")
        .eventHubResourceId("string")
        .resourceGroupName("string")
        .dataFormat("string")
        .eventHubConnectionName("string")
        .location("string")
        .mappingRuleName("string")
        .tableName("string")
        .build());
    
    event_hub_connection_resource = azure_native.kusto.EventHubConnection("eventHubConnectionResource",
        cluster_name="string",
        consumer_group="string",
        database_name="string",
        event_hub_resource_id="string",
        resource_group_name="string",
        data_format="string",
        event_hub_connection_name="string",
        location="string",
        mapping_rule_name="string",
        table_name="string")
    
    const eventHubConnectionResource = new azure_native.kusto.EventHubConnection("eventHubConnectionResource", {
        clusterName: "string",
        consumerGroup: "string",
        databaseName: "string",
        eventHubResourceId: "string",
        resourceGroupName: "string",
        dataFormat: "string",
        eventHubConnectionName: "string",
        location: "string",
        mappingRuleName: "string",
        tableName: "string",
    });
    
    type: azure-native:kusto:EventHubConnection
    properties:
        clusterName: string
        consumerGroup: string
        dataFormat: string
        databaseName: string
        eventHubConnectionName: string
        eventHubResourceId: string
        location: string
        mappingRuleName: string
        resourceGroupName: string
        tableName: string
    

    EventHubConnection Resource Properties

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

    Inputs

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

    The EventHubConnection resource accepts the following input properties:

    ClusterName string
    The name of the Kusto cluster.
    ConsumerGroup string
    The event hub consumer group.
    DatabaseName string
    The name of the database in the Kusto cluster.
    EventHubResourceId string
    The resource ID of the event hub to be used to create a data connection.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    DataFormat string | Pulumi.AzureNative.Kusto.DataFormat
    The data format of the message. Optionally the data format can be added to each message.
    EventHubConnectionName string
    The name of the event hub connection.
    Location string
    Resource location.
    MappingRuleName string
    The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
    TableName string
    The table where the data should be ingested. Optionally the table information can be added to each message.
    ClusterName string
    The name of the Kusto cluster.
    ConsumerGroup string
    The event hub consumer group.
    DatabaseName string
    The name of the database in the Kusto cluster.
    EventHubResourceId string
    The resource ID of the event hub to be used to create a data connection.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    DataFormat string | DataFormat
    The data format of the message. Optionally the data format can be added to each message.
    EventHubConnectionName string
    The name of the event hub connection.
    Location string
    Resource location.
    MappingRuleName string
    The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
    TableName string
    The table where the data should be ingested. Optionally the table information can be added to each message.
    clusterName String
    The name of the Kusto cluster.
    consumerGroup String
    The event hub consumer group.
    databaseName String
    The name of the database in the Kusto cluster.
    eventHubResourceId String
    The resource ID of the event hub to be used to create a data connection.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    dataFormat String | DataFormat
    The data format of the message. Optionally the data format can be added to each message.
    eventHubConnectionName String
    The name of the event hub connection.
    location String
    Resource location.
    mappingRuleName String
    The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
    tableName String
    The table where the data should be ingested. Optionally the table information can be added to each message.
    clusterName string
    The name of the Kusto cluster.
    consumerGroup string
    The event hub consumer group.
    databaseName string
    The name of the database in the Kusto cluster.
    eventHubResourceId string
    The resource ID of the event hub to be used to create a data connection.
    resourceGroupName string
    The name of the resource group containing the Kusto cluster.
    dataFormat string | DataFormat
    The data format of the message. Optionally the data format can be added to each message.
    eventHubConnectionName string
    The name of the event hub connection.
    location string
    Resource location.
    mappingRuleName string
    The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
    tableName string
    The table where the data should be ingested. Optionally the table information can be added to each message.
    cluster_name str
    The name of the Kusto cluster.
    consumer_group str
    The event hub consumer group.
    database_name str
    The name of the database in the Kusto cluster.
    event_hub_resource_id str
    The resource ID of the event hub to be used to create a data connection.
    resource_group_name str
    The name of the resource group containing the Kusto cluster.
    data_format str | DataFormat
    The data format of the message. Optionally the data format can be added to each message.
    event_hub_connection_name str
    The name of the event hub connection.
    location str
    Resource location.
    mapping_rule_name str
    The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
    table_name str
    The table where the data should be ingested. Optionally the table information can be added to each message.
    clusterName String
    The name of the Kusto cluster.
    consumerGroup String
    The event hub consumer group.
    databaseName String
    The name of the database in the Kusto cluster.
    eventHubResourceId String
    The resource ID of the event hub to be used to create a data connection.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    dataFormat String | "MULTIJSON" | "JSON" | "CSV"
    The data format of the message. Optionally the data format can be added to each message.
    eventHubConnectionName String
    The name of the event hub connection.
    location String
    Resource location.
    mappingRuleName String
    The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
    tableName String
    The table where the data should be ingested. Optionally the table information can be added to each message.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    DataFormat, DataFormatArgs

    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    DataFormatMULTIJSON
    MULTIJSON
    DataFormatJSON
    JSON
    DataFormatCSV
    CSV
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    "MULTIJSON"
    MULTIJSON
    "JSON"
    JSON
    "CSV"
    CSV

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:kusto:EventHubConnection KustoClusterRPTest4/KustoDatabase8 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.75.0 published on Saturday, Nov 30, 2024 by Pulumi