IotHubDefinitionDescription Class

Description of the IoT hub.

Constructor

IotHubDefinitionDescription()

Variables

Name	Description
applyAllocationPolicy	bool flag for applying allocationPolicy or not for a given iot hub.
allocationWeight	int weight to apply for a given iot h.
name	str Host name of the IoT hub.
hostName	str Host name of the IoT hub. This is required when connectionString is not provided.
authenticationType	Union[str, <xref:"IotHubAuthenticationType">] IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. Known values are: "KeyBased", "UserAssigned", and "SystemAssigned".
selectedUserAssignedIdentityResourceId	str The selected user-assigned identity resource Id associated with IoT hub. This is required when authenticationType is UserAssigned.
connectionString	str Connection string of the IoT hub. This is required when authenticationType is KeyBased.
location	str ARM region of the IoT hub. Required.

Attributes

allocationWeight

weight to apply for a given iot h.

allocationWeight: int

applyAllocationPolicy

flag for applying allocationPolicy or not for a given iot hub.

applyAllocationPolicy: bool

authenticationType

KeyBased, UserAssigned, SystemAssigned. Known values are: "KeyBased", "UserAssigned", and "SystemAssigned".

authenticationType: str | IotHubAuthenticationType

connectionString

Connection string of the IoT hub. This is required when authenticationType is KeyBased.

connectionString: str

hostName

Host name of the IoT hub. This is required when connectionString is not provided.

hostName: str

location

ARM region of the IoT hub. Required.

location: Required[str]

name

Host name of the IoT hub.

name: str

selectedUserAssignedIdentityResourceId

The selected user-assigned identity resource Id associated with IoT hub. This is required when authenticationType is UserAssigned.

selectedUserAssignedIdentityResourceId: str