IotHubProperties Class

Reference

The properties of an IoT hub.

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

Inheritance: Model

IotHubProperties

Constructor

IotHubProperties(*, authorization_policies: Optional[List[azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.SharedAccessSignatureAuthorizationRule]] = None, public_network_access: Optional[Union[str, azure.mgmt.iothub.v2021_03_03_preview.models._iot_hub_client_enums.PublicNetworkAccess]] = None, ip_filter_rules: Optional[List[azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.IpFilterRule]] = None, network_rule_sets: Optional[azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.NetworkRuleSetProperties] = None, min_tls_version: Optional[str] = None, private_endpoint_connections: Optional[List[azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.PrivateEndpointConnection]] = None, event_hub_endpoints: Optional[Dict[str, azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.EventHubProperties]] = None, routing: Optional[azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.RoutingProperties] = None, storage_endpoints: Optional[Dict[str, azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.StorageEndpointProperties]] = None, messaging_endpoints: Optional[Dict[str, azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.MessagingEndpointProperties]] = None, enable_file_upload_notifications: Optional[bool] = None, cloud_to_device: Optional[azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.CloudToDeviceProperties] = None, comments: Optional[str] = None, device_streams: Optional[azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.IotHubPropertiesDeviceStreams] = None, features: Optional[Union[str, azure.mgmt.iothub.v2021_03_03_preview.models._iot_hub_client_enums.Capabilities]] = None, encryption: Optional[azure.mgmt.iothub.v2021_03_03_preview.models._models_py3.EncryptionPropertiesDescription] = None, **kwargs)

Variables

authorization_policies: list[SharedAccessSignatureAuthorizationRule]

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

public_network_access: str or PublicNetworkAccess

Whether requests from Public Network are allowed. Possible values include: "Enabled", "Disabled".

ip_filter_rules: list[IpFilterRule]

The IP filter rules.

network_rule_sets: NetworkRuleSetProperties

Network Rule Set Properties of IotHub.

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: list[PrivateEndpointConnection]

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: dict[<xref:str,azure.mgmt.iothub.v2021_03_03_preview.models.EventHubProperties>]

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: RoutingProperties

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

storage_endpoints: dict[<xref:str,azure.mgmt.iothub.v2021_03_03_preview.models.StorageEndpointProperties>]

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.