IotHubProperties Class

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.v2019_07_01_preview.models._models_py3.SharedAccessSignatureAuthorizationRule]] = None, ip_filter_rules: Optional[List[azure.mgmt.iothub.v2019_07_01_preview.models._models_py3.IpFilterRule]] = None, event_hub_endpoints: Optional[Dict[str, azure.mgmt.iothub.v2019_07_01_preview.models._models_py3.EventHubProperties]] = None, routing: Optional[azure.mgmt.iothub.v2019_07_01_preview.models._models_py3.RoutingProperties] = None, storage_endpoints: Optional[Dict[str, azure.mgmt.iothub.v2019_07_01_preview.models._models_py3.StorageEndpointProperties]] = None, messaging_endpoints: Optional[Dict[str, azure.mgmt.iothub.v2019_07_01_preview.models._models_py3.MessagingEndpointProperties]] = None, enable_file_upload_notifications: Optional[bool] = None, cloud_to_device: Optional[azure.mgmt.iothub.v2019_07_01_preview.models._models_py3.CloudToDeviceProperties] = None, comments: Optional[str] = None, device_streams: Optional[azure.mgmt.iothub.v2019_07_01_preview.models._models_py3.IotHubPropertiesDeviceStreams] = None, features: Optional[Union[str, azure.mgmt.iothub.v2019_07_01_preview.models._iot_hub_client_enums.Capabilities]] = None, **kwargs)

Variables

authorization_policies

list[SharedAccessSignatureAuthorizationRule]

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

ip_filter_rules

list[IpFilterRule]

The IP filter rules.

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.v2019_07_01_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.v2019_07_01_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.

messaging_endpoints

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

device_streams

IotHubPropertiesDeviceStreams

The device streams properties of iothub.

features

str or Capabilities

The capabilities and features enabled for the IoT hub. Possible values include: "None", "DeviceManagement".

locations

list[IotHubLocationDescription]

Primary and secondary location for iot hub.