iot/iot_hub¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azurecaf_name.ioth["azurecaf_name.ioth"]
azurerm_iothub.iothub["azurerm_iothub.iothub"]
remote:event_hub_auth_rules["remote:event_hub_auth_rules"]
remote:event_hub_namespaces["remote:event_hub_namespaces"]
remote:event_hubs["remote:event_hubs"]
remote:managed_identities["remote:managed_identities"]
remote:resource_groups["remote:resource_groups"]
remote:storage_accounts["remote:storage_accounts"]
azurerm_iothub.iothub --> azurecaf_name.ioth
azurerm_iothub.iothub --> remote:event_hub_auth_rules
azurerm_iothub.iothub --> remote:event_hub_namespaces
azurerm_iothub.iothub --> remote:event_hubs
azurerm_iothub.iothub --> remote:managed_identities
azurerm_iothub.iothub --> remote:resource_groups
azurerm_iothub.iothub --> remote:storage_accounts
Module Reference¶
Category: iot
Path: modules/iot/iot_hub
Azure Resources: azurecaf_name, azurerm_iothub
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
"settings" |
"The settings for the Azure resource." | any |
yes | - |
- |
"global_settings" |
"Global settings object (see module README.md)" | any |
yes | - |
- |
"client_config" |
"Client configuration object (see module README.md)." | any |
yes | - |
- |
"resource_group_name" |
"(Required) Resource group of the IoT Hub" | any |
yes | - |
- |
"resource_group" |
"Resource group object to deploy the IoT Hub" | any |
yes | - |
- |
"location" |
"(Required) Region in which the resource will be deployed" | any |
yes | - |
- |
"remote_objects" |
"Remote objects configuration." | any |
no | {} |
- |
"base_tags" |
"Base tags for the resource to be inherited from the resource group." | bool |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"id" |
- | azurerm_iothub.iothub.id |
|
"name" |
- | azurerm_iothub.iothub.name |
|
"location" |
- | azurerm_iothub.iothub.location |
|
"hostname" |
- | azurerm_iothub.iothub.hostname |
|
"event_hub_events_endpoint" |
- | azurerm_iothub.iothub.event_hub_events_endpoint |
|
"event_hub_events_path" |
- | azurerm_iothub.iothub.event_hub_events_path |
|
"event_hub_operations_endpoint" |
- | azurerm_iothub.iothub.event_hub_operations_endpoint |
|
"event_hub_operations_path" |
- | azurerm_iothub.iothub.event_hub_operations_path |
|
"event_hub_events_namespace" |
- | azurerm_iothub.iothub.event_hub_events_namespace |
|
"identity" |
- | try(azurerm_iothub.iothub.identity, null) |
Sources¶
modules/iot/iot_hub/iot_hub.tfmodules/iot/iot_hub/locals.tfmodules/iot/iot_hub/main.tfmodules/iot/iot_hub/managed_identities.tfmodules/iot/iot_hub/outputs.tfmodules/iot/iot_hub/variables.tf