Class FallbackRoute

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.

Inheritance

System.Object

Resource

CustomResource

FallbackRoute

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Iot

Assembly: Pulumi.Azure.dll

Syntax

public class FallbackRoute : CustomResource

Constructors

FallbackRoute(String, FallbackRouteArgs, CustomResourceOptions)

Create a FallbackRoute resource with the given unique name, arguments, and options.

Declaration

public FallbackRoute(string name, FallbackRouteArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
FallbackRouteArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Condition

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

Declaration

public Output<string> Condition { get; }

Property Value

Type	Description
Output<System.String>

Enabled

Used to specify whether the fallback route is enabled.

Declaration

public Output<bool> Enabled { get; }

Property Value

Type	Description
Output<System.Boolean>

EndpointNames

The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.

Declaration

public Output<string> EndpointNames { get; }

Property Value

Type	Description
Output<System.String>

IothubName

The name of the IoTHub to which this Fallback Route belongs. Changing this forces a new resource to be created.

Declaration

public Output<string> IothubName { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, FallbackRouteState, CustomResourceOptions)

Get an existing FallbackRoute resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static FallbackRoute Get(string name, Input<string> id, FallbackRouteState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
FallbackRouteState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
FallbackRoute