Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. getEventHubConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.kusto.getEventHubConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns an Event Hub connection.

Uses Azure REST API version 2018-09-07-preview.

Using getEventHubConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEventHubConnection(args: GetEventHubConnectionArgs, opts?: InvokeOptions): Promise<GetEventHubConnectionResult>
function getEventHubConnectionOutput(args: GetEventHubConnectionOutputArgs, opts?: InvokeOptions): Output<GetEventHubConnectionResult>
Copy
def get_event_hub_connection(cluster_name: Optional[str] = None,
                             database_name: Optional[str] = None,
                             event_hub_connection_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetEventHubConnectionResult
def get_event_hub_connection_output(cluster_name: Optional[pulumi.Input[str]] = None,
                             database_name: Optional[pulumi.Input[str]] = None,
                             event_hub_connection_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetEventHubConnectionResult]
Copy
func LookupEventHubConnection(ctx *Context, args *LookupEventHubConnectionArgs, opts ...InvokeOption) (*LookupEventHubConnectionResult, error)
func LookupEventHubConnectionOutput(ctx *Context, args *LookupEventHubConnectionOutputArgs, opts ...InvokeOption) LookupEventHubConnectionResultOutput
Copy

> Note: This function is named LookupEventHubConnection in the Go SDK.

public static class GetEventHubConnection 
{
    public static Task<GetEventHubConnectionResult> InvokeAsync(GetEventHubConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetEventHubConnectionResult> Invoke(GetEventHubConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEventHubConnectionResult> getEventHubConnection(GetEventHubConnectionArgs args, InvokeOptions options)
public static Output<GetEventHubConnectionResult> getEventHubConnection(GetEventHubConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:kusto:getEventHubConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
EventHubConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the event hub connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
EventHubConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the event hub connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
eventHubConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the event hub connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
eventHubConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the event hub connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto cluster.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database in the Kusto cluster.
event_hub_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the event hub connection.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
eventHubConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the event hub connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group containing the Kusto cluster.

getEventHubConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
ConsumerGroup string
The event hub consumer group.
EventHubResourceId string
The resource ID of the event hub to be used to create a data connection.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DataFormat string
The data format of the message. Optionally the data format can be added to each message.
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.
AzureApiVersion string
The Azure API version of the resource.
ConsumerGroup string
The event hub consumer group.
EventHubResourceId string
The resource ID of the event hub to be used to create a data connection.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DataFormat string
The data format of the message. Optionally the data format can be added to each message.
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.
azureApiVersion String
The Azure API version of the resource.
consumerGroup String
The event hub consumer group.
eventHubResourceId String
The resource ID of the event hub to be used to create a data connection.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
dataFormat String
The data format of the message. Optionally the data format can be added to each message.
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.
azureApiVersion string
The Azure API version of the resource.
consumerGroup string
The event hub consumer group.
eventHubResourceId string
The resource ID of the event hub to be used to create a data connection.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
dataFormat string
The data format of the message. Optionally the data format can be added to each message.
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.
azure_api_version str
The Azure API version of the resource.
consumer_group str
The event hub consumer group.
event_hub_resource_id str
The resource ID of the event hub to be used to create a data connection.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
data_format str
The data format of the message. Optionally the data format can be added to each message.
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.
azureApiVersion String
The Azure API version of the resource.
consumerGroup String
The event hub consumer group.
eventHubResourceId String
The resource ID of the event hub to be used to create a data connection.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
dataFormat String
The data format of the message. Optionally the data format can be added to each message.
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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native