1. Packages
  2. Azure Classic
  3. API Docs
  4. iot
  5. FallbackRoute

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.iot.FallbackRoute

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Manages an IotHub Fallback Route

    Disclaimers

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

    Note: Since this resource is provisioned by default, the Azure Provider will not check for the presence of an existing resource prior to attempting to create it.

    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 exampleFallbackRoute = new azure.iot.FallbackRoute("example", {
        resourceGroupName: example.name,
        iothubName: exampleIoTHub.name,
        condition: "true",
        endpointNames: exampleEndpointStorageContainer.name,
        enabled: true,
    });
    
    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_fallback_route = azure.iot.FallbackRoute("example",
        resource_group_name=example.name,
        iothub_name=example_io_t_hub.name,
        condition="true",
        endpoint_names=example_endpoint_storage_container.name,
        enabled=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/iot"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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.NewFallbackRoute(ctx, "example", &iot.FallbackRouteArgs{
    			ResourceGroupName: example.Name,
    			IothubName:        exampleIoTHub.Name,
    			Condition:         pulumi.String("true"),
    			EndpointNames:     exampleEndpointStorageContainer.Name,
    			Enabled:           pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 exampleFallbackRoute = new Azure.Iot.FallbackRoute("example", new()
        {
            ResourceGroupName = example.Name,
            IothubName = exampleIoTHub.Name,
            Condition = "true",
            EndpointNames = exampleEndpointStorageContainer.Name,
            Enabled = true,
        });
    
    });
    
    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.FallbackRoute;
    import com.pulumi.azure.iot.FallbackRouteArgs;
    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 exampleFallbackRoute = new FallbackRoute("exampleFallbackRoute", FallbackRouteArgs.builder()
                .resourceGroupName(example.name())
                .iothubName(exampleIoTHub.name())
                .condition("true")
                .endpointNames(exampleEndpointStorageContainer.name())
                .enabled(true)
                .build());
    
        }
    }
    
    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}'
      exampleFallbackRoute:
        type: azure:iot:FallbackRoute
        name: example
        properties:
          resourceGroupName: ${example.name}
          iothubName: ${exampleIoTHub.name}
          condition: 'true'
          endpointNames: ${exampleEndpointStorageContainer.name}
          enabled: true
    

    Create FallbackRoute Resource

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

    Constructor syntax

    new FallbackRoute(name: string, args: FallbackRouteArgs, opts?: CustomResourceOptions);
    @overload
    def FallbackRoute(resource_name: str,
                      args: FallbackRouteArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def FallbackRoute(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,
                      condition: Optional[str] = None,
                      source: Optional[str] = None)
    func NewFallbackRoute(ctx *Context, name string, args FallbackRouteArgs, opts ...ResourceOption) (*FallbackRoute, error)
    public FallbackRoute(string name, FallbackRouteArgs args, CustomResourceOptions? opts = null)
    public FallbackRoute(String name, FallbackRouteArgs args)
    public FallbackRoute(String name, FallbackRouteArgs args, CustomResourceOptions options)
    
    type: azure:iot:FallbackRoute
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FallbackRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FallbackRouteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FallbackRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FallbackRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FallbackRouteArgs
    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 fallbackRouteResource = new Azure.Iot.FallbackRoute("fallbackRouteResource", new()
    {
        Enabled = false,
        EndpointNames = "string",
        IothubName = "string",
        ResourceGroupName = "string",
        Condition = "string",
        Source = "string",
    });
    
    example, err := iot.NewFallbackRoute(ctx, "fallbackRouteResource", &iot.FallbackRouteArgs{
    	Enabled:           pulumi.Bool(false),
    	EndpointNames:     pulumi.String("string"),
    	IothubName:        pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Condition:         pulumi.String("string"),
    	Source:            pulumi.String("string"),
    })
    
    var fallbackRouteResource = new FallbackRoute("fallbackRouteResource", FallbackRouteArgs.builder()
        .enabled(false)
        .endpointNames("string")
        .iothubName("string")
        .resourceGroupName("string")
        .condition("string")
        .source("string")
        .build());
    
    fallback_route_resource = azure.iot.FallbackRoute("fallbackRouteResource",
        enabled=False,
        endpoint_names="string",
        iothub_name="string",
        resource_group_name="string",
        condition="string",
        source="string")
    
    const fallbackRouteResource = new azure.iot.FallbackRoute("fallbackRouteResource", {
        enabled: false,
        endpointNames: "string",
        iothubName: "string",
        resourceGroupName: "string",
        condition: "string",
        source: "string",
    });
    
    type: azure:iot:FallbackRoute
    properties:
        condition: string
        enabled: false
        endpointNames: string
        iothubName: string
        resourceGroupName: string
        source: string
    

    FallbackRoute Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FallbackRoute resource accepts the following input properties:

    Enabled bool
    Used to specify whether the fallback route is enabled.
    EndpointNames string
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    IothubName string
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.
    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.
    Source string
    The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents. Defaults to DeviceMessages.
    Enabled bool
    Used to specify whether the fallback route is enabled.
    EndpointNames string
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    IothubName string
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.
    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.
    Source string
    The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents. Defaults to DeviceMessages.
    enabled Boolean
    Used to specify whether the fallback route is enabled.
    endpointNames String
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    iothubName String
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.
    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.
    source String
    The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents. Defaults to DeviceMessages.
    enabled boolean
    Used to specify whether the fallback route is enabled.
    endpointNames string
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    iothubName string
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.
    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.
    source string
    The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents. Defaults to DeviceMessages.
    enabled bool
    Used to specify whether the fallback route is enabled.
    endpoint_names str
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    iothub_name str
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.
    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.
    source str
    The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents. Defaults to DeviceMessages.
    enabled Boolean
    Used to specify whether the fallback route is enabled.
    endpointNames String
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    iothubName String
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the IotHub Storage Container Endpoint resource has to be created. Changing this forces a new resource to be created.
    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.
    source String
    The source that the routing rule is to be applied to. Possible values include: DeviceConnectionStateEvents, DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, DigitalTwinChangeEvents, Invalid, TwinChangeEvents. Defaults to DeviceMessages.

    Outputs

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

    Get an existing FallbackRoute 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?: FallbackRouteState, opts?: CustomResourceOptions): FallbackRoute
    @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,
            resource_group_name: Optional[str] = None,
            source: Optional[str] = None) -> FallbackRoute
    func GetFallbackRoute(ctx *Context, name string, id IDInput, state *FallbackRouteState, opts ...ResourceOption) (*FallbackRoute, error)
    public static FallbackRoute Get(string name, Input<string> id, FallbackRouteState? state, CustomResourceOptions? opts = null)
    public static FallbackRoute get(String name, Output<String> id, FallbackRouteState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    Used to specify whether the fallback route is enabled.
    EndpointNames string
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    IothubName string
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the IotHub Storage Container Endpoint 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. Defaults to DeviceMessages.
    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
    Used to specify whether the fallback route is enabled.
    EndpointNames string
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    IothubName string
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the IotHub Storage Container Endpoint 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. Defaults to DeviceMessages.
    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
    Used to specify whether the fallback route is enabled.
    endpointNames String
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    iothubName String
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the IotHub Storage Container Endpoint 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. Defaults to DeviceMessages.
    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
    Used to specify whether the fallback route is enabled.
    endpointNames string
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    iothubName string
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group under which the IotHub Storage Container Endpoint 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. Defaults to DeviceMessages.
    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
    Used to specify whether the fallback route is enabled.
    endpoint_names str
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    iothub_name str
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group under which the IotHub Storage Container Endpoint 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. Defaults to DeviceMessages.
    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
    Used to specify whether the fallback route is enabled.
    endpointNames String
    The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
    iothubName String
    The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the IotHub Storage Container Endpoint 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. Defaults to DeviceMessages.

    Import

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

    $ pulumi import azure:iot/fallbackRoute:FallbackRoute route1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/fallbackRoute/default
    

    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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi