Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. iot
  5. Route

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.iot.Route

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an IotHub Route

NOTE: Routes can be defined either directly on the azure.iot.IoTHub resource, or using the azure.iot.Route resource - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
    name: "examplestorageaccount",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("example", {
    name: "example",
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleIoTHub = new azure.iot.IoTHub("example", {
    name: "exampleIothub",
    resourceGroupName: example.name,
    location: example.location,
    sku: {
        name: "S1",
        capacity: 1,
    },
    tags: {
        purpose: "testing",
    },
});
const exampleEndpointStorageContainer = new azure.iot.EndpointStorageContainer("example", {
    resourceGroupName: example.name,
    iothubId: exampleIoTHub.id,
    name: "example",
    connectionString: exampleAccount.primaryBlobConnectionString,
    batchFrequencyInSeconds: 60,
    maxChunkSizeInBytes: 10485760,
    containerName: exampleContainer.name,
    encoding: "Avro",
    fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
});
const exampleRoute = new azure.iot.Route("example", {
    resourceGroupName: example.name,
    iothubName: exampleIoTHub.name,
    name: "example",
    source: "DeviceMessages",
    condition: "true",
    endpointNames: exampleEndpointStorageContainer.name,
    enabled: true,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.storage.Account("example",
    name="examplestorageaccount",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_container = azure.storage.Container("example",
    name="example",
    storage_account_name=example_account.name,
    container_access_type="private")
example_io_t_hub = azure.iot.IoTHub("example",
    name="exampleIothub",
    resource_group_name=example.name,
    location=example.location,
    sku={
        "name": "S1",
        "capacity": 1,
    },
    tags={
        "purpose": "testing",
    })
example_endpoint_storage_container = azure.iot.EndpointStorageContainer("example",
    resource_group_name=example.name,
    iothub_id=example_io_t_hub.id,
    name="example",
    connection_string=example_account.primary_blob_connection_string,
    batch_frequency_in_seconds=60,
    max_chunk_size_in_bytes=10485760,
    container_name=example_container.name,
    encoding="Avro",
    file_name_format="{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}")
example_route = azure.iot.Route("example",
    resource_group_name=example.name,
    iothub_name=example_io_t_hub.name,
    name="example",
    source="DeviceMessages",
    condition="true",
    endpoint_names=example_endpoint_storage_container.name,
    enabled=True)
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/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("examplestorageaccount"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		exampleContainer, err := storage.NewContainer(ctx, "example", &storage.ContainerArgs{
			Name:                pulumi.String("example"),
			StorageAccountName:  exampleAccount.Name,
			ContainerAccessType: pulumi.String("private"),
		})
		if err != nil {
			return err
		}
		exampleIoTHub, err := iot.NewIoTHub(ctx, "example", &iot.IoTHubArgs{
			Name:              pulumi.String("exampleIothub"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Sku: &iot.IoTHubSkuArgs{
				Name:     pulumi.String("S1"),
				Capacity: pulumi.Int(1),
			},
			Tags: pulumi.StringMap{
				"purpose": pulumi.String("testing"),
			},
		})
		if err != nil {
			return err
		}
		exampleEndpointStorageContainer, err := iot.NewEndpointStorageContainer(ctx, "example", &iot.EndpointStorageContainerArgs{
			ResourceGroupName:       example.Name,
			IothubId:                exampleIoTHub.ID(),
			Name:                    pulumi.String("example"),
			ConnectionString:        exampleAccount.PrimaryBlobConnectionString,
			BatchFrequencyInSeconds: pulumi.Int(60),
			MaxChunkSizeInBytes:     pulumi.Int(10485760),
			ContainerName:           exampleContainer.Name,
			Encoding:                pulumi.String("Avro"),
			FileNameFormat:          pulumi.String("{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}"),
		})
		if err != nil {
			return err
		}
		_, err = iot.NewRoute(ctx, "example", &iot.RouteArgs{
			ResourceGroupName: example.Name,
			IothubName:        exampleIoTHub.Name,
			Name:              pulumi.String("example"),
			Source:            pulumi.String("DeviceMessages"),
			Condition:         pulumi.String("true"),
			EndpointNames:     exampleEndpointStorageContainer.Name,
			Enabled:           pulumi.Bool(true),
		})
		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 example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "examplestorageaccount",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleContainer = new Azure.Storage.Container("example", new()
    {
        Name = "example",
        StorageAccountName = exampleAccount.Name,
        ContainerAccessType = "private",
    });

    var exampleIoTHub = new Azure.Iot.IoTHub("example", new()
    {
        Name = "exampleIothub",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
        {
            Name = "S1",
            Capacity = 1,
        },
        Tags = 
        {
            { "purpose", "testing" },
        },
    });

    var exampleEndpointStorageContainer = new Azure.Iot.EndpointStorageContainer("example", new()
    {
        ResourceGroupName = example.Name,
        IothubId = exampleIoTHub.Id,
        Name = "example",
        ConnectionString = exampleAccount.PrimaryBlobConnectionString,
        BatchFrequencyInSeconds = 60,
        MaxChunkSizeInBytes = 10485760,
        ContainerName = exampleContainer.Name,
        Encoding = "Avro",
        FileNameFormat = "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
    });

    var exampleRoute = new Azure.Iot.Route("example", new()
    {
        ResourceGroupName = example.Name,
        IothubName = exampleIoTHub.Name,
        Name = "example",
        Source = "DeviceMessages",
        Condition = "true",
        EndpointNames = exampleEndpointStorageContainer.Name,
        Enabled = true,
    });

});
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
import com.pulumi.azure.iot.IoTHub;
import com.pulumi.azure.iot.IoTHubArgs;
import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
import com.pulumi.azure.iot.EndpointStorageContainer;
import com.pulumi.azure.iot.EndpointStorageContainerArgs;
import com.pulumi.azure.iot.Route;
import com.pulumi.azure.iot.RouteArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("examplestorageaccount")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
            .name("example")
            .storageAccountName(exampleAccount.name())
            .containerAccessType("private")
            .build());

        var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()
            .name("exampleIothub")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku(IoTHubSkuArgs.builder()
                .name("S1")
                .capacity("1")
                .build())
            .tags(Map.of("purpose", "testing"))
            .build());

        var exampleEndpointStorageContainer = new EndpointStorageContainer("exampleEndpointStorageContainer", EndpointStorageContainerArgs.builder()
            .resourceGroupName(example.name())
            .iothubId(exampleIoTHub.id())
            .name("example")
            .connectionString(exampleAccount.primaryBlobConnectionString())
            .batchFrequencyInSeconds(60)
            .maxChunkSizeInBytes(10485760)
            .containerName(exampleContainer.name())
            .encoding("Avro")
            .fileNameFormat("{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}")
            .build());

        var exampleRoute = new Route("exampleRoute", RouteArgs.builder()
            .resourceGroupName(example.name())
            .iothubName(exampleIoTHub.name())
            .name("example")
            .source("DeviceMessages")
            .condition("true")
            .endpointNames(exampleEndpointStorageContainer.name())
            .enabled(true)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplestorageaccount
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleContainer:
    type: azure:storage:Container
    name: example
    properties:
      name: example
      storageAccountName: ${exampleAccount.name}
      containerAccessType: private
  exampleIoTHub:
    type: azure:iot:IoTHub
    name: example
    properties:
      name: exampleIothub
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku:
        name: S1
        capacity: '1'
      tags:
        purpose: testing
  exampleEndpointStorageContainer:
    type: azure:iot:EndpointStorageContainer
    name: example
    properties:
      resourceGroupName: ${example.name}
      iothubId: ${exampleIoTHub.id}
      name: example
      connectionString: ${exampleAccount.primaryBlobConnectionString}
      batchFrequencyInSeconds: 60
      maxChunkSizeInBytes: 1.048576e+07
      containerName: ${exampleContainer.name}
      encoding: Avro
      fileNameFormat: '{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}'
  exampleRoute:
    type: azure:iot:Route
    name: example
    properties:
      resourceGroupName: ${example.name}
      iothubName: ${exampleIoTHub.name}
      name: example
      source: DeviceMessages
      condition: 'true'
      endpointNames: ${exampleEndpointStorageContainer.name}
      enabled: true
Copy

Create Route Resource

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

Constructor syntax

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

@overload
def Route(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          enabled: Optional[bool] = None,
          endpoint_names: Optional[str] = None,
          iothub_name: Optional[str] = None,
          resource_group_name: Optional[str] = None,
          source: Optional[str] = None,
          condition: Optional[str] = None,
          name: Optional[str] = None)
func NewRoute(ctx *Context, name string, args RouteArgs, opts ...ResourceOption) (*Route, error)
public Route(string name, RouteArgs args, CustomResourceOptions? opts = null)
public Route(String name, RouteArgs args)
public Route(String name, RouteArgs args, CustomResourceOptions options)

type: azure:iot:Route
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. RouteArgs
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. RouteArgs
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. RouteArgs
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. RouteArgs
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. RouteArgs
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 routeResource = new Azure.Iot.Route("routeResource", new()
{
    Enabled = false,
    EndpointNames = "string",
    IothubName = "string",
    ResourceGroupName = "string",
    Source = "string",
    Condition = "string",
    Name = "string",
});
Copy
example, err := iot.NewRoute(ctx, "routeResource", &iot.RouteArgs{
	Enabled:           pulumi.Bool(false),
	EndpointNames:     pulumi.String("string"),
	IothubName:        pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Source:            pulumi.String("string"),
	Condition:         pulumi.String("string"),
	Name:              pulumi.String("string"),
})
Copy
var routeResource = new Route("routeResource", RouteArgs.builder()
    .enabled(false)
    .endpointNames("string")
    .iothubName("string")
    .resourceGroupName("string")
    .source("string")
    .condition("string")
    .name("string")
    .build());
Copy
route_resource = azure.iot.Route("routeResource",
    enabled=False,
    endpoint_names="string",
    iothub_name="string",
    resource_group_name="string",
    source="string",
    condition="string",
    name="string")
Copy
const routeResource = new azure.iot.Route("routeResource", {
    enabled: false,
    endpointNames: "string",
    iothubName: "string",
    resourceGroupName: "string",
    source: "string",
    condition: "string",
    name: "string",
});
Copy
type: azure:iot:Route
properties:
    condition: string
    enabled: false
    endpointNames: string
    iothubName: string
    name: string
    resourceGroupName: string
    source: string
Copy

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

Enabled This property is required. bool
Specifies whether a route is enabled.
EndpointNames This property is required. string
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
IothubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
Source This property is required. string
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
Condition string
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
Name Changes to this property will trigger replacement. string
The name of the route. Changing this forces a new resource to be created.
Enabled This property is required. bool
Specifies whether a route is enabled.
EndpointNames This property is required. string
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
IothubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
Source This property is required. string
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
Condition string
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
Name Changes to this property will trigger replacement. string
The name of the route. Changing this forces a new resource to be created.
enabled This property is required. Boolean
Specifies whether a route is enabled.
endpointNames This property is required. String
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source This property is required. String
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
condition String
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
name Changes to this property will trigger replacement. String
The name of the route. Changing this forces a new resource to be created.
enabled This property is required. boolean
Specifies whether a route is enabled.
endpointNames This property is required. string
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source This property is required. string
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
condition string
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
name Changes to this property will trigger replacement. string
The name of the route. Changing this forces a new resource to be created.
enabled This property is required. bool
Specifies whether a route is enabled.
endpoint_names This property is required. str
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothub_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source This property is required. str
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
condition str
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
name Changes to this property will trigger replacement. str
The name of the route. Changing this forces a new resource to be created.
enabled This property is required. Boolean
Specifies whether a route is enabled.
endpointNames This property is required. String
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source This property is required. String
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
condition String
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
name Changes to this property will trigger replacement. String
The name of the route. Changing this forces a new resource to be created.

Outputs

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

Get an existing Route 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?: RouteState, opts?: CustomResourceOptions): Route
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[str] = None,
        enabled: Optional[bool] = None,
        endpoint_names: Optional[str] = None,
        iothub_name: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        source: Optional[str] = None) -> Route
func GetRoute(ctx *Context, name string, id IDInput, state *RouteState, opts ...ResourceOption) (*Route, error)
public static Route Get(string name, Input<string> id, RouteState? state, CustomResourceOptions? opts = null)
public static Route get(String name, Output<String> id, RouteState state, CustomResourceOptions options)
resources:  _:    type: azure:iot:Route    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:
Condition string
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
Enabled bool
Specifies whether a route is enabled.
EndpointNames string
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
IothubName Changes to this property will trigger replacement. string
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the route. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
Source string
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
Condition string
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
Enabled bool
Specifies whether a route is enabled.
EndpointNames string
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
IothubName Changes to this property will trigger replacement. string
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the route. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
Source string
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
condition String
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
enabled Boolean
Specifies whether a route is enabled.
endpointNames String
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothubName Changes to this property will trigger replacement. String
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the route. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source String
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
condition string
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
enabled boolean
Specifies whether a route is enabled.
endpointNames string
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothubName Changes to this property will trigger replacement. string
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the route. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source string
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
condition str
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
enabled bool
Specifies whether a route is enabled.
endpoint_names str
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothub_name Changes to this property will trigger replacement. str
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the route. 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 under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source str
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.
condition String
The condition that is evaluated to apply the routing rule. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Defaults to true.
enabled Boolean
Specifies whether a route is enabled.
endpointNames String
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
iothubName Changes to this property will trigger replacement. String
The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the route. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
source String
The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents.

Import

IoTHub Route can be imported using the resource id, e.g.

$ pulumi import azure:iot/route:Route route1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/routes/route1
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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure