Class Route

Manages an IotHub Route

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

Inheritance

System.Object

Resource

CustomResource

Route

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 Route : CustomResource

Constructors

Route(String, RouteArgs, CustomResourceOptions)

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

Declaration

public Route(string name, RouteArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RouteArgs	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

Specifies whether a route is enabled.

Declaration

public Output<bool> Enabled { get; }

Property Value

Type	Description
Output<System.Boolean>

EndpointNames

The list of endpoints to which messages that satisfy the condition are routed. Currently only one 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 Route belongs. Changing this forces a new resource to be created.

Declaration

public Output<string> IothubName { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the route.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Source

The source that the routing rule is to be applied to. Possible values include: DeviceJobLifecycleEvents, DeviceLifecycleEvents, DeviceMessages, Invalid, TwinChangeEvents.

Declaration

public Output<string> Source { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static Route Get(string name, Input<string> id, RouteState 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.
RouteState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Route