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, disable_local_auth: bool | None = None, disable_device_sas: bool | None = None, disable_module_sas: bool | None = None, restrict_outbound_network_access: bool | None = None, allowed_fqdn_list: List[str] | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, ip_filter_rules: List[_models.IpFilterRule] | None = None, network_rule_sets: _models.NetworkRuleSetProperties | 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, enable_data_residency: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
authorization_policies	list[SharedAccessSignatureAuthorizationRule] The shared access policies you can use to secure a connection to the IoT hub.
disable_local_auth	bool If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
disable_device_sas	bool If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
disable_module_sas	bool If true, all module scoped SAS keys cannot be used for authentication.
restrict_outbound_network_access	bool If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
allowed_fqdn_list	list[str] List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
public_network_access	str or PublicNetworkAccess Whether requests from Public Network are allowed. Known values are: "Enabled" and "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.
event_hub_endpoints	dict[str, 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[str, 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.
messaging_endpoints	dict[str, MessagingEndpointProperties] The messaging endpoint properties for the file upload notification queue.
enable_file_upload_notifications	bool If True, file upload notifications are enabled.
cloud_to_device	CloudToDeviceProperties The IoT hub cloud-to-device messaging properties.
comments	str IoT hub comments.
features	str or Capabilities The capabilities and features enabled for the IoT hub. Known values are: "None" and "DeviceManagement".
enable_data_residency	bool This property when set to true, will enable data residency, thus, disabling disaster recovery.

Variables

Name	Description
authorization_policies	list[SharedAccessSignatureAuthorizationRule] The shared access policies you can use to secure a connection to the IoT hub.
disable_local_auth	bool If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
disable_device_sas	bool If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
disable_module_sas	bool If true, all module scoped SAS keys cannot be used for authentication.
restrict_outbound_network_access	bool If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
allowed_fqdn_list	list[str] List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
public_network_access	str or PublicNetworkAccess Whether requests from Public Network are allowed. Known values are: "Enabled" and "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[str, 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[str, 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.
messaging_endpoints	dict[str, MessagingEndpointProperties] The messaging endpoint properties for the file upload notification queue.
enable_file_upload_notifications	bool If True, file upload notifications are enabled.
cloud_to_device	CloudToDeviceProperties The IoT hub cloud-to-device messaging properties.
comments	str IoT hub comments.
features	str or Capabilities The capabilities and features enabled for the IoT hub. Known values are: "None" and "DeviceManagement".
locations	list[IotHubLocationDescription] Primary and secondary location for iot hub.
enable_data_residency	bool This property when set to true, will enable data residency, thus, disabling disaster recovery.