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

We recommend using Azure Native.

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

azure.streamanalytics.StreamInputIotHub

Explore with Pulumi AI

Manages a Stream Analytics Stream Input IoTHub.

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 exampleIoTHub = new azure.iot.IoTHub("example", {
    name: "example-iothub",
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: 1,
    },
});
const exampleStreamInputIotHub = new azure.streamanalytics.StreamInputIotHub("example", {
    name: "example-iothub-input",
    streamAnalyticsJobName: example.apply(example => example.name),
    resourceGroupName: example.apply(example => example.resourceGroupName),
    endpoint: "messages/events",
    eventhubConsumerGroupName: "$Default",
    iothubNamespace: exampleIoTHub.name,
    sharedAccessPolicyKey: exampleIoTHub.sharedAccessPolicies.apply(sharedAccessPolicies => sharedAccessPolicies[0].primaryKey),
    sharedAccessPolicyName: "iothubowner",
    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_io_t_hub = azure.iot.IoTHub("example",
    name="example-iothub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "S1",
        "capacity": 1,
    })
example_stream_input_iot_hub = azure.streamanalytics.StreamInputIotHub("example",
    name="example-iothub-input",
    stream_analytics_job_name=example.name,
    resource_group_name=example.resource_group_name,
    endpoint="messages/events",
    eventhub_consumer_group_name="$Default",
    iothub_namespace=example_io_t_hub.name,
    shared_access_policy_key=example_io_t_hub.shared_access_policies[0].primary_key,
    shared_access_policy_name="iothubowner",
    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/iot"
	"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)
		exampleIoTHub, err := iot.NewIoTHub(ctx, "example", &iot.IoTHubArgs{
			Name:              pulumi.String("example-iothub"),
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			Sku: &iot.IoTHubSkuArgs{
				Name:     pulumi.String("S1"),
				Capacity: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		_, err = streamanalytics.NewStreamInputIotHub(ctx, "example", &streamanalytics.StreamInputIotHubArgs{
			Name: pulumi.String("example-iothub-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)),
			Endpoint:                  pulumi.String("messages/events"),
			EventhubConsumerGroupName: pulumi.String("$Default"),
			IothubNamespace:           exampleIoTHub.Name,
			SharedAccessPolicyKey: pulumi.String(exampleIoTHub.SharedAccessPolicies.ApplyT(func(sharedAccessPolicies []iot.IoTHubSharedAccessPolicy) (*string, error) {
				return &sharedAccessPolicies[0].PrimaryKey, nil
			}).(pulumi.StringPtrOutput)),
			SharedAccessPolicyName: pulumi.String("iothubowner"),
			Serialization: &streamanalytics.StreamInputIotHubSerializationArgs{
				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 exampleIoTHub = new Azure.Iot.IoTHub("example", new()
    {
        Name = "example-iothub",
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
        {
            Name = "S1",
            Capacity = 1,
        },
    });

    var exampleStreamInputIotHub = new Azure.StreamAnalytics.StreamInputIotHub("example", new()
    {
        Name = "example-iothub-input",
        StreamAnalyticsJobName = example.Apply(getJobResult => getJobResult.Name),
        ResourceGroupName = example.Apply(getJobResult => getJobResult.ResourceGroupName),
        Endpoint = "messages/events",
        EventhubConsumerGroupName = "$Default",
        IothubNamespace = exampleIoTHub.Name,
        SharedAccessPolicyKey = exampleIoTHub.SharedAccessPolicies.Apply(sharedAccessPolicies => sharedAccessPolicies[0].PrimaryKey),
        SharedAccessPolicyName = "iothubowner",
        Serialization = new Azure.StreamAnalytics.Inputs.StreamInputIotHubSerializationArgs
        {
            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.iot.IoTHub;
import com.pulumi.azure.iot.IoTHubArgs;
import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
import com.pulumi.azure.streamanalytics.StreamInputIotHub;
import com.pulumi.azure.streamanalytics.StreamInputIotHubArgs;
import com.pulumi.azure.streamanalytics.inputs.StreamInputIotHubSerializationArgs;
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 exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()
            .name("example-iothub")
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .sku(IoTHubSkuArgs.builder()
                .name("S1")
                .capacity("1")
                .build())
            .build());

        var exampleStreamInputIotHub = new StreamInputIotHub("exampleStreamInputIotHub", StreamInputIotHubArgs.builder()
            .name("example-iothub-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())))
            .endpoint("messages/events")
            .eventhubConsumerGroupName("$Default")
            .iothubNamespace(exampleIoTHub.name())
            .sharedAccessPolicyKey(exampleIoTHub.sharedAccessPolicies().applyValue(sharedAccessPolicies -> sharedAccessPolicies[0].primaryKey()))
            .sharedAccessPolicyName("iothubowner")
            .serialization(StreamInputIotHubSerializationArgs.builder()
                .type("Json")
                .encoding("UTF8")
                .build())
            .build());

    }
}
Copy
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    name: example
    properties:
      name: example-resources
      location: West Europe
  exampleIoTHub:
    type: azure:iot:IoTHub
    name: example
    properties:
      name: example-iothub
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      sku:
        name: S1
        capacity: '1'
  exampleStreamInputIotHub:
    type: azure:streamanalytics:StreamInputIotHub
    name: example
    properties:
      name: example-iothub-input
      streamAnalyticsJobName: ${example.name}
      resourceGroupName: ${example.resourceGroupName}
      endpoint: messages/events
      eventhubConsumerGroupName: $Default
      iothubNamespace: ${exampleIoTHub.name}
      sharedAccessPolicyKey: ${exampleIoTHub.sharedAccessPolicies[0].primaryKey}
      sharedAccessPolicyName: iothubowner
      serialization:
        type: Json
        encoding: UTF8
variables:
  example:
    fn::invoke:
      function: azure:streamanalytics:getJob
      arguments:
        name: example-job
        resourceGroupName: ${exampleResourceGroup.name}
Copy

Create StreamInputIotHub Resource

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

Constructor syntax

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

@overload
def StreamInputIotHub(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      endpoint: Optional[str] = None,
                      eventhub_consumer_group_name: Optional[str] = None,
                      iothub_namespace: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      serialization: Optional[StreamInputIotHubSerializationArgs] = None,
                      shared_access_policy_key: Optional[str] = None,
                      shared_access_policy_name: Optional[str] = None,
                      stream_analytics_job_name: Optional[str] = None,
                      name: Optional[str] = None)
func NewStreamInputIotHub(ctx *Context, name string, args StreamInputIotHubArgs, opts ...ResourceOption) (*StreamInputIotHub, error)
public StreamInputIotHub(string name, StreamInputIotHubArgs args, CustomResourceOptions? opts = null)
public StreamInputIotHub(String name, StreamInputIotHubArgs args)
public StreamInputIotHub(String name, StreamInputIotHubArgs args, CustomResourceOptions options)
type: azure:streamanalytics:StreamInputIotHub
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. StreamInputIotHubArgs
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. StreamInputIotHubArgs
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. StreamInputIotHubArgs
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. StreamInputIotHubArgs
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. StreamInputIotHubArgs
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 streamInputIotHubResource = new Azure.StreamAnalytics.StreamInputIotHub("streamInputIotHubResource", new()
{
    Endpoint = "string",
    EventhubConsumerGroupName = "string",
    IothubNamespace = "string",
    ResourceGroupName = "string",
    Serialization = new Azure.StreamAnalytics.Inputs.StreamInputIotHubSerializationArgs
    {
        Type = "string",
        Encoding = "string",
        FieldDelimiter = "string",
    },
    SharedAccessPolicyKey = "string",
    SharedAccessPolicyName = "string",
    StreamAnalyticsJobName = "string",
    Name = "string",
});
Copy
example, err := streamanalytics.NewStreamInputIotHub(ctx, "streamInputIotHubResource", &streamanalytics.StreamInputIotHubArgs{
	Endpoint:                  pulumi.String("string"),
	EventhubConsumerGroupName: pulumi.String("string"),
	IothubNamespace:           pulumi.String("string"),
	ResourceGroupName:         pulumi.String("string"),
	Serialization: &streamanalytics.StreamInputIotHubSerializationArgs{
		Type:           pulumi.String("string"),
		Encoding:       pulumi.String("string"),
		FieldDelimiter: pulumi.String("string"),
	},
	SharedAccessPolicyKey:  pulumi.String("string"),
	SharedAccessPolicyName: pulumi.String("string"),
	StreamAnalyticsJobName: pulumi.String("string"),
	Name:                   pulumi.String("string"),
})
Copy
var streamInputIotHubResource = new StreamInputIotHub("streamInputIotHubResource", StreamInputIotHubArgs.builder()
    .endpoint("string")
    .eventhubConsumerGroupName("string")
    .iothubNamespace("string")
    .resourceGroupName("string")
    .serialization(StreamInputIotHubSerializationArgs.builder()
        .type("string")
        .encoding("string")
        .fieldDelimiter("string")
        .build())
    .sharedAccessPolicyKey("string")
    .sharedAccessPolicyName("string")
    .streamAnalyticsJobName("string")
    .name("string")
    .build());
Copy
stream_input_iot_hub_resource = azure.streamanalytics.StreamInputIotHub("streamInputIotHubResource",
    endpoint="string",
    eventhub_consumer_group_name="string",
    iothub_namespace="string",
    resource_group_name="string",
    serialization={
        "type": "string",
        "encoding": "string",
        "field_delimiter": "string",
    },
    shared_access_policy_key="string",
    shared_access_policy_name="string",
    stream_analytics_job_name="string",
    name="string")
Copy
const streamInputIotHubResource = new azure.streamanalytics.StreamInputIotHub("streamInputIotHubResource", {
    endpoint: "string",
    eventhubConsumerGroupName: "string",
    iothubNamespace: "string",
    resourceGroupName: "string",
    serialization: {
        type: "string",
        encoding: "string",
        fieldDelimiter: "string",
    },
    sharedAccessPolicyKey: "string",
    sharedAccessPolicyName: "string",
    streamAnalyticsJobName: "string",
    name: "string",
});
Copy
type: azure:streamanalytics:StreamInputIotHub
properties:
    endpoint: string
    eventhubConsumerGroupName: string
    iothubNamespace: string
    name: string
    resourceGroupName: string
    serialization:
        encoding: string
        fieldDelimiter: string
        type: string
    sharedAccessPolicyKey: string
    sharedAccessPolicyName: string
    streamAnalyticsJobName: string
Copy

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

Endpoint This property is required. string
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
EventhubConsumerGroupName This property is required. 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.
IothubNamespace This property is required. string
The name or the URI of the IoT 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. StreamInputIotHubSerialization
A serialization block as defined below.
SharedAccessPolicyKey
This property is required.
Changes to this property will trigger replacement.
string
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
SharedAccessPolicyName This property is required. string
The shared access policy name for the 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.
Name Changes to this property will trigger replacement. string
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
Endpoint This property is required. string
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
EventhubConsumerGroupName This property is required. 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.
IothubNamespace This property is required. string
The name or the URI of the IoT 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. StreamInputIotHubSerializationArgs
A serialization block as defined below.
SharedAccessPolicyKey
This property is required.
Changes to this property will trigger replacement.
string
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
SharedAccessPolicyName This property is required. string
The shared access policy name for the 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.
Name Changes to this property will trigger replacement. string
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
endpoint This property is required. String
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
eventhubConsumerGroupName This property is required. 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.
iothubNamespace This property is required. String
The name or the URI of the IoT 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. StreamInputIotHubSerialization
A serialization block as defined below.
sharedAccessPolicyKey
This property is required.
Changes to this property will trigger replacement.
String
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
sharedAccessPolicyName This property is required. String
The shared access policy name for the 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.
name Changes to this property will trigger replacement. String
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
endpoint This property is required. string
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
eventhubConsumerGroupName This property is required. 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.
iothubNamespace This property is required. string
The name or the URI of the IoT 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. StreamInputIotHubSerialization
A serialization block as defined below.
sharedAccessPolicyKey
This property is required.
Changes to this property will trigger replacement.
string
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
sharedAccessPolicyName This property is required. string
The shared access policy name for the 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.
name Changes to this property will trigger replacement. string
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
endpoint This property is required. str
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
eventhub_consumer_group_name This property is required. 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.
iothub_namespace This property is required. str
The name or the URI of the IoT 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. StreamInputIotHubSerializationArgs
A serialization block as defined below.
shared_access_policy_key
This property is required.
Changes to this property will trigger replacement.
str
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
shared_access_policy_name This property is required. str
The shared access policy name for the 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.
name Changes to this property will trigger replacement. str
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
endpoint This property is required. String
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
eventhubConsumerGroupName This property is required. 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.
iothubNamespace This property is required. String
The name or the URI of the IoT 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.
sharedAccessPolicyKey
This property is required.
Changes to this property will trigger replacement.
String
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
sharedAccessPolicyName This property is required. String
The shared access policy name for the 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.
name Changes to this property will trigger replacement. String
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.

Outputs

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

Get an existing StreamInputIotHub 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?: StreamInputIotHubState, opts?: CustomResourceOptions): StreamInputIotHub
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint: Optional[str] = None,
        eventhub_consumer_group_name: Optional[str] = None,
        iothub_namespace: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        serialization: Optional[StreamInputIotHubSerializationArgs] = None,
        shared_access_policy_key: Optional[str] = None,
        shared_access_policy_name: Optional[str] = None,
        stream_analytics_job_name: Optional[str] = None) -> StreamInputIotHub
func GetStreamInputIotHub(ctx *Context, name string, id IDInput, state *StreamInputIotHubState, opts ...ResourceOption) (*StreamInputIotHub, error)
public static StreamInputIotHub Get(string name, Input<string> id, StreamInputIotHubState? state, CustomResourceOptions? opts = null)
public static StreamInputIotHub get(String name, Output<String> id, StreamInputIotHubState state, CustomResourceOptions options)
resources:  _:    type: azure:streamanalytics:StreamInputIotHub    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:
Endpoint string
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
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.
IothubNamespace string
The name or the URI of the IoT Hub.
Name Changes to this property will trigger replacement. string
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
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 StreamInputIotHubSerialization
A serialization block as defined below.
SharedAccessPolicyKey Changes to this property will trigger replacement. string
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
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.
Endpoint string
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
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.
IothubNamespace string
The name or the URI of the IoT Hub.
Name Changes to this property will trigger replacement. string
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
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 StreamInputIotHubSerializationArgs
A serialization block as defined below.
SharedAccessPolicyKey Changes to this property will trigger replacement. string
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
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.
endpoint String
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
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.
iothubNamespace String
The name or the URI of the IoT Hub.
name Changes to this property will trigger replacement. String
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
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 StreamInputIotHubSerialization
A serialization block as defined below.
sharedAccessPolicyKey Changes to this property will trigger replacement. String
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
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.
endpoint string
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
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.
iothubNamespace string
The name or the URI of the IoT Hub.
name Changes to this property will trigger replacement. string
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
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 StreamInputIotHubSerialization
A serialization block as defined below.
sharedAccessPolicyKey Changes to this property will trigger replacement. string
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
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.
endpoint str
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
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.
iothub_namespace str
The name or the URI of the IoT Hub.
name Changes to this property will trigger replacement. str
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
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 StreamInputIotHubSerializationArgs
A serialization block as defined below.
shared_access_policy_key Changes to this property will trigger replacement. str
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
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.
endpoint String
The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
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.
iothubNamespace String
The name or the URI of the IoT Hub.
name Changes to this property will trigger replacement. String
The name of the Stream Input IoTHub. Changing this forces a new resource to be created.
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.
sharedAccessPolicyKey Changes to this property will trigger replacement. String
The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created.
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

StreamInputIotHubSerialization
, StreamInputIotHubSerializationArgs

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 IoTHub’s can be imported using the resource id, e.g.

$ pulumi import azure:streamanalytics/streamInputIotHub:StreamInputIotHub 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.