1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. EventHubDataConnection
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.20.1 published on Friday, Dec 1, 2023 by Pulumi

azure-native.synapse.EventHubDataConnection

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.20.1 published on Friday, Dec 1, 2023 by Pulumi

    Class representing an event hub data connection. Azure REST API version: 2021-06-01-preview.

    Example Usage

    KustoPoolDataConnectionsCreateOrUpdate.json

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var eventHubDataConnection = new AzureNative.Synapse.EventHubDataConnection("eventHubDataConnection", new()
        {
            ConsumerGroup = "testConsumerGroup1",
            DataConnectionName = "DataConnections8",
            DatabaseName = "KustoDatabase8",
            EventHubResourceId = "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
            Kind = "EventHub",
            KustoPoolName = "kustoclusterrptest4",
            Location = "westus",
            ResourceGroupName = "kustorptest",
            WorkspaceName = "synapseWorkspaceName",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := synapse.NewEventHubDataConnection(ctx, "eventHubDataConnection", &synapse.EventHubDataConnectionArgs{
    			ConsumerGroup:      pulumi.String("testConsumerGroup1"),
    			DataConnectionName: pulumi.String("DataConnections8"),
    			DatabaseName:       pulumi.String("KustoDatabase8"),
    			EventHubResourceId: pulumi.String("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
    			Kind:               pulumi.String("EventHub"),
    			KustoPoolName:      pulumi.String("kustoclusterrptest4"),
    			Location:           pulumi.String("westus"),
    			ResourceGroupName:  pulumi.String("kustorptest"),
    			WorkspaceName:      pulumi.String("synapseWorkspaceName"),
    		})
    		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.synapse.EventHubDataConnection;
    import com.pulumi.azurenative.synapse.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 eventHubDataConnection = new EventHubDataConnection("eventHubDataConnection", EventHubDataConnectionArgs.builder()        
                .consumerGroup("testConsumerGroup1")
                .dataConnectionName("DataConnections8")
                .databaseName("KustoDatabase8")
                .eventHubResourceId("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1")
                .kind("EventHub")
                .kustoPoolName("kustoclusterrptest4")
                .location("westus")
                .resourceGroupName("kustorptest")
                .workspaceName("synapseWorkspaceName")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    event_hub_data_connection = azure_native.synapse.EventHubDataConnection("eventHubDataConnection",
        consumer_group="testConsumerGroup1",
        data_connection_name="DataConnections8",
        database_name="KustoDatabase8",
        event_hub_resource_id="/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
        kind="EventHub",
        kusto_pool_name="kustoclusterrptest4",
        location="westus",
        resource_group_name="kustorptest",
        workspace_name="synapseWorkspaceName")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const eventHubDataConnection = new azure_native.synapse.EventHubDataConnection("eventHubDataConnection", {
        consumerGroup: "testConsumerGroup1",
        dataConnectionName: "DataConnections8",
        databaseName: "KustoDatabase8",
        eventHubResourceId: "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1",
        kind: "EventHub",
        kustoPoolName: "kustoclusterrptest4",
        location: "westus",
        resourceGroupName: "kustorptest",
        workspaceName: "synapseWorkspaceName",
    });
    
    resources:
      eventHubDataConnection:
        type: azure-native:synapse:EventHubDataConnection
        properties:
          consumerGroup: testConsumerGroup1
          dataConnectionName: DataConnections8
          databaseName: KustoDatabase8
          eventHubResourceId: /subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1
          kind: EventHub
          kustoPoolName: kustoclusterrptest4
          location: westus
          resourceGroupName: kustorptest
          workspaceName: synapseWorkspaceName
    

    Create EventHubDataConnection Resource

    new EventHubDataConnection(name: string, args: EventHubDataConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def EventHubDataConnection(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               compression: Optional[Union[str, Compression]] = None,
                               consumer_group: Optional[str] = None,
                               data_connection_name: Optional[str] = None,
                               data_format: Optional[Union[str, EventHubDataFormat]] = None,
                               database_name: Optional[str] = None,
                               event_hub_resource_id: Optional[str] = None,
                               event_system_properties: Optional[Sequence[str]] = None,
                               kusto_pool_name: Optional[str] = None,
                               location: Optional[str] = None,
                               managed_identity_resource_id: Optional[str] = None,
                               mapping_rule_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               table_name: Optional[str] = None,
                               workspace_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-native:synapse: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:

    ConsumerGroup string

    The event hub consumer group.

    DatabaseName string

    The name of the database in the Kusto pool.

    EventHubResourceId string

    The resource ID of the event hub to be used to create a data connection.

    KustoPoolName string

    The name of the Kusto pool.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    WorkspaceName string

    The name of the workspace.

    Compression string | Pulumi.AzureNative.Synapse.Compression

    The event hub messages compression type

    DataConnectionName string

    The name of the data connection.

    DataFormat string | Pulumi.AzureNative.Synapse.EventHubDataFormat

    The data format of the message. Optionally the data format can be added to each message.

    EventSystemProperties List<string>

    System properties of the event hub

    Location string

    Resource location.

    ManagedIdentityResourceId string

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

    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.

    ConsumerGroup string

    The event hub consumer group.

    DatabaseName string

    The name of the database in the Kusto pool.

    EventHubResourceId string

    The resource ID of the event hub to be used to create a data connection.

    KustoPoolName string

    The name of the Kusto pool.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    WorkspaceName string

    The name of the workspace.

    Compression string | Compression

    The event hub messages compression type

    DataConnectionName string

    The name of the data connection.

    DataFormat string | EventHubDataFormat

    The data format of the message. Optionally the data format can be added to each message.

    EventSystemProperties []string

    System properties of the event hub

    Location string

    Resource location.

    ManagedIdentityResourceId string

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

    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.

    consumerGroup String

    The event hub consumer group.

    databaseName String

    The name of the database in the Kusto pool.

    eventHubResourceId String

    The resource ID of the event hub to be used to create a data connection.

    kustoPoolName String

    The name of the Kusto pool.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    workspaceName String

    The name of the workspace.

    compression String | Compression

    The event hub messages compression type

    dataConnectionName String

    The name of the data connection.

    dataFormat String | EventHubDataFormat

    The data format of the message. Optionally the data format can be added to each message.

    eventSystemProperties List<String>

    System properties of the event hub

    location String

    Resource location.

    managedIdentityResourceId String

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

    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.

    consumerGroup string

    The event hub consumer group.

    databaseName string

    The name of the database in the Kusto pool.

    eventHubResourceId string

    The resource ID of the event hub to be used to create a data connection.

    kustoPoolName string

    The name of the Kusto pool.

    resourceGroupName string

    The name of the resource group. The name is case insensitive.

    workspaceName string

    The name of the workspace.

    compression string | Compression

    The event hub messages compression type

    dataConnectionName string

    The name of the data connection.

    dataFormat string | EventHubDataFormat

    The data format of the message. Optionally the data format can be added to each message.

    eventSystemProperties string[]

    System properties of the event hub

    location string

    Resource location.

    managedIdentityResourceId string

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

    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.

    consumer_group str

    The event hub consumer group.

    database_name str

    The name of the database in the Kusto pool.

    event_hub_resource_id str

    The resource ID of the event hub to be used to create a data connection.

    kusto_pool_name str

    The name of the Kusto pool.

    resource_group_name str

    The name of the resource group. The name is case insensitive.

    workspace_name str

    The name of the workspace.

    compression str | Compression

    The event hub messages compression type

    data_connection_name str

    The name of the data connection.

    data_format str | EventHubDataFormat

    The data format of the message. Optionally the data format can be added to each message.

    event_system_properties Sequence[str]

    System properties of the event hub

    location str

    Resource location.

    managed_identity_resource_id str

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

    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.

    consumerGroup String

    The event hub consumer group.

    databaseName String

    The name of the database in the Kusto pool.

    eventHubResourceId String

    The resource ID of the event hub to be used to create a data connection.

    kustoPoolName String

    The name of the Kusto pool.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    workspaceName String

    The name of the workspace.

    compression String | "None" | "GZip"

    The event hub messages compression type

    dataConnectionName String

    The name of the data connection.

    dataFormat String | "MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC" | "APACHEAVRO" | "W3CLOGFILE"

    The data format of the message. Optionally the data format can be added to each message.

    eventSystemProperties List<String>

    System properties of the event hub

    location String

    Resource location.

    managedIdentityResourceId String

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

    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 EventHubDataConnection resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    ProvisioningState string

    The provisioned state of the resource.

    SystemData Pulumi.AzureNative.Synapse.Outputs.SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    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

    ProvisioningState string

    The provisioned state of the resource.

    SystemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    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

    provisioningState String

    The provisioned state of the resource.

    systemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    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

    provisioningState string

    The provisioned state of the resource.

    systemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    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

    provisioning_state str

    The provisioned state of the resource.

    system_data SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    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

    provisioningState String

    The provisioned state of the resource.

    systemData Property Map

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    Compression, CompressionArgs

    None
    None
    GZip
    GZip
    CompressionNone
    None
    CompressionGZip
    GZip
    None
    None
    GZip
    GZip
    None
    None
    GZip
    GZip
    NONE
    None
    G_ZIP
    GZip
    "None"
    None
    "GZip"
    GZip

    EventHubDataFormat, EventHubDataFormatArgs

    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    TSV
    TSV
    SCSV
    SCSV
    SOHSV
    SOHSV
    PSV
    PSV
    TXT
    TXT
    RAW
    RAW
    SINGLEJSON
    SINGLEJSON
    AVRO
    AVRO
    TSVE
    TSVE
    PARQUET
    PARQUET
    ORC
    ORC
    APACHEAVRO
    APACHEAVRO
    W3CLOGFILE
    W3CLOGFILE
    EventHubDataFormatMULTIJSON
    MULTIJSON
    EventHubDataFormatJSON
    JSON
    EventHubDataFormatCSV
    CSV
    EventHubDataFormatTSV
    TSV
    EventHubDataFormatSCSV
    SCSV
    EventHubDataFormatSOHSV
    SOHSV
    EventHubDataFormatPSV
    PSV
    EventHubDataFormatTXT
    TXT
    EventHubDataFormatRAW
    RAW
    EventHubDataFormatSINGLEJSON
    SINGLEJSON
    EventHubDataFormatAVRO
    AVRO
    EventHubDataFormatTSVE
    TSVE
    EventHubDataFormatPARQUET
    PARQUET
    EventHubDataFormatORC
    ORC
    EventHubDataFormatAPACHEAVRO
    APACHEAVRO
    EventHubDataFormatW3CLOGFILE
    W3CLOGFILE
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    TSV
    TSV
    SCSV
    SCSV
    SOHSV
    SOHSV
    PSV
    PSV
    TXT
    TXT
    RAW
    RAW
    SINGLEJSON
    SINGLEJSON
    AVRO
    AVRO
    TSVE
    TSVE
    PARQUET
    PARQUET
    ORC
    ORC
    APACHEAVRO
    APACHEAVRO
    W3CLOGFILE
    W3CLOGFILE
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    TSV
    TSV
    SCSV
    SCSV
    SOHSV
    SOHSV
    PSV
    PSV
    TXT
    TXT
    RAW
    RAW
    SINGLEJSON
    SINGLEJSON
    AVRO
    AVRO
    TSVE
    TSVE
    PARQUET
    PARQUET
    ORC
    ORC
    APACHEAVRO
    APACHEAVRO
    W3CLOGFILE
    W3CLOGFILE
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    TSV
    TSV
    SCSV
    SCSV
    SOHSV
    SOHSV
    PSV
    PSV
    TXT
    TXT
    RAW
    RAW
    SINGLEJSON
    SINGLEJSON
    AVRO
    AVRO
    TSVE
    TSVE
    PARQUET
    PARQUET
    ORC
    ORC
    APACHEAVRO
    APACHEAVRO
    W3_CLOGFILE
    W3CLOGFILE
    "MULTIJSON"
    MULTIJSON
    "JSON"
    JSON
    "CSV"
    CSV
    "TSV"
    TSV
    "SCSV"
    SCSV
    "SOHSV"
    SOHSV
    "PSV"
    PSV
    "TXT"
    TXT
    "RAW"
    RAW
    "SINGLEJSON"
    SINGLEJSON
    "AVRO"
    AVRO
    "TSVE"
    TSVE
    "PARQUET"
    PARQUET
    "ORC"
    ORC
    "APACHEAVRO"
    APACHEAVRO
    "W3CLOGFILE"
    W3CLOGFILE

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    createdAt string

    The timestamp of resource creation (UTC).

    createdBy string

    The identity that created the resource.

    createdByType string

    The type of identity that created the resource.

    lastModifiedAt string

    The timestamp of resource last modification (UTC)

    lastModifiedBy string

    The identity that last modified the resource.

    lastModifiedByType string

    The type of identity that last modified the resource.

    created_at str

    The timestamp of resource creation (UTC).

    created_by str

    The identity that created the resource.

    created_by_type str

    The type of identity that created the resource.

    last_modified_at str

    The timestamp of resource last modification (UTC)

    last_modified_by str

    The identity that last modified the resource.

    last_modified_by_type str

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    Import

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

    $ pulumi import azure-native:synapse:EventHubDataConnection KustoClusterRPTest4/KustoDatabase8/DataConnections8 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/dataConnections/{dataConnectionName} 
    

    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.20.1 published on Friday, Dec 1, 2023 by Pulumi