IotHubDefinitionDescription interface
Description of the IoT hub.
Properties
| allocation |
weight to apply for a given iot h. |
| apply |
flag for applying allocationPolicy or not for a given iot hub. |
| authentication |
IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. |
| connection |
Connection string of the IoT hub. This is required when authenticationType is KeyBased. |
| host |
Host name of the IoT hub. This is required when connectionString is not provided. |
| location | ARM region of the IoT hub. |
| name | Host name of the IoT hub. |
| selected |
The selected user-assigned identity resource Id associated with IoT hub. This is required when authenticationType is UserAssigned. |
Property Details
allocationWeight
weight to apply for a given iot h.
allocationWeight?: numberProperty Value
number
applyAllocationPolicy
flag for applying allocationPolicy or not for a given iot hub.
applyAllocationPolicy?: booleanProperty Value
boolean
authenticationType
IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.
authenticationType?: stringProperty Value
string
connectionString
Connection string of the IoT hub. This is required when authenticationType is KeyBased.
connectionString?: stringProperty Value
string
hostName
Host name of the IoT hub. This is required when connectionString is not provided.
hostName?: stringProperty Value
string
location
ARM region of the IoT hub.
location: stringProperty Value
string
name
Host name of the IoT hub.
name?: stringProperty Value
string
selectedUserAssignedIdentityResourceId
The selected user-assigned identity resource Id associated with IoT hub. This is required when authenticationType is UserAssigned.
selectedUserAssignedIdentityResourceId?: stringProperty Value
string