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.

Create a IoTHub Resource

new IoTHub(name: string, args: IoTHubArgs, opts?: CustomResourceOptions);

def IoTHub(resource_name, opts=None, endpoints=None, event_hub_partition_count=None, event_hub_retention_in_days=None, fallback_route=None, file_upload=None, ip_filter_rules=None, location=None, name=None, resource_group_name=None, routes=None, sku=None, tags=None, __props__=None);

func NewIoTHub(ctx *Context, name string, args IoTHubArgs, opts ...ResourceOption) (*IoTHub, error)

public IoTHub(string name, IoTHubArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args IoTHubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args IoTHubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IoTHubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

IoTHub Resource Properties

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

Inputs

The IoTHub resource accepts the following input properties:

ResourceGroupName string: The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
Sku IoTHubSkuArgs: A sku block as defined below.
Endpoints List<IoTHubEndpointArgs>: An endpoint block as defined below.
EventHubPartitionCount int: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
EventHubRetentionInDays int: The event hub retention to use in days. Must be between 1 and 7.
FallbackRoute IoTHubFallbackRouteArgs: 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.
FileUpload IoTHubFileUploadArgs: A file_upload block as defined below.
IpFilterRules List<IoTHubIpFilterRuleArgs>: One or more ip_filter_rule blocks as defined below.
Location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
Name string: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
Routes List<IoTHubRouteArgs>: A route block as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
Sku IoTHubSku: A sku block as defined below.
Endpoints []IoTHubEndpoint: An endpoint block as defined below.
EventHubPartitionCount int: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
EventHubRetentionInDays int: The event hub retention to use in days. Must be between 1 and 7.
FallbackRoute IoTHubFallbackRoute: 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.
FileUpload IoTHubFileUpload: A file_upload block as defined below.
IpFilterRules []IoTHubIpFilterRule: One or more ip_filter_rule blocks as defined below.
Location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
Name string: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
Routes []IoTHubRoute: A route block as defined below.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
sku IoTHubSku: A sku block as defined below.
endpoints IoTHubEndpoint[]: An endpoint block as defined below.
eventHubPartitionCount number: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
eventHubRetentionInDays number: The event hub retention to use in days. Must be between 1 and 7.
fallbackRoute IoTHubFallbackRoute: 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.
fileUpload IoTHubFileUpload: A file_upload block as defined below.
ipFilterRules IoTHubIpFilterRule[]: One or more ip_filter_rule blocks as defined below.
location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name string: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
routes IoTHubRoute[]: A route block as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
sku Dict[IoTHubSku]: A sku block as defined below.
endpoints List[IoTHubEndpoint]: An endpoint block as defined below.
event_hub_partition_count float: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
event_hub_retention_in_days float: The event hub retention to use in days. Must be between 1 and 7.
fallback_route Dict[IoTHubFallbackRoute]: 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.
file_upload Dict[IoTHubFileUpload]: A file_upload block as defined below.
ip_filter_rules List[IoTHubIpFilterRule]: One or more ip_filter_rule blocks as defined below.
location str: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name str: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
routes List[IoTHubRoute]: A route block as defined below.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the IoTHub resource produces the following output properties:

EventHubEventsEndpoint string: The EventHub compatible endpoint for events data
EventHubEventsPath string: The EventHub compatible path for events data
EventHubOperationsEndpoint string: The EventHub compatible endpoint for operational data
EventHubOperationsPath string: The EventHub compatible path for operational data
Hostname string: The hostname of the IotHub Resource.
Id string: The provider-assigned unique ID for this managed resource.
SharedAccessPolicies List<IoTHubSharedAccessPolicy>: One or more shared_access_policy blocks as defined below.
Type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

EventHubEventsEndpoint string: The EventHub compatible endpoint for events data
EventHubEventsPath string: The EventHub compatible path for events data
EventHubOperationsEndpoint string: The EventHub compatible endpoint for operational data
EventHubOperationsPath string: The EventHub compatible path for operational data
Hostname string: The hostname of the IotHub Resource.
Id string: The provider-assigned unique ID for this managed resource.
SharedAccessPolicies []IoTHubSharedAccessPolicy: One or more shared_access_policy blocks as defined below.
Type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

eventHubEventsEndpoint string: The EventHub compatible endpoint for events data
eventHubEventsPath string: The EventHub compatible path for events data
eventHubOperationsEndpoint string: The EventHub compatible endpoint for operational data
eventHubOperationsPath string: The EventHub compatible path for operational data
hostname string: The hostname of the IotHub Resource.
id string: The provider-assigned unique ID for this managed resource.
sharedAccessPolicies IoTHubSharedAccessPolicy[]: One or more shared_access_policy blocks as defined below.
type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

event_hub_events_endpoint str: The EventHub compatible endpoint for events data
event_hub_events_path str: The EventHub compatible path for events data
event_hub_operations_endpoint str: The EventHub compatible endpoint for operational data
event_hub_operations_path str: The EventHub compatible path for operational data
hostname str: The hostname of the IotHub Resource.
id str: The provider-assigned unique ID for this managed resource.
shared_access_policies List[IoTHubSharedAccessPolicy]: One or more shared_access_policy blocks as defined below.
type str: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

Look up an Existing IoTHub Resource

Get an existing IoTHub 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?: IoTHubState, opts?: CustomResourceOptions): IoTHub

static get(resource_name, id, opts=None, endpoints=None, event_hub_events_endpoint=None, event_hub_events_path=None, event_hub_operations_endpoint=None, event_hub_operations_path=None, event_hub_partition_count=None, event_hub_retention_in_days=None, fallback_route=None, file_upload=None, hostname=None, ip_filter_rules=None, location=None, name=None, resource_group_name=None, routes=None, shared_access_policies=None, sku=None, tags=None, type=None, __props__=None);

func GetIoTHub(ctx *Context, name string, id IDInput, state *IoTHubState, opts ...ResourceOption) (*IoTHub, error)

public static IoTHub Get(string name, Input<string> id, IoTHubState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Endpoints List<IoTHubEndpointArgs>: An endpoint block as defined below.
EventHubEventsEndpoint string: The EventHub compatible endpoint for events data
EventHubEventsPath string: The EventHub compatible path for events data
EventHubOperationsEndpoint string: The EventHub compatible endpoint for operational data
EventHubOperationsPath string: The EventHub compatible path for operational data
EventHubPartitionCount int: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
EventHubRetentionInDays int: The event hub retention to use in days. Must be between 1 and 7.
FallbackRoute IoTHubFallbackRouteArgs: 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.
FileUpload IoTHubFileUploadArgs: A file_upload block as defined below.
Hostname string: The hostname of the IotHub Resource.
IpFilterRules List<IoTHubIpFilterRuleArgs>: One or more ip_filter_rule blocks as defined below.
Location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
Name string: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
Routes List<IoTHubRouteArgs>: A route block as defined below.
SharedAccessPolicies List<IoTHubSharedAccessPolicyArgs>: One or more shared_access_policy blocks as defined below.
Sku IoTHubSkuArgs: A sku block as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

Endpoints []IoTHubEndpoint: An endpoint block as defined below.
EventHubEventsEndpoint string: The EventHub compatible endpoint for events data
EventHubEventsPath string: The EventHub compatible path for events data
EventHubOperationsEndpoint string: The EventHub compatible endpoint for operational data
EventHubOperationsPath string: The EventHub compatible path for operational data
EventHubPartitionCount int: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
EventHubRetentionInDays int: The event hub retention to use in days. Must be between 1 and 7.
FallbackRoute IoTHubFallbackRoute: 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.
FileUpload IoTHubFileUpload: A file_upload block as defined below.
Hostname string: The hostname of the IotHub Resource.
IpFilterRules []IoTHubIpFilterRule: One or more ip_filter_rule blocks as defined below.
Location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
Name string: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
Routes []IoTHubRoute: A route block as defined below.
SharedAccessPolicies []IoTHubSharedAccessPolicy: One or more shared_access_policy blocks as defined below.
Sku IoTHubSku: A sku block as defined below.
Tags map[string]string: A mapping of tags to assign to the resource.
Type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

endpoints IoTHubEndpoint[]: An endpoint block as defined below.
eventHubEventsEndpoint string: The EventHub compatible endpoint for events data
eventHubEventsPath string: The EventHub compatible path for events data
eventHubOperationsEndpoint string: The EventHub compatible endpoint for operational data
eventHubOperationsPath string: The EventHub compatible path for operational data
eventHubPartitionCount number: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
eventHubRetentionInDays number: The event hub retention to use in days. Must be between 1 and 7.
fallbackRoute IoTHubFallbackRoute: 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.
fileUpload IoTHubFileUpload: A file_upload block as defined below.
hostname string: The hostname of the IotHub Resource.
ipFilterRules IoTHubIpFilterRule[]: One or more ip_filter_rule blocks as defined below.
location string: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name string: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
routes IoTHubRoute[]: A route block as defined below.
sharedAccessPolicies IoTHubSharedAccessPolicy[]: One or more shared_access_policy blocks as defined below.
sku IoTHubSku: A sku block as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

endpoints List[IoTHubEndpoint]: An endpoint block as defined below.
event_hub_events_endpoint str: The EventHub compatible endpoint for events data
event_hub_events_path str: The EventHub compatible path for events data
event_hub_operations_endpoint str: The EventHub compatible endpoint for operational data
event_hub_operations_path str: The EventHub compatible path for operational data
event_hub_partition_count float: The number of device-to-cloud partitions used by backing event hubs. Must be between 2 and 128.
event_hub_retention_in_days float: The event hub retention to use in days. Must be between 1 and 7.
fallback_route Dict[IoTHubFallbackRoute]: 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.
file_upload Dict[IoTHubFileUpload]: A file_upload block as defined below.
hostname str: The hostname of the IotHub Resource.
ip_filter_rules List[IoTHubIpFilterRule]: One or more ip_filter_rule blocks as defined below.
location str: Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
name str: Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
routes List[IoTHubRoute]: A route block as defined below.
shared_access_policies List[IoTHubSharedAccessPolicy]: One or more shared_access_policy blocks as defined below.
sku Dict[IoTHubSku]: A sku block as defined below.
tags Dict[str, str]: A mapping of tags to assign to the resource.
type str: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

Supporting Types

IoTHubEndpoint

See the input and output API doc for this type.

ConnectionString string: The connection string for the endpoint.
Name string: The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
Type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.
BatchFrequencyInSeconds int: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
ContainerName string: The name of storage container in the storage account. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
Encoding string: Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
FileNameFormat string: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
MaxChunkSizeInBytes int: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

ConnectionString string: The connection string for the endpoint.
Name string: The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
Type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.
BatchFrequencyInSeconds int: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
ContainerName string: The name of storage container in the storage account. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
Encoding string: Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
FileNameFormat string: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
MaxChunkSizeInBytes int: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

connectionString string: The connection string for the endpoint.
name string: The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
type string: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.
batchFrequencyInSeconds number: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
containerName string: The name of storage container in the storage account. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
encoding string: Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
fileNameFormat string: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
maxChunkSizeInBytes number: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

connection_string str: The connection string for the endpoint.
name str: The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.
type str: The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.
batch_frequency_in_seconds float: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
container_name str: The name of storage container in the storage account. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
encoding str: Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
file_name_format str: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.
max_chunk_size_in_bytes float: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

IoTHubFallbackRoute

See the input and output API doc for this type.

Condition string: 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.
Enabled bool: Used to specify whether the fallback route is enabled.
EndpointNames List<string>: The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
Source string: The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

Condition string: 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.
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.
Source string: The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

condition string: 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.
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.
source string: The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

condition str: 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.
enabled bool: Used to specify whether the fallback route is enabled.
endpoint_names List[str]: The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.
source str: The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

IoTHubFileUpload

See the input and output API doc for this type.

ConnectionString string: The connection string for the Azure Storage account to which files are uploaded.
ContainerName string: The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
DefaultTtl string: The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to ‘PT1H’ by default.
LockDuration string: The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to ‘PT1M’ by default.
MaxDeliveryCount int: The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to 10 by default.
Notifications bool: Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
SasTtl string: The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to ‘PT1H’ by default.

ConnectionString string: The connection string for the Azure Storage account to which files are uploaded.
ContainerName string: The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
DefaultTtl string: The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to ‘PT1H’ by default.
LockDuration string: The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to ‘PT1M’ by default.
MaxDeliveryCount int: The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to 10 by default.
Notifications bool: Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
SasTtl string: The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to ‘PT1H’ by default.

connectionString string: The connection string for the Azure Storage account to which files are uploaded.
containerName string: The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
defaultTtl string: The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to ‘PT1H’ by default.
lockDuration string: The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to ‘PT1M’ by default.
maxDeliveryCount number: The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to 10 by default.
notifications boolean: Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
sasTtl string: The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to ‘PT1H’ by default.

connection_string str: The connection string for the Azure Storage account to which files are uploaded.
container_name str: The name of the root container where you upload files. The container need not exist but should be creatable using the connection_string specified.
default_ttl str: The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to ‘PT1H’ by default.
lock_duration str: The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to ‘PT1M’ by default.
max_delivery_count float: The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to 10 by default.
notifications bool: Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.
sasTtl str: The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to ‘PT1H’ by default.

IoTHubIpFilterRule

See the input and output API doc for this type.

Action string: The desired action for requests captured by this rule. Possible values are Accept, Reject
IpMask string: The IP address range in CIDR notation for the rule.
Name string: The name of the filter.

Action string: The desired action for requests captured by this rule. Possible values are Accept, Reject
IpMask string: The IP address range in CIDR notation for the rule.
Name string: The name of the filter.

action string: The desired action for requests captured by this rule. Possible values are Accept, Reject
ipMask string: The IP address range in CIDR notation for the rule.
name string: The name of the filter.

action str: The desired action for requests captured by this rule. Possible values are Accept, Reject
ipMask str: The IP address range in CIDR notation for the rule.
name str: The name of the filter.

IoTHubRoute

See the input and output API doc for this type.

Enabled bool: Used to specify whether a route is enabled.
EndpointNames List<string>: The list of endpoints to which messages that satisfy the condition are routed.
Name string: The name of the route.
Source string: The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.
Condition string: 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.

Enabled bool: Used to specify whether a route is enabled.
EndpointNames []string: The list of endpoints to which messages that satisfy the condition are routed.
Name string: The name of the route.
Source string: The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.
Condition string: 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.

enabled boolean: Used to specify whether a route is enabled.
endpointNames string[]: The list of endpoints to which messages that satisfy the condition are routed.
name string: The name of the route.
source string: The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.
condition string: 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.

enabled bool: Used to specify whether a route is enabled.
endpoint_names List[str]: The list of endpoints to which messages that satisfy the condition are routed.
name str: The name of the route.
source str: The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.
condition str: 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.

IoTHubSharedAccessPolicy

See the output API doc for this type.

KeyName string: The name of the shared access policy.
Permissions string: The permissions assigned to the shared access policy.
PrimaryKey string: The primary key.
SecondaryKey string: The secondary key.

KeyName string: The name of the shared access policy.
Permissions string: The permissions assigned to the shared access policy.
PrimaryKey string: The primary key.
SecondaryKey string: The secondary key.

keyName string: The name of the shared access policy.
permissions string: The permissions assigned to the shared access policy.
primaryKey string: The primary key.
secondaryKey string: The secondary key.

key_name str: The name of the shared access policy.
permissions str: The permissions assigned to the shared access policy.
primary_key str: The primary key.
secondary_key str: The secondary key.

IoTHubSku

See the input and output API doc for this type.

Capacity int: The number of provisioned IoT Hub units.
Name string: The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

Capacity int: The number of provisioned IoT Hub units.
Name string: The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

capacity number: The number of provisioned IoT Hub units.
name string: The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

capacity float: The number of provisioned IoT Hub units.
name str: The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

IoTHub

Create a IoTHub Resource

IoTHub Resource Properties

Inputs

Outputs

Look up an Existing IoTHub Resource

Supporting Types

IoTHubEndpoint

IoTHubFallbackRoute

IoTHubFileUpload

IoTHubIpFilterRule

IoTHubRoute

IoTHubSharedAccessPolicy

IoTHubSku

Package Details

On This Page