IotHubProperties Class

The properties of an IoT hub.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.iothub._serialization.Model
IotHubProperties

Constructor

IotHubProperties(*, authorization_policies: List[_models.SharedAccessSignatureAuthorizationRule] | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, ip_filter_rules: List[_models.IpFilterRule] | None = None, min_tls_version: str | None = None, private_endpoint_connections: List[_models.PrivateEndpointConnection] | None = None, event_hub_endpoints: Dict[str, _models.EventHubProperties] | None = None, routing: _models.RoutingProperties | None = None, storage_endpoints: Dict[str, _models.StorageEndpointProperties] | None = None, messaging_endpoints: Dict[str, _models.MessagingEndpointProperties] | None = None, enable_file_upload_notifications: bool | None = None, cloud_to_device: _models.CloudToDeviceProperties | None = None, comments: str | None = None, features: str | _models.Capabilities | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
authorization_policies

The shared access policies you can use to secure a connection to the IoT hub.

public_network_access

Whether requests from Public Network are allowed. Known values are: "Enabled" and "Disabled".

ip_filter_rules

The IP filter rules.

min_tls_version
str

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

private_endpoint_connections

Private endpoint connections created on this IotHub.

event_hub_endpoints

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

routing

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging.

storage_endpoints

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

messaging_endpoints

The messaging endpoint properties for the file upload notification queue.

enable_file_upload_notifications

If True, file upload notifications are enabled.

cloud_to_device

The IoT hub cloud-to-device messaging properties.

comments
str

IoT hub comments.

features

The capabilities and features enabled for the IoT hub. Known values are: "None" and "DeviceManagement".

Variables

Name Description
authorization_policies

The shared access policies you can use to secure a connection to the IoT hub.

public_network_access

Whether requests from Public Network are allowed. Known values are: "Enabled" and "Disabled".

ip_filter_rules

The IP filter rules.

min_tls_version
str

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

private_endpoint_connections

Private endpoint connections created on this IotHub.

provisioning_state
str

The provisioning state.

state
str

The hub state.

host_name
str

The name of the host.

event_hub_endpoints

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

routing

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging.

storage_endpoints

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

messaging_endpoints

The messaging endpoint properties for the file upload notification queue.

enable_file_upload_notifications

If True, file upload notifications are enabled.

cloud_to_device

The IoT hub cloud-to-device messaging properties.

comments
str

IoT hub comments.

features

The capabilities and features enabled for the IoT hub. Known values are: "None" and "DeviceManagement".

locations

Primary and secondary location for iot hub.