IotHubDefinitionDescription Class

Description of the IoT hub.

Constructor

IotHubDefinitionDescription(*args: Any, **kwargs: Any)

Variables

Name Description
apply_allocation_policy

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

allocation_weight
int

weight to apply for a given iot h.

name
str

Host name of the IoT hub.

host_name
str

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

authentication_type

IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned. Known values are: "KeyBased", "UserAssigned", and "SystemAssigned".

selected_user_assigned_identity_resource_id
str

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

connection_string
str

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

location
str

ARM region of the IoT hub. Required.

Attributes

allocation_weight

weight to apply for a given iot h.

allocation_weight: int | None

apply_allocation_policy

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

apply_allocation_policy: bool | None

authentication_type

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

authentication_type: str | _models.IotHubAuthenticationType | None

connection_string

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

connection_string: str | None

host_name

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

host_name: str | None

location

ARM region of the IoT hub. Required.

location: str

name

Host name of the IoT hub.

name: str | None

selected_user_assigned_identity_resource_id

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

selected_user_assigned_identity_resource_id: str | None