azure.mgmt.iothub.v2021_03_31.models.IotHubProperties.yml

### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2021_03_31.models.IotHubProperties
name: IotHubProperties
fullName: azure.mgmt.iothub.v2021_03_31.models.IotHubProperties
module: azure.mgmt.iothub.v2021_03_31.models
inheritances:
- azure.mgmt.iothub._serialization.Model
summary: 'The properties of an IoT hub.


  Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
  syntax: 'IotHubProperties(*, authorization_policies: List[_models.SharedAccessSignatureAuthorizationRule]
    | 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, **kwargs: Any)'
  keywordOnlyParameters:
  - name: authorization_policies
    description: 'The shared access policies you can use to secure a connection

      to the IoT hub.'
    types:
    - <xref:list>[<xref:azure.mgmt.iothub.v2021_03_31.models.SharedAccessSignatureAuthorizationRule>]
  - name: public_network_access
    description: 'Whether requests from Public Network are allowed. Known values

      are: "Enabled" and "Disabled".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.iothub.v2021_03_31.models.PublicNetworkAccess>
  - name: ip_filter_rules
    description: The IP filter rules.
    types:
    - <xref:list>[<xref:azure.mgmt.iothub.v2021_03_31.models.IpFilterRule>]
  - name: network_rule_sets
    description: Network Rule Set Properties of IotHub.
    types:
    - <xref:azure.mgmt.iothub.v2021_03_31.models.NetworkRuleSetProperties>
  - name: min_tls_version
    description: '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.'
    types:
    - <xref:str>
  - name: private_endpoint_connections
    description: Private endpoint connections created on this IotHub.
    types:
    - <xref:list>[<xref:azure.mgmt.iothub.v2021_03_31.models.PrivateEndpointConnection>]
  - name: event_hub_endpoints
    description: '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.'
    types:
    - <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2021_03_31.models.EventHubProperties>]
  - name: routing
    description: 'The routing related properties of the IoT hub. See:

      [https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging).'
    types:
    - <xref:azure.mgmt.iothub.v2021_03_31.models.RoutingProperties>
  - name: storage_endpoints
    description: '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.'
    types:
    - <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2021_03_31.models.StorageEndpointProperties>]
  - name: messaging_endpoints
    description: 'The messaging endpoint properties for the file upload

      notification queue.'
    types:
    - <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2021_03_31.models.MessagingEndpointProperties>]
  - name: enable_file_upload_notifications
    description: If True, file upload notifications are enabled.
    types:
    - <xref:bool>
  - name: cloud_to_device
    description: The IoT hub cloud-to-device messaging properties.
    types:
    - <xref:azure.mgmt.iothub.v2021_03_31.models.CloudToDeviceProperties>
  - name: comments
    description: IoT hub comments.
    types:
    - <xref:str>
  - name: features
    description: 'The capabilities and features enabled for the IoT hub. Known values
      are:

      "None" and "DeviceManagement".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.iothub.v2021_03_31.models.Capabilities>
variables:
- description: 'The shared access policies you can use to secure a connection to

    the IoT hub.'
  name: authorization_policies
  types:
  - <xref:list>[<xref:azure.mgmt.iothub.v2021_03_31.models.SharedAccessSignatureAuthorizationRule>]
- description: 'Whether requests from Public Network are allowed. Known values

    are: "Enabled" and "Disabled".'
  name: public_network_access
  types:
  - <xref:str>
  - <xref:azure.mgmt.iothub.v2021_03_31.models.PublicNetworkAccess>
- description: The IP filter rules.
  name: ip_filter_rules
  types:
  - <xref:list>[<xref:azure.mgmt.iothub.v2021_03_31.models.IpFilterRule>]
- description: Network Rule Set Properties of IotHub.
  name: network_rule_sets
  types:
  - <xref:azure.mgmt.iothub.v2021_03_31.models.NetworkRuleSetProperties>
- description: '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.'
  name: min_tls_version
  types:
  - <xref:str>
- description: Private endpoint connections created on this IotHub.
  name: private_endpoint_connections
  types:
  - <xref:list>[<xref:azure.mgmt.iothub.v2021_03_31.models.PrivateEndpointConnection>]
- description: The provisioning state.
  name: provisioning_state
  types:
  - <xref:str>
- description: The hub state.
  name: state
  types:
  - <xref:str>
- description: The name of the host.
  name: host_name
  types:
  - <xref:str>
- description: '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.'
  name: event_hub_endpoints
  types:
  - <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2021_03_31.models.EventHubProperties>]
- description: 'The routing related properties of the IoT hub. See:

    [https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging).'
  name: routing
  types:
  - <xref:azure.mgmt.iothub.v2021_03_31.models.RoutingProperties>
- description: '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.'
  name: storage_endpoints
  types:
  - <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2021_03_31.models.StorageEndpointProperties>]
- description: 'The messaging endpoint properties for the file upload notification

    queue.'
  name: messaging_endpoints
  types:
  - <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2021_03_31.models.MessagingEndpointProperties>]
- description: If True, file upload notifications are enabled.
  name: enable_file_upload_notifications
  types:
  - <xref:bool>
- description: The IoT hub cloud-to-device messaging properties.
  name: cloud_to_device
  types:
  - <xref:azure.mgmt.iothub.v2021_03_31.models.CloudToDeviceProperties>
- description: IoT hub comments.
  name: comments
  types:
  - <xref:str>
- description: 'The capabilities and features enabled for the IoT hub. Known values
    are: "None"

    and "DeviceManagement".'
  name: features
  types:
  - <xref:str>
  - <xref:azure.mgmt.iothub.v2021_03_31.models.Capabilities>
- description: Primary and secondary location for iot hub.
  name: locations
  types:
  - <xref:list>[<xref:azure.mgmt.iothub.v2021_03_31.models.IotHubLocationDescription>]