1. Packages
  2. Azure Classic
  3. API Docs
  4. streamanalytics
  5. StreamInputEventHub

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.streamanalytics.StreamInputEventHub

Explore with Pulumi AI

Note: This resource creates a Stream Input of type Microsoft.ServiceBus/EventHub, to create a Stream Input of type Microsoft.EventHub/EventHub please use the resource azurerm_stream_analytics_stream_input_eventhub_v2.

Manages a Stream Analytics Stream Input EventHub.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const example = azure.streamanalytics.getJobOutput({
    name: "example-job",
    resourceGroupName: exampleResourceGroup.name,
});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("example", {
    name: "example-namespace",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
    capacity: 1,
});
const exampleEventHub = new azure.eventhub.EventHub("example", {
    name: "example-eventhub",
    namespaceName: exampleEventHubNamespace.name,
    resourceGroupName: exampleResourceGroup.name,
    partitionCount: 2,
    messageRetention: 1,
});
const exampleConsumerGroup = new azure.eventhub.ConsumerGroup("example", {
    name: "example-consumergroup",
    namespaceName: exampleEventHubNamespace.name,
    eventhubName: exampleEventHub.name,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleStreamInputEventHub = new azure.streamanalytics.StreamInputEventHub("example", {
    name: "eventhub-stream-input",
    streamAnalyticsJobName: example.apply(example => example.name),
    resourceGroupName: example.apply(example => example.resourceGroupName),
    eventhubConsumerGroupName: exampleConsumerGroup.name,
    eventhubName: exampleEventHub.name,
    servicebusNamespace: exampleEventHubNamespace.name,
    sharedAccessPolicyKey: exampleEventHubNamespace.defaultPrimaryKey,
    sharedAccessPolicyName: "RootManageSharedAccessKey",
    serialization: {
        type: "Json",
        encoding: "UTF8",
    },
});
Copy
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example = azure.streamanalytics.get_job_output(name="example-job",
    resource_group_name=example_resource_group.name)
example_event_hub_namespace = azure.eventhub.EventHubNamespace("example",
    name="example-namespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    capacity=1)
example_event_hub = azure.eventhub.EventHub("example",
    name="example-eventhub",
    namespace_name=example_event_hub_namespace.name,
    resource_group_name=example_resource_group.name,
    partition_count=2,
    message_retention=1)
example_consumer_group = azure.eventhub.ConsumerGroup("example",
    name="example-consumergroup",
    namespace_name=example_event_hub_namespace.name,
    eventhub_name=example_event_hub.name,
    resource_group_name=example_resource_group.name)
example_stream_input_event_hub = azure.streamanalytics.StreamInputEventHub("example",
    name="eventhub-stream-input",
    stream_analytics_job_name=example.name,
    resource_group_name=example.resource_group_name,
    eventhub_consumer_group_name=example_consumer_group.name,
    eventhub_name=example_event_hub.name,
    servicebus_namespace=example_event_hub_namespace.name,
    shared_access_policy_key=example_event_hub_namespace.default_primary_key,
    shared_access_policy_name="RootManageSharedAccessKey",
    serialization={
        "type": "Json",
        "encoding": "UTF8",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/eventhub"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/streamanalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		example := streamanalytics.LookupJobOutput(ctx, streamanalytics.GetJobOutputArgs{
			Name:              pulumi.String("example-job"),
			ResourceGroupName: exampleResourceGroup.Name,
		}, nil)
		exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "example", &eventhub.EventHubNamespaceArgs{
			Name:              pulumi.String("example-namespace"),
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("Standard"),
			Capacity:          pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		exampleEventHub, err := eventhub.NewEventHub(ctx, "example", &eventhub.EventHubArgs{
			Name:              pulumi.String("example-eventhub"),
			NamespaceName:     exampleEventHubNamespace.Name,
			ResourceGroupName: exampleResourceGroup.Name,
			PartitionCount:    pulumi.Int(2),
			MessageRetention:  pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		exampleConsumerGroup, err := eventhub.NewConsumerGroup(ctx, "example", &eventhub.ConsumerGroupArgs{
			Name:              pulumi.String("example-consumergroup"),
			NamespaceName:     exampleEventHubNamespace.Name,
			EventhubName:      exampleEventHub.Name,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = streamanalytics.NewStreamInputEventHub(ctx, "example", &streamanalytics.StreamInputEventHubArgs{
			Name: pulumi.String("eventhub-stream-input"),
			StreamAnalyticsJobName: pulumi.String(example.ApplyT(func(example streamanalytics.GetJobResult) (*string, error) {
				return &example.Name, nil
			}).(pulumi.StringPtrOutput)),
			ResourceGroupName: pulumi.String(example.ApplyT(func(example streamanalytics.GetJobResult) (*string, error) {
				return &example.ResourceGroupName, nil
			}).(pulumi.StringPtrOutput)),
			EventhubConsumerGroupName: exampleConsumerGroup.Name,
			EventhubName:              exampleEventHub.Name,
			ServicebusNamespace:       exampleEventHubNamespace.Name,
			SharedAccessPolicyKey:     exampleEventHubNamespace.DefaultPrimaryKey,
			SharedAccessPolicyName:    pulumi.String("RootManageSharedAccessKey"),
			Serialization: &streamanalytics.StreamInputEventHubSerializationArgs{
				Type:     pulumi.String("Json"),
				Encoding: pulumi.String("UTF8"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

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

    var example = Azure.StreamAnalytics.GetJob.Invoke(new()
    {
        Name = "example-job",
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("example", new()
    {
        Name = "example-namespace",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "Standard",
        Capacity = 1,
    });

    var exampleEventHub = new Azure.EventHub.EventHub("example", new()
    {
        Name = "example-eventhub",
        NamespaceName = exampleEventHubNamespace.Name,
        ResourceGroupName = exampleResourceGroup.Name,
        PartitionCount = 2,
        MessageRetention = 1,
    });

    var exampleConsumerGroup = new Azure.EventHub.ConsumerGroup("example", new()
    {
        Name = "example-consumergroup",
        NamespaceName = exampleEventHubNamespace.Name,
        EventhubName = exampleEventHub.Name,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleStreamInputEventHub = new Azure.StreamAnalytics.StreamInputEventHub("example", new()
    {
        Name = "eventhub-stream-input",
        StreamAnalyticsJobName = example.Apply(getJobResult => getJobResult.Name),
        ResourceGroupName = example.Apply(getJobResult => getJobResult.ResourceGroupName),
        EventhubConsumerGroupName = exampleConsumerGroup.Name,
        EventhubName = exampleEventHub.Name,
        ServicebusNamespace = exampleEventHubNamespace.Name,
        SharedAccessPolicyKey = exampleEventHubNamespace.DefaultPrimaryKey,
        SharedAccessPolicyName = "RootManageSharedAccessKey",
        Serialization = new Azure.StreamAnalytics.Inputs.StreamInputEventHubSerializationArgs
        {
            Type = "Json",
            Encoding = "UTF8",
        },
    });

});
Copy
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.streamanalytics.StreamanalyticsFunctions;
import com.pulumi.azure.streamanalytics.inputs.GetJobArgs;
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.streamanalytics.StreamInputEventHub;
import com.pulumi.azure.streamanalytics.StreamInputEventHubArgs;
import com.pulumi.azure.streamanalytics.inputs.StreamInputEventHubSerializationArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        final var example = StreamanalyticsFunctions.getJob(GetJobArgs.builder()
            .name("example-job")
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleEventHubNamespace = new EventHubNamespace("exampleEventHubNamespace", EventHubNamespaceArgs.builder()
            .name("example-namespace")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku("Standard")
            .capacity(1)
            .build());

        var exampleEventHub = new EventHub("exampleEventHub", EventHubArgs.builder()
            .name("example-eventhub")
            .namespaceName(exampleEventHubNamespace.name())
            .resourceGroupName(exampleResourceGroup.name())
            .partitionCount(2)
            .messageRetention(1)
            .build());

        var exampleConsumerGroup = new ConsumerGroup("exampleConsumerGroup", ConsumerGroupArgs.builder()
            .name("example-consumergroup")
            .namespaceName(exampleEventHubNamespace.name())
            .eventhubName(exampleEventHub.name())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleStreamInputEventHub = new StreamInputEventHub("exampleStreamInputEventHub", StreamInputEventHubArgs.builder()
            .name("eventhub-stream-input")
            .streamAnalyticsJobName(example.applyValue(getJobResult -> getJobResult).applyValue(example -> example.applyValue(getJobResult -> getJobResult.name())))
            .resourceGroupName(example.applyValue(getJobResult -> getJobResult).applyValue(example -> example.applyValue(getJobResult -> getJobResult.resourceGroupName())))
            .eventhubConsumerGroupName(exampleConsumerGroup.name())
            .eventhubName(exampleEventHub.name())
            .servicebusNamespace(exampleEventHubNamespace.name())
            .sharedAccessPolicyKey(exampleEventHubNamespace.defaultPrimaryKey())
            .sharedAccessPolicyName("RootManageSharedAccessKey")
            .serialization(StreamInputEventHubSerializationArgs.builder()
                .type("Json")
                .encoding("UTF8")
                .build())
            .build());

    }
}
Copy
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    name: example
    properties:
      name: example-resources
      location: West Europe
  exampleEventHubNamespace:
    type: azure:eventhub:EventHubNamespace
    name: example
    properties:
      name: example-namespace
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: Standard
      capacity: 1
  exampleEventHub:
    type: azure:eventhub:EventHub
    name: example
    properties:
      name: example-eventhub
      namespaceName: ${exampleEventHubNamespace.name}
      resourceGroupName: ${exampleResourceGroup.name}
      partitionCount: 2
      messageRetention: 1
  exampleConsumerGroup:
    type: azure:eventhub:ConsumerGroup
    name: example
    properties:
      name: example-consumergroup
      namespaceName: ${exampleEventHubNamespace.name}
      eventhubName: ${exampleEventHub.name}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleStreamInputEventHub:
    type: azure:streamanalytics:StreamInputEventHub
    name: example
    properties:
      name: eventhub-stream-input
      streamAnalyticsJobName: ${example.name}
      resourceGroupName: ${example.resourceGroupName}
      eventhubConsumerGroupName: ${exampleConsumerGroup.name}
      eventhubName: ${exampleEventHub.name}
      servicebusNamespace: ${exampleEventHubNamespace.name}
      sharedAccessPolicyKey: ${exampleEventHubNamespace.defaultPrimaryKey}
      sharedAccessPolicyName: RootManageSharedAccessKey
      serialization:
        type: Json
        encoding: UTF8
variables:
  example:
    fn::invoke:
      function: azure:streamanalytics:getJob
      arguments:
        name: example-job
        resourceGroupName: ${exampleResourceGroup.name}
Copy

Create StreamInputEventHub Resource

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

Constructor syntax

new StreamInputEventHub(name: string, args: StreamInputEventHubArgs, opts?: CustomResourceOptions);
@overload
def StreamInputEventHub(resource_name: str,
                        args: StreamInputEventHubArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def StreamInputEventHub(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        eventhub_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        serialization: Optional[StreamInputEventHubSerializationArgs] = None,
                        servicebus_namespace: Optional[str] = None,
                        stream_analytics_job_name: Optional[str] = None,
                        authentication_mode: Optional[str] = None,
                        eventhub_consumer_group_name: Optional[str] = None,
                        name: Optional[str] = None,
                        partition_key: Optional[str] = None,
                        shared_access_policy_key: Optional[str] = None,
                        shared_access_policy_name: Optional[str] = None)
func NewStreamInputEventHub(ctx *Context, name string, args StreamInputEventHubArgs, opts ...ResourceOption) (*StreamInputEventHub, error)
public StreamInputEventHub(string name, StreamInputEventHubArgs args, CustomResourceOptions? opts = null)
public StreamInputEventHub(String name, StreamInputEventHubArgs args)
public StreamInputEventHub(String name, StreamInputEventHubArgs args, CustomResourceOptions options)
type: azure:streamanalytics:StreamInputEventHub
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StreamInputEventHubArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StreamInputEventHubArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StreamInputEventHubArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StreamInputEventHubArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StreamInputEventHubArgs
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 streamInputEventHubResource = new Azure.StreamAnalytics.StreamInputEventHub("streamInputEventHubResource", new()
{
    EventhubName = "string",
    ResourceGroupName = "string",
    Serialization = new Azure.StreamAnalytics.Inputs.StreamInputEventHubSerializationArgs
    {
        Type = "string",
        Encoding = "string",
        FieldDelimiter = "string",
    },
    ServicebusNamespace = "string",
    StreamAnalyticsJobName = "string",
    AuthenticationMode = "string",
    EventhubConsumerGroupName = "string",
    Name = "string",
    PartitionKey = "string",
    SharedAccessPolicyKey = "string",
    SharedAccessPolicyName = "string",
});
Copy
example, err := streamanalytics.NewStreamInputEventHub(ctx, "streamInputEventHubResource", &streamanalytics.StreamInputEventHubArgs{
	EventhubName:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Serialization: &streamanalytics.StreamInputEventHubSerializationArgs{
		Type:           pulumi.String("string"),
		Encoding:       pulumi.String("string"),
		FieldDelimiter: pulumi.String("string"),
	},
	ServicebusNamespace:       pulumi.String("string"),
	StreamAnalyticsJobName:    pulumi.String("string"),
	AuthenticationMode:        pulumi.String("string"),
	EventhubConsumerGroupName: pulumi.String("string"),
	Name:                      pulumi.String("string"),
	PartitionKey:              pulumi.String("string"),
	SharedAccessPolicyKey:     pulumi.String("string"),
	SharedAccessPolicyName:    pulumi.String("string"),
})
Copy
var streamInputEventHubResource = new StreamInputEventHub("streamInputEventHubResource", StreamInputEventHubArgs.builder()
    .eventhubName("string")
    .resourceGroupName("string")
    .serialization(StreamInputEventHubSerializationArgs.builder()
        .type("string")
        .encoding("string")
        .fieldDelimiter("string")
        .build())
    .servicebusNamespace("string")
    .streamAnalyticsJobName("string")
    .authenticationMode("string")
    .eventhubConsumerGroupName("string")
    .name("string")
    .partitionKey("string")
    .sharedAccessPolicyKey("string")
    .sharedAccessPolicyName("string")
    .build());
Copy
stream_input_event_hub_resource = azure.streamanalytics.StreamInputEventHub("streamInputEventHubResource",
    eventhub_name="string",
    resource_group_name="string",
    serialization={
        "type": "string",
        "encoding": "string",
        "field_delimiter": "string",
    },
    servicebus_namespace="string",
    stream_analytics_job_name="string",
    authentication_mode="string",
    eventhub_consumer_group_name="string",
    name="string",
    partition_key="string",
    shared_access_policy_key="string",
    shared_access_policy_name="string")
Copy
const streamInputEventHubResource = new azure.streamanalytics.StreamInputEventHub("streamInputEventHubResource", {
    eventhubName: "string",
    resourceGroupName: "string",
    serialization: {
        type: "string",
        encoding: "string",
        fieldDelimiter: "string",
    },
    servicebusNamespace: "string",
    streamAnalyticsJobName: "string",
    authenticationMode: "string",
    eventhubConsumerGroupName: "string",
    name: "string",
    partitionKey: "string",
    sharedAccessPolicyKey: "string",
    sharedAccessPolicyName: "string",
});
Copy
type: azure:streamanalytics:StreamInputEventHub
properties:
    authenticationMode: string
    eventhubConsumerGroupName: string
    eventhubName: string
    name: string
    partitionKey: string
    resourceGroupName: string
    serialization:
        encoding: string
        fieldDelimiter: string
        type: string
    servicebusNamespace: string
    sharedAccessPolicyKey: string
    sharedAccessPolicyName: string
    streamAnalyticsJobName: string
Copy

StreamInputEventHub 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 StreamInputEventHub resource accepts the following input properties:

EventhubName This property is required. string
The name of the Event Hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
Serialization This property is required. StreamInputEventHubSerialization
A serialization block as defined below.
ServicebusNamespace This property is required. string
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
StreamAnalyticsJobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
AuthenticationMode string
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
EventhubConsumerGroupName string
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
Name Changes to this property will trigger replacement. string
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
PartitionKey string
The property the input Event Hub has been partitioned by.
SharedAccessPolicyKey string
The shared access policy key for the specified shared access policy.
SharedAccessPolicyName string
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
EventhubName This property is required. string
The name of the Event Hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
Serialization This property is required. StreamInputEventHubSerializationArgs
A serialization block as defined below.
ServicebusNamespace This property is required. string
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
StreamAnalyticsJobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
AuthenticationMode string
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
EventhubConsumerGroupName string
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
Name Changes to this property will trigger replacement. string
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
PartitionKey string
The property the input Event Hub has been partitioned by.
SharedAccessPolicyKey string
The shared access policy key for the specified shared access policy.
SharedAccessPolicyName string
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
eventhubName This property is required. String
The name of the Event Hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization This property is required. StreamInputEventHubSerialization
A serialization block as defined below.
servicebusNamespace This property is required. String
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
streamAnalyticsJobName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
authenticationMode String
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
eventhubConsumerGroupName String
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
name Changes to this property will trigger replacement. String
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
partitionKey String
The property the input Event Hub has been partitioned by.
sharedAccessPolicyKey String
The shared access policy key for the specified shared access policy.
sharedAccessPolicyName String
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
eventhubName This property is required. string
The name of the Event Hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization This property is required. StreamInputEventHubSerialization
A serialization block as defined below.
servicebusNamespace This property is required. string
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
streamAnalyticsJobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
authenticationMode string
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
eventhubConsumerGroupName string
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
name Changes to this property will trigger replacement. string
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
partitionKey string
The property the input Event Hub has been partitioned by.
sharedAccessPolicyKey string
The shared access policy key for the specified shared access policy.
sharedAccessPolicyName string
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
eventhub_name This property is required. str
The name of the Event Hub.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization This property is required. StreamInputEventHubSerializationArgs
A serialization block as defined below.
servicebus_namespace This property is required. str
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
stream_analytics_job_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
authentication_mode str
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
eventhub_consumer_group_name str
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
name Changes to this property will trigger replacement. str
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
partition_key str
The property the input Event Hub has been partitioned by.
shared_access_policy_key str
The shared access policy key for the specified shared access policy.
shared_access_policy_name str
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
eventhubName This property is required. String
The name of the Event Hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization This property is required. Property Map
A serialization block as defined below.
servicebusNamespace This property is required. String
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
streamAnalyticsJobName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
authenticationMode String
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
eventhubConsumerGroupName String
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
name Changes to this property will trigger replacement. String
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
partitionKey String
The property the input Event Hub has been partitioned by.
sharedAccessPolicyKey String
The shared access policy key for the specified shared access policy.
sharedAccessPolicyName String
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.

Outputs

All input properties are implicitly available as output properties. Additionally, the StreamInputEventHub 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 StreamInputEventHub Resource

Get an existing StreamInputEventHub 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?: StreamInputEventHubState, opts?: CustomResourceOptions): StreamInputEventHub
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_mode: Optional[str] = None,
        eventhub_consumer_group_name: Optional[str] = None,
        eventhub_name: Optional[str] = None,
        name: Optional[str] = None,
        partition_key: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        serialization: Optional[StreamInputEventHubSerializationArgs] = None,
        servicebus_namespace: Optional[str] = None,
        shared_access_policy_key: Optional[str] = None,
        shared_access_policy_name: Optional[str] = None,
        stream_analytics_job_name: Optional[str] = None) -> StreamInputEventHub
func GetStreamInputEventHub(ctx *Context, name string, id IDInput, state *StreamInputEventHubState, opts ...ResourceOption) (*StreamInputEventHub, error)
public static StreamInputEventHub Get(string name, Input<string> id, StreamInputEventHubState? state, CustomResourceOptions? opts = null)
public static StreamInputEventHub get(String name, Output<String> id, StreamInputEventHubState state, CustomResourceOptions options)
resources:  _:    type: azure:streamanalytics:StreamInputEventHub    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AuthenticationMode string
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
EventhubConsumerGroupName string
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
EventhubName string
The name of the Event Hub.
Name Changes to this property will trigger replacement. string
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
PartitionKey string
The property the input Event Hub has been partitioned by.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
Serialization StreamInputEventHubSerialization
A serialization block as defined below.
ServicebusNamespace string
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
SharedAccessPolicyKey string
The shared access policy key for the specified shared access policy.
SharedAccessPolicyName string
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
StreamAnalyticsJobName Changes to this property will trigger replacement. string
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
AuthenticationMode string
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
EventhubConsumerGroupName string
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
EventhubName string
The name of the Event Hub.
Name Changes to this property will trigger replacement. string
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
PartitionKey string
The property the input Event Hub has been partitioned by.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
Serialization StreamInputEventHubSerializationArgs
A serialization block as defined below.
ServicebusNamespace string
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
SharedAccessPolicyKey string
The shared access policy key for the specified shared access policy.
SharedAccessPolicyName string
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
StreamAnalyticsJobName Changes to this property will trigger replacement. string
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
authenticationMode String
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
eventhubConsumerGroupName String
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
eventhubName String
The name of the Event Hub.
name Changes to this property will trigger replacement. String
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
partitionKey String
The property the input Event Hub has been partitioned by.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization StreamInputEventHubSerialization
A serialization block as defined below.
servicebusNamespace String
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
sharedAccessPolicyKey String
The shared access policy key for the specified shared access policy.
sharedAccessPolicyName String
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
streamAnalyticsJobName Changes to this property will trigger replacement. String
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
authenticationMode string
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
eventhubConsumerGroupName string
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
eventhubName string
The name of the Event Hub.
name Changes to this property will trigger replacement. string
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
partitionKey string
The property the input Event Hub has been partitioned by.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization StreamInputEventHubSerialization
A serialization block as defined below.
servicebusNamespace string
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
sharedAccessPolicyKey string
The shared access policy key for the specified shared access policy.
sharedAccessPolicyName string
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
streamAnalyticsJobName Changes to this property will trigger replacement. string
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
authentication_mode str
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
eventhub_consumer_group_name str
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
eventhub_name str
The name of the Event Hub.
name Changes to this property will trigger replacement. str
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
partition_key str
The property the input Event Hub has been partitioned by.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization StreamInputEventHubSerializationArgs
A serialization block as defined below.
servicebus_namespace str
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
shared_access_policy_key str
The shared access policy key for the specified shared access policy.
shared_access_policy_name str
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
stream_analytics_job_name Changes to this property will trigger replacement. str
The name of the Stream Analytics Job. Changing this forces a new resource to be created.
authenticationMode String
The authentication mode for the Stream Output. Possible values are Msi and ConnectionString. Defaults to ConnectionString.
eventhubConsumerGroupName String
The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not set the input will use the Event Hub's default consumer group.
eventhubName String
The name of the Event Hub.
name Changes to this property will trigger replacement. String
The name of the Stream Input EventHub. Changing this forces a new resource to be created.
partitionKey String
The property the input Event Hub has been partitioned by.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.
serialization Property Map
A serialization block as defined below.
servicebusNamespace String
The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.
sharedAccessPolicyKey String
The shared access policy key for the specified shared access policy.
sharedAccessPolicyName String
The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
streamAnalyticsJobName Changes to this property will trigger replacement. String
The name of the Stream Analytics Job. Changing this forces a new resource to be created.

Supporting Types

StreamInputEventHubSerialization
, StreamInputEventHubSerializationArgs

Type This property is required. string
The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.
Encoding string

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

NOTE: This is required when type is set to Csv or Json.

FieldDelimiter string

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

NOTE: This is required when type is set to Csv.

Type This property is required. string
The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.
Encoding string

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

NOTE: This is required when type is set to Csv or Json.

FieldDelimiter string

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

NOTE: This is required when type is set to Csv.

type This property is required. String
The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.
encoding String

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

NOTE: This is required when type is set to Csv or Json.

fieldDelimiter String

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

NOTE: This is required when type is set to Csv.

type This property is required. string
The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.
encoding string

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

NOTE: This is required when type is set to Csv or Json.

fieldDelimiter string

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

NOTE: This is required when type is set to Csv.

type This property is required. str
The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.
encoding str

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

NOTE: This is required when type is set to Csv or Json.

field_delimiter str

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

NOTE: This is required when type is set to Csv.

type This property is required. String
The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.
encoding String

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

NOTE: This is required when type is set to Csv or Json.

fieldDelimiter String

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

NOTE: This is required when type is set to Csv.

Import

Stream Analytics Stream Input EventHub’s can be imported using the resource id, e.g.

$ pulumi import azure:streamanalytics/streamInputEventHub:StreamInputEventHub example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.StreamAnalytics/streamingJobs/job1/inputs/input1
Copy

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.