Class IoTHub

Manages an IotHub

NOTE: Endpoints can be defined either directly on the azure.iot.IoTHub resource, or using the azurerm_iothub_endpoint_* resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a azurerm_iothub_endpoint_* resource and another endpoint of a different type directly on the azure.iot.IoTHub resource is not supported.

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.

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.

Inheritance
System.Object
Resource
CustomResource
IoTHub
Inherited Members
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 IoTHub : CustomResource

Constructors

View Source

IoTHub(String, IoTHubArgs, CustomResourceOptions)

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

Declaration
public IoTHub(string name, IoTHubArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
IoTHubArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

Endpoints

An endpoint block as defined below.

Declaration
public Output<ImmutableArray<IoTHubEndpoint>> Endpoints { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<IoTHubEndpoint>>
View Source

EventHubEventsEndpoint

The EventHub compatible endpoint for events data

Declaration
public Output<string> EventHubEventsEndpoint { get; }
Property Value
Type Description
Output<System.String>
View Source

EventHubEventsPath

The EventHub compatible path for events data

Declaration
public Output<string> EventHubEventsPath { get; }
Property Value
Type Description
Output<System.String>
View Source

EventHubOperationsEndpoint

The EventHub compatible endpoint for operational data

Declaration
public Output<string> EventHubOperationsEndpoint { get; }
Property Value
Type Description
Output<System.String>
View Source

EventHubOperationsPath

The EventHub compatible path for operational data

Declaration
public Output<string> EventHubOperationsPath { get; }
Property Value
Type Description
Output<System.String>
View Source

EventHubPartitionCount

The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.

Declaration
public Output<int> EventHubPartitionCount { get; }
Property Value
Type Description
Output<System.Int32>
View Source

EventHubRetentionInDays

The event hub retention to use in days. Must be between 1 and 7.

Declaration
public Output<int> EventHubRetentionInDays { get; }
Property Value
Type Description
Output<System.Int32>
View Source

FallbackRoute

A fallback_route block as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events.

Declaration
public Output<IoTHubFallbackRoute> FallbackRoute { get; }
Property Value
Type Description
Output<IoTHubFallbackRoute>
View Source

FileUpload

A file_upload block as defined below.

Declaration
public Output<IoTHubFileUpload> FileUpload { get; }
Property Value
Type Description
Output<IoTHubFileUpload>
View Source

Hostname

The hostname of the IotHub Resource.

Declaration
public Output<string> Hostname { get; }
Property Value
Type Description
Output<System.String>
View Source

IpFilterRules

One or more ip_filter_rule blocks as defined below.

Declaration
public Output<ImmutableArray<IoTHubIpFilterRule>> IpFilterRules { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<IoTHubIpFilterRule>>
View Source

Location

Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

Declaration
public Output<string> Location { get; }
Property Value
Type Description
Output<System.String>
View Source

Name

Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

ResourceGroupName

The name of the resource group under which the IotHub 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>
View Source

Routes

A route block as defined below.

Declaration
public Output<ImmutableArray<IoTHubRoute>> Routes { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<IoTHubRoute>>
View Source

SharedAccessPolicies

One or more shared_access_policy blocks as defined below.

Declaration
public Output<ImmutableArray<IoTHubSharedAccessPolicy>> SharedAccessPolicies { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<IoTHubSharedAccessPolicy>>
View Source

Sku

A sku block as defined below.

Declaration
public Output<IoTHubSku> Sku { get; }
Property Value
Type Description
Output<IoTHubSku>
View Source

Tags

A mapping of tags to assign to the resource.

Declaration
public Output<ImmutableDictionary<string, string>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>
View Source

Type

The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

Declaration
public Output<string> Type { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

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

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

Declaration
public static IoTHub Get(string name, Input<string> id, IoTHubState 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.
IoTHubState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
IoTHub