azure.mgmt.iothub.v2023_06_30.models module

class azure.mgmt.iothub.v2023_06_30.models.AccessRights(*values)[source]

Bases: str, Enum

The permissions assigned to the shared access policy.

DEVICE_CONNECT = 'DeviceConnect'
REGISTRY_READ = 'RegistryRead'
REGISTRY_READ_DEVICE_CONNECT = 'RegistryRead, DeviceConnect'
REGISTRY_READ_REGISTRY_WRITE = 'RegistryRead, RegistryWrite'
REGISTRY_READ_REGISTRY_WRITE_DEVICE_CONNECT = 'RegistryRead, RegistryWrite, DeviceConnect'
REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECT = 'RegistryRead, RegistryWrite, ServiceConnect'
REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECT = 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect'
REGISTRY_READ_SERVICE_CONNECT = 'RegistryRead, ServiceConnect'
REGISTRY_READ_SERVICE_CONNECT_DEVICE_CONNECT = 'RegistryRead, ServiceConnect, DeviceConnect'
REGISTRY_WRITE = 'RegistryWrite'
REGISTRY_WRITE_DEVICE_CONNECT = 'RegistryWrite, DeviceConnect'
REGISTRY_WRITE_SERVICE_CONNECT = 'RegistryWrite, ServiceConnect'
REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECT = 'RegistryWrite, ServiceConnect, DeviceConnect'
SERVICE_CONNECT = 'ServiceConnect'
SERVICE_CONNECT_DEVICE_CONNECT = 'ServiceConnect, DeviceConnect'
class azure.mgmt.iothub.v2023_06_30.models.ArmIdentity(*, type: str | _models.ResourceIdentityType | None = None, user_assigned_identities: Dict[str, _models.ArmUserIdentity] | None = None, **kwargs: Any)[source]

Bases: Model

ArmIdentity.

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

Variables:

  • principal_id (str) – Principal Id.

  • tenant_id (str) – Tenant Id.

  • type (str or ResourceIdentityType) – The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.

  • user_assigned_identities (dict[str, ArmUserIdentity]) – Dictionary of <ArmUserIdentity>.

Keyword Arguments:

  • type (str or ResourceIdentityType) – The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.

  • user_assigned_identities (dict[str, ArmUserIdentity]) – Dictionary of <ArmUserIdentity>.

class azure.mgmt.iothub.v2023_06_30.models.ArmUserIdentity(**kwargs: Any)[source]

Bases: Model

ArmUserIdentity.

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

Variables:

  • principal_id (str)

  • client_id (str)

class azure.mgmt.iothub.v2023_06_30.models.AuthenticationType(*values)[source]

Bases: str, Enum

Specifies authentication type being used for connecting to the storage account.

IDENTITY_BASED = 'identityBased'
KEY_BASED = 'keyBased'
class azure.mgmt.iothub.v2023_06_30.models.Capabilities(*values)[source]

Bases: str, Enum

The capabilities and features enabled for the IoT hub.

DEVICE_MANAGEMENT = 'DeviceManagement'
NONE = 'None'
class azure.mgmt.iothub.v2023_06_30.models.CertificateBodyDescription(*, certificate: str | None = None, is_verified: bool | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized X509 Certificate.

Variables:

  • certificate (str) – base-64 representation of the X509 leaf certificate .cer file or just .pem file content.

  • is_verified (bool) – True indicates that the certificate will be created in verified state and proof of possession will not be required.

Keyword Arguments:

  • certificate (str) – base-64 representation of the X509 leaf certificate .cer file or just .pem file content.

  • is_verified (bool) – True indicates that the certificate will be created in verified state and proof of possession will not be required.

class azure.mgmt.iothub.v2023_06_30.models.CertificateDescription(*, properties: _models.CertificateProperties | None = None, **kwargs: Any)[source]

Bases: Model

The X509 Certificate.

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

Variables:

  • properties (CertificateProperties) – The description of an X509 CA Certificate.

  • id (str) – The resource identifier.

  • name (str) – The name of the certificate.

  • etag (str) – The entity tag.

  • type (str) – The resource type.

Keyword Arguments:

properties (CertificateProperties) – The description of an X509 CA Certificate.

class azure.mgmt.iothub.v2023_06_30.models.CertificateListDescription(*, value: List[_models.CertificateDescription] | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized array of Certificate objects.

Variables:

value (list[CertificateDescription]) – The array of Certificate objects.

Keyword Arguments:

value (list[CertificateDescription]) – The array of Certificate objects.

class azure.mgmt.iothub.v2023_06_30.models.CertificateProperties(*, is_verified: bool | None = None, certificate: str | None = None, **kwargs: Any)[source]

Bases: Model

The description of an X509 CA Certificate.

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

Variables:

  • subject (str) – The certificate’s subject name.

  • expiry (datetime) – The certificate’s expiration date and time.

  • thumbprint (str) – The certificate’s thumbprint.

  • is_verified (bool) – Determines whether certificate has been verified.

  • created (datetime) – The certificate’s create date and time.

  • updated (datetime) – The certificate’s last update date and time.

  • certificate (str) – The certificate content.

Keyword Arguments:

  • is_verified (bool) – Determines whether certificate has been verified.

  • certificate (str) – The certificate content.

class azure.mgmt.iothub.v2023_06_30.models.CertificatePropertiesWithNonce(**kwargs: Any)[source]

Bases: Model

The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

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

Variables:

  • subject (str) – The certificate’s subject name.

  • expiry (datetime) – The certificate’s expiration date and time.

  • thumbprint (str) – The certificate’s thumbprint.

  • is_verified (bool) – Determines whether certificate has been verified.

  • created (datetime) – The certificate’s create date and time.

  • updated (datetime) – The certificate’s last update date and time.

  • verification_code (str) – The certificate’s verification code that will be used for proof of possession.

  • certificate (str) – The certificate content.

class azure.mgmt.iothub.v2023_06_30.models.CertificateVerificationDescription(*, certificate: str | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized leaf certificate.

Variables:

certificate (str) – base-64 representation of X509 certificate .cer file or just .pem file content.

Keyword Arguments:

certificate (str) – base-64 representation of X509 certificate .cer file or just .pem file content.

class azure.mgmt.iothub.v2023_06_30.models.CertificateWithNonceDescription(*, properties: _models.CertificatePropertiesWithNonce | None = None, **kwargs: Any)[source]

Bases: Model

The X509 Certificate.

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

Variables:

  • properties (CertificatePropertiesWithNonce) – The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

  • id (str) – The resource identifier.

  • name (str) – The name of the certificate.

  • etag (str) – The entity tag.

  • type (str) – The resource type.

Keyword Arguments:

properties (CertificatePropertiesWithNonce) – The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

class azure.mgmt.iothub.v2023_06_30.models.CloudToDeviceProperties(*, max_delivery_count: int | None = None, default_ttl_as_iso8601: timedelta | None = None, feedback: _models.FeedbackProperties | None = None, **kwargs: Any)[source]

Bases: Model

The IoT hub cloud-to-device messaging properties.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.CreatedByType(*values)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.iothub.v2023_06_30.models.DefaultAction(*values)[source]

Bases: str, Enum

Default Action for Network Rule Set.

ALLOW = 'Allow'
DENY = 'Deny'
class azure.mgmt.iothub.v2023_06_30.models.EndpointHealthData(*, endpoint_id: str | None = None, health_status: str | _models.EndpointHealthStatus | None = None, last_known_error: str | None = None, last_known_error_time: datetime | None = None, last_successful_send_attempt_time: datetime | None = None, last_send_attempt_time: datetime | None = None, **kwargs: Any)[source]

Bases: Model

The health data for an endpoint.

Variables:

  • endpoint_id (str) – Id of the endpoint.

  • health_status (str or EndpointHealthStatus) – Health statuses have following meanings. The ‘healthy’ status shows that the endpoint is accepting messages as expected. The ‘unhealthy’ status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The ‘dead’ status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The ‘unknown’ status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. Known values are: “unknown”, “healthy”, “degraded”, “unhealthy”, and “dead”.

  • last_known_error (str) – Last error obtained when a message failed to be delivered to iot hub.

  • last_known_error_time (datetime) – Time at which the last known error occurred.

  • last_successful_send_attempt_time (datetime) – Last time iot hub successfully sent a message to the endpoint.

  • last_send_attempt_time (datetime) – Last time iot hub tried to send a message to the endpoint.

Keyword Arguments:

  • endpoint_id (str) – Id of the endpoint.

  • health_status (str or EndpointHealthStatus) – Health statuses have following meanings. The ‘healthy’ status shows that the endpoint is accepting messages as expected. The ‘unhealthy’ status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The ‘dead’ status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The ‘unknown’ status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. Known values are: “unknown”, “healthy”, “degraded”, “unhealthy”, and “dead”.

  • last_known_error (str) – Last error obtained when a message failed to be delivered to iot hub.

  • last_known_error_time (datetime) – Time at which the last known error occurred.

  • last_successful_send_attempt_time (datetime) – Last time iot hub successfully sent a message to the endpoint.

  • last_send_attempt_time (datetime) – Last time iot hub tried to send a message to the endpoint.

class azure.mgmt.iothub.v2023_06_30.models.EndpointHealthDataListResult(*, value: List[_models.EndpointHealthData] | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized array of EndpointHealthData objects with a next link.

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

Variables:

  • value (list[EndpointHealthData]) – JSON-serialized array of Endpoint health data.

  • next_link (str) – Link to more results.

Keyword Arguments:

value (list[EndpointHealthData]) – JSON-serialized array of Endpoint health data.

class azure.mgmt.iothub.v2023_06_30.models.EndpointHealthStatus(*values)[source]

Bases: str, Enum

Health statuses have following meanings. The ‘healthy’ status shows that the endpoint is accepting messages as expected. The ‘unhealthy’ status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The ‘dead’ status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The ‘unknown’ status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint.

DEAD = 'dead'
DEGRADED = 'degraded'
HEALTHY = 'healthy'
UNHEALTHY = 'unhealthy'
UNKNOWN = 'unknown'
class azure.mgmt.iothub.v2023_06_30.models.EnrichmentProperties(*, key: str, value: str, endpoint_names: List[str], **kwargs: Any)[source]

Bases: Model

The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.

All required parameters must be populated in order to send to server.

Variables:

  • key (str) – The key or name for the enrichment property. Required.

  • value (str) – The value for the enrichment property. Required.

  • endpoint_names (list[str]) – The list of endpoints for which the enrichment is applied to the message. Required.

Keyword Arguments:

  • key (str) – The key or name for the enrichment property. Required.

  • value (str) – The value for the enrichment property. Required.

  • endpoint_names (list[str]) – The list of endpoints for which the enrichment is applied to the message. Required.

class azure.mgmt.iothub.v2023_06_30.models.ErrorDetails(**kwargs: Any)[source]

Bases: Model

Error details.

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

Variables:

  • code (str) – The error code.

  • http_status_code (str) – The HTTP status code.

  • message (str) – The error message.

  • details (str) – The error details.

class azure.mgmt.iothub.v2023_06_30.models.EventHubConsumerGroupBodyDescription(*, properties: _models.EventHubConsumerGroupName, **kwargs: Any)[source]

Bases: Model

The EventHub consumer group.

All required parameters must be populated in order to send to server.

Variables:

properties (EventHubConsumerGroupName) – The EventHub consumer group name. Required.

Keyword Arguments:

properties (EventHubConsumerGroupName) – The EventHub consumer group name. Required.

class azure.mgmt.iothub.v2023_06_30.models.EventHubConsumerGroupInfo(*, properties: Dict[str, Any] | None = None, **kwargs: Any)[source]

Bases: Model

The properties of the EventHubConsumerGroupInfo object.

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

Variables:

  • properties (dict[str, any]) – The tags.

  • id (str) – The Event Hub-compatible consumer group identifier.

  • name (str) – The Event Hub-compatible consumer group name.

  • type (str) – the resource type.

  • etag (str) – The etag.

Keyword Arguments:

properties (dict[str, any]) – The tags.

class azure.mgmt.iothub.v2023_06_30.models.EventHubConsumerGroupName(*, name: str, **kwargs: Any)[source]

Bases: Model

The EventHub consumer group name.

All required parameters must be populated in order to send to server.

Variables:

name (str) – EventHub consumer group name. Required.

Keyword Arguments:

name (str) – EventHub consumer group name. Required.

class azure.mgmt.iothub.v2023_06_30.models.EventHubConsumerGroupsListResult(*, value: List[_models.EventHubConsumerGroupInfo] | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized array of Event Hub-compatible consumer group names with a next link.

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

Variables:
Keyword Arguments:

value (list[EventHubConsumerGroupInfo]) – List of consumer groups objects.

class azure.mgmt.iothub.v2023_06_30.models.EventHubProperties(*, retention_time_in_days: int | None = None, partition_count: int | None = None, **kwargs: Any)[source]

Bases: Model

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

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

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.ExportDevicesRequest(*, export_blob_container_uri: str, exclude_keys: bool, export_blob_name: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, include_configurations: bool | None = None, configurations_blob_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Use to provide parameters when requesting an export of all devices in the IoT hub.

All required parameters must be populated in order to send to server.

Variables:

  • export_blob_container_uri (str) – The export blob container URI. Required.

  • exclude_keys (bool) – The value indicating whether keys should be excluded during export. Required.

  • export_blob_name (str) – The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.

  • authentication_type (str or AuthenticationType) – Specifies authentication type being used for connecting to the storage account. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of storage endpoint for export devices.

  • include_configurations (bool) – The value indicating whether configurations should be exported.

  • configurations_blob_name (str) – The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.

Keyword Arguments:

  • export_blob_container_uri (str) – The export blob container URI. Required.

  • exclude_keys (bool) – The value indicating whether keys should be excluded during export. Required.

  • export_blob_name (str) – The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.

  • authentication_type (str or AuthenticationType) – Specifies authentication type being used for connecting to the storage account. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of storage endpoint for export devices.

  • include_configurations (bool) – The value indicating whether configurations should be exported.

  • configurations_blob_name (str) – The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.

class azure.mgmt.iothub.v2023_06_30.models.FailoverInput(*, failover_region: str, **kwargs: Any)[source]

Bases: Model

Use to provide failover region when requesting manual Failover for a hub.

All required parameters must be populated in order to send to server.

Variables:

failover_region (str) – Region the hub will be failed over to. Required.

Keyword Arguments:

failover_region (str) – Region the hub will be failed over to. Required.

class azure.mgmt.iothub.v2023_06_30.models.FallbackRouteProperties(*, source: str | _models.RoutingSource, endpoint_names: List[str], is_enabled: bool, name: str | None = None, condition: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

  • source (str or RoutingSource) – The source to which the routing rule is to be applied to. For example, DeviceMessages. Required. Known values are: “Invalid”, “DeviceMessages”, “TwinChangeEvents”, “DeviceLifecycleEvents”, “DeviceJobLifecycleEvents”, and “DeviceConnectionStateEvents”.

  • condition (str) – The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

  • endpoint_names (list[str]) – The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. Required.

  • is_enabled (bool) – Used to specify whether the fallback route is enabled. Required.

Keyword Arguments:

  • name (str) – The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

  • source (str or RoutingSource) – The source to which the routing rule is to be applied to. For example, DeviceMessages. Required. Known values are: “Invalid”, “DeviceMessages”, “TwinChangeEvents”, “DeviceLifecycleEvents”, “DeviceJobLifecycleEvents”, and “DeviceConnectionStateEvents”.

  • condition (str) – The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

  • endpoint_names (list[str]) – The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. Required.

  • is_enabled (bool) – Used to specify whether the fallback route is enabled. Required.

class azure.mgmt.iothub.v2023_06_30.models.FeedbackProperties(*, lock_duration_as_iso8601: timedelta | None = None, ttl_as_iso8601: timedelta | None = None, max_delivery_count: int | None = None, **kwargs: Any)[source]

Bases: Model

The properties of the feedback queue for cloud-to-device messages.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.GroupIdInformation(*, properties: _models.GroupIdInformationProperties, **kwargs: Any)[source]

Bases: Model

The group information for creating a private endpoint on an IotHub.

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

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • properties (GroupIdInformationProperties) – The properties for a group information object. Required.

Keyword Arguments:

properties (GroupIdInformationProperties) – The properties for a group information object. Required.

class azure.mgmt.iothub.v2023_06_30.models.GroupIdInformationProperties(*, group_id: str | None = None, required_members: List[str] | None = None, required_zone_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The properties for a group information object.

Variables:

  • group_id (str) – The group id.

  • required_members (list[str]) – The required members for a specific group id.

  • required_zone_names (list[str]) – The required DNS zones for a specific group id.

Keyword Arguments:

  • group_id (str) – The group id.

  • required_members (list[str]) – The required members for a specific group id.

  • required_zone_names (list[str]) – The required DNS zones for a specific group id.

class azure.mgmt.iothub.v2023_06_30.models.ImportDevicesRequest(*, input_blob_container_uri: str, output_blob_container_uri: str, input_blob_name: str | None = None, output_blob_name: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, include_configurations: bool | None = None, configurations_blob_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Use to provide parameters when requesting an import of all devices in the hub.

All required parameters must be populated in order to send to server.

Variables:

  • input_blob_container_uri (str) – The input blob container URI. Required.

  • output_blob_container_uri (str) – The output blob container URI. Required.

  • input_blob_name (str) – The blob name to be used when importing from the provided input blob container.

  • output_blob_name (str) – The blob name to use for storing the status of the import job.

  • authentication_type (str or AuthenticationType) – Specifies authentication type being used for connecting to the storage account. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of storage endpoint for import devices.

  • include_configurations (bool) – The value indicating whether configurations should be imported.

  • configurations_blob_name (str) – The blob name to be used when importing configurations from the provided input blob container.

Keyword Arguments:

  • input_blob_container_uri (str) – The input blob container URI. Required.

  • output_blob_container_uri (str) – The output blob container URI. Required.

  • input_blob_name (str) – The blob name to be used when importing from the provided input blob container.

  • output_blob_name (str) – The blob name to use for storing the status of the import job.

  • authentication_type (str or AuthenticationType) – Specifies authentication type being used for connecting to the storage account. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of storage endpoint for import devices.

  • include_configurations (bool) – The value indicating whether configurations should be imported.

  • configurations_blob_name (str) – The blob name to be used when importing configurations from the provided input blob container.

class azure.mgmt.iothub.v2023_06_30.models.IotHubCapacity(**kwargs: Any)[source]

Bases: Model

IoT Hub capacity information.

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

Variables:

  • minimum (int) – The minimum number of units.

  • maximum (int) – The maximum number of units.

  • default (int) – The default number of units.

  • scale_type (str or IotHubScaleType) – The type of the scaling enabled. Known values are: “Automatic”, “Manual”, and “None”.

class azure.mgmt.iothub.v2023_06_30.models.IotHubDescription(*, location: str, sku: _models.IotHubSkuInfo, tags: Dict[str, str] | None = None, etag: str | None = None, properties: _models.IotHubProperties | None = None, identity: _models.ArmIdentity | None = None, **kwargs: Any)[source]

Bases: Resource

The description of the IoT hub.

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

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • location (str) – The resource location. Required.

  • tags (dict[str, str]) – The resource tags.

  • etag (str) – The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

  • properties (IotHubProperties) – IotHub properties.

  • sku (IotHubSkuInfo) – IotHub SKU info. Required.

  • identity (ArmIdentity) – The managed identities for the IotHub.

  • system_data (SystemData) – The system meta data relating to this resource.

Keyword Arguments:

  • location (str) – The resource location. Required.

  • tags (dict[str, str]) – The resource tags.

  • etag (str) – The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

  • properties (IotHubProperties) – IotHub properties.

  • sku (IotHubSkuInfo) – IotHub SKU info. Required.

  • identity (ArmIdentity) – The managed identities for the IotHub.

class azure.mgmt.iothub.v2023_06_30.models.IotHubDescriptionListResult(*, value: List[_models.IotHubDescription] | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized array of IotHubDescription objects with a next link.

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

Variables:
Keyword Arguments:

value (list[IotHubDescription]) – The array of IotHubDescription objects.

class azure.mgmt.iothub.v2023_06_30.models.IotHubLocationDescription(*, location: str | None = None, role: str | _models.IotHubReplicaRoleType | None = None, **kwargs: Any)[source]

Bases: Model

Public representation of one of the locations where a resource is provisioned.

Variables:

  • location (str) – The name of the Azure region.

  • role (str or IotHubReplicaRoleType) – The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. Known values are: “primary” and “secondary”.

Keyword Arguments:

  • location (str) – The name of the Azure region.

  • role (str or IotHubReplicaRoleType) – The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. Known values are: “primary” and “secondary”.

class azure.mgmt.iothub.v2023_06_30.models.IotHubNameAvailabilityInfo(*, message: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties indicating whether a given IoT hub name is available.

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

Variables:

  • name_available (bool) – The value which indicates whether the provided name is available.

  • reason (str or IotHubNameUnavailabilityReason) – The reason for unavailability. Known values are: “Invalid” and “AlreadyExists”.

  • message (str) – The detailed reason message.

Keyword Arguments:

message (str) – The detailed reason message.

class azure.mgmt.iothub.v2023_06_30.models.IotHubNameUnavailabilityReason(*values)[source]

Bases: str, Enum

The reason for unavailability.

ALREADY_EXISTS = 'AlreadyExists'
INVALID = 'Invalid'
class azure.mgmt.iothub.v2023_06_30.models.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)[source]

Bases: Model

The properties of an IoT hub.

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

Variables:

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

Keyword Arguments:

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

class azure.mgmt.iothub.v2023_06_30.models.IotHubQuotaMetricInfo(**kwargs: Any)[source]

Bases: Model

Quota metrics properties.

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

Variables:

  • name (str) – The name of the quota metric.

  • current_value (int) – The current value for the quota metric.

  • max_value (int) – The maximum value of the quota metric.

class azure.mgmt.iothub.v2023_06_30.models.IotHubQuotaMetricInfoListResult(*, value: List[_models.IotHubQuotaMetricInfo] | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.

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

Variables:
Keyword Arguments:

value (list[IotHubQuotaMetricInfo]) – The array of quota metrics objects.

class azure.mgmt.iothub.v2023_06_30.models.IotHubReplicaRoleType(*values)[source]

Bases: str, Enum

The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

PRIMARY = 'primary'
SECONDARY = 'secondary'
class azure.mgmt.iothub.v2023_06_30.models.IotHubScaleType(*values)[source]

Bases: str, Enum

The type of the scaling enabled.

AUTOMATIC = 'Automatic'
MANUAL = 'Manual'
NONE = 'None'
class azure.mgmt.iothub.v2023_06_30.models.IotHubSku(*values)[source]

Bases: str, Enum

The name of the SKU.

B1 = 'B1'
B2 = 'B2'
B3 = 'B3'
F1 = 'F1'
S1 = 'S1'
S2 = 'S2'
S3 = 'S3'
class azure.mgmt.iothub.v2023_06_30.models.IotHubSkuDescription(*, sku: _models.IotHubSkuInfo, capacity: _models.IotHubCapacity, **kwargs: Any)[source]

Bases: Model

SKU properties.

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

All required parameters must be populated in order to send to server.

Variables:

  • resource_type (str) – The type of the resource.

  • sku (IotHubSkuInfo) – The type of the resource. Required.

  • capacity (IotHubCapacity) – IotHub capacity. Required.

Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.IotHubSkuDescriptionListResult(*, value: List[_models.IotHubSkuDescription] | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized array of IotHubSkuDescription objects with a next link.

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

Variables:
Keyword Arguments:

value (list[IotHubSkuDescription]) – The array of IotHubSkuDescription.

class azure.mgmt.iothub.v2023_06_30.models.IotHubSkuInfo(*, name: str | _models.IotHubSku, capacity: int | None = None, **kwargs: Any)[source]

Bases: Model

Information about the SKU of the IoT hub.

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

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.IotHubSkuTier(*values)[source]

Bases: str, Enum

The billing tier for the IoT hub.

BASIC = 'Basic'
FREE = 'Free'
STANDARD = 'Standard'
class azure.mgmt.iothub.v2023_06_30.models.IpFilterActionType(*values)[source]

Bases: str, Enum

The desired action for requests captured by this rule.

ACCEPT = 'Accept'
REJECT = 'Reject'
class azure.mgmt.iothub.v2023_06_30.models.IpFilterRule(*, filter_name: str, action: str | _models.IpFilterActionType, ip_mask: str, **kwargs: Any)[source]

Bases: Model

The IP filter rules for the IoT hub.

All required parameters must be populated in order to send to server.

Variables:

  • filter_name (str) – The name of the IP filter rule. Required.

  • action (str or IpFilterActionType) – The desired action for requests captured by this rule. Required. Known values are: “Accept” and “Reject”.

  • ip_mask (str) – A string that contains the IP address range in CIDR notation for the rule. Required.

Keyword Arguments:

  • filter_name (str) – The name of the IP filter rule. Required.

  • action (str or IpFilterActionType) – The desired action for requests captured by this rule. Required. Known values are: “Accept” and “Reject”.

  • ip_mask (str) – A string that contains the IP address range in CIDR notation for the rule. Required.

class azure.mgmt.iothub.v2023_06_30.models.JobResponse(**kwargs: Any)[source]

Bases: Model

The properties of the Job Response object.

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

Variables:

  • job_id (str) – The job identifier.

  • start_time_utc (datetime) – The start time of the job.

  • end_time_utc (datetime) – The time the job stopped processing.

  • type (str or JobType) – The type of the job. Known values are: “unknown”, “export”, “import”, “backup”, “readDeviceProperties”, “writeDeviceProperties”, “updateDeviceConfiguration”, “rebootDevice”, “factoryResetDevice”, “firmwareUpdate”, and “import”.

  • status (str or JobStatus) – The status of the job. Known values are: “unknown”, “enqueued”, “running”, “completed”, “failed”, and “cancelled”.

  • failure_reason (str) – If status == failed, this string containing the reason for the failure.

  • status_message (str) – The status message for the job.

  • parent_job_id (str) – The job identifier of the parent job, if any.

class azure.mgmt.iothub.v2023_06_30.models.JobResponseListResult(*, value: List[_models.JobResponse] | None = None, **kwargs: Any)[source]

Bases: Model

The JSON-serialized array of JobResponse objects with a next link.

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

Variables:

  • value (list[JobResponse]) – The array of JobResponse objects.

  • next_link (str) – The next link.

Keyword Arguments:

value (list[JobResponse]) – The array of JobResponse objects.

class azure.mgmt.iothub.v2023_06_30.models.JobStatus(*values)[source]

Bases: str, Enum

The status of the job.

CANCELLED = 'cancelled'
COMPLETED = 'completed'
ENQUEUED = 'enqueued'
FAILED = 'failed'
RUNNING = 'running'
UNKNOWN = 'unknown'
class azure.mgmt.iothub.v2023_06_30.models.JobType(*values)[source]

Bases: str, Enum

The type of the job.

BACKUP = 'backup'
EXPORT = 'export'
FACTORY_RESET_DEVICE = 'factoryResetDevice'
FIRMWARE_UPDATE = 'firmwareUpdate'
IMPORT = 'import'
IMPORT_ENUM = 'import'
READ_DEVICE_PROPERTIES = 'readDeviceProperties'
REBOOT_DEVICE = 'rebootDevice'
UNKNOWN = 'unknown'
UPDATE_DEVICE_CONFIGURATION = 'updateDeviceConfiguration'
WRITE_DEVICE_PROPERTIES = 'writeDeviceProperties'
class azure.mgmt.iothub.v2023_06_30.models.ManagedIdentity(*, user_assigned_identity: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties of the Managed identity.

Variables:

user_assigned_identity (str) – The user assigned identity.

Keyword Arguments:

user_assigned_identity (str) – The user assigned identity.

class azure.mgmt.iothub.v2023_06_30.models.MatchedRoute(*, properties: _models.RouteProperties | None = None, **kwargs: Any)[source]

Bases: Model

Routes that matched.

Variables:

properties (RouteProperties) – Properties of routes that matched.

Keyword Arguments:

properties (RouteProperties) – Properties of routes that matched.

class azure.mgmt.iothub.v2023_06_30.models.MessagingEndpointProperties(*, lock_duration_as_iso8601: timedelta | None = None, ttl_as_iso8601: timedelta | None = None, max_delivery_count: int | None = None, **kwargs: Any)[source]

Bases: Model

The properties of the messaging endpoints used by this IoT hub.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.Name(*, value: str | None = None, localized_value: str | None = None, **kwargs: Any)[source]

Bases: Model

Name of Iot Hub type.

Variables:

  • value (str) – IotHub type.

  • localized_value (str) – Localized value of name.

Keyword Arguments:

  • value (str) – IotHub type.

  • localized_value (str) – Localized value of name.

class azure.mgmt.iothub.v2023_06_30.models.NetworkRuleIPAction(*values)[source]

Bases: str, Enum

IP Filter Action.

ALLOW = 'Allow'
class azure.mgmt.iothub.v2023_06_30.models.NetworkRuleSetIpRule(*, filter_name: str, ip_mask: str, action: str | _models.NetworkRuleIPAction = 'Allow', **kwargs: Any)[source]

Bases: Model

IP Rule to be applied as part of Network Rule Set.

All required parameters must be populated in order to send to server.

Variables:

  • filter_name (str) – Name of the IP filter rule. Required.

  • action (str or NetworkRuleIPAction) – IP Filter Action. “Allow”

  • ip_mask (str) – A string that contains the IP address range in CIDR notation for the rule. Required.

Keyword Arguments:

  • filter_name (str) – Name of the IP filter rule. Required.

  • action (str or NetworkRuleIPAction) – IP Filter Action. “Allow”

  • ip_mask (str) – A string that contains the IP address range in CIDR notation for the rule. Required.

class azure.mgmt.iothub.v2023_06_30.models.NetworkRuleSetProperties(*, apply_to_built_in_event_hub_endpoint: bool, ip_rules: List[_models.NetworkRuleSetIpRule], default_action: str | _models.DefaultAction = 'Deny', **kwargs: Any)[source]

Bases: Model

Network Rule Set Properties of IotHub.

All required parameters must be populated in order to send to server.

Variables:

  • default_action (str or DefaultAction) – Default Action for Network Rule Set. Known values are: “Deny” and “Allow”.

  • apply_to_built_in_event_hub_endpoint (bool) – If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub. Required.

  • ip_rules (list[NetworkRuleSetIpRule]) – List of IP Rules. Required.

Keyword Arguments:

  • default_action (str or DefaultAction) – Default Action for Network Rule Set. Known values are: “Deny” and “Allow”.

  • apply_to_built_in_event_hub_endpoint (bool) – If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub. Required.

  • ip_rules (list[NetworkRuleSetIpRule]) – List of IP Rules. Required.

class azure.mgmt.iothub.v2023_06_30.models.Operation(*, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

Bases: Model

IoT Hub REST API operation.

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

Variables:

  • name (str) – Operation name: {provider}/{resource}/{read | write | action | delete}.

  • display (OperationDisplay) – The object that represents the operation.

Keyword Arguments:

display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.iothub.v2023_06_30.models.OperationDisplay(**kwargs: Any)[source]

Bases: Model

The object that represents the operation.

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

Variables:

  • provider (str) – Service provider: Microsoft Devices.

  • resource (str) – Resource Type: IotHubs.

  • operation (str) – Name of the operation.

  • description (str) – Description of the operation.

class azure.mgmt.iothub.v2023_06_30.models.OperationInputs(*, name: str, **kwargs: Any)[source]

Bases: Model

Input values.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The name of the IoT hub to check. Required.

Keyword Arguments:

name (str) – The name of the IoT hub to check. Required.

class azure.mgmt.iothub.v2023_06_30.models.OperationListResult(**kwargs: Any)[source]

Bases: Model

Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.

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

Variables:

  • value (list[Operation]) – List of IoT Hub operations supported by the Microsoft.Devices resource provider.

  • next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.iothub.v2023_06_30.models.PrivateEndpoint(**kwargs: Any)[source]

Bases: Model

The private endpoint property of a private endpoint connection.

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

Variables:

id (str) – The resource identifier.

class azure.mgmt.iothub.v2023_06_30.models.PrivateEndpointConnection(*, properties: _models.PrivateEndpointConnectionProperties, **kwargs: Any)[source]

Bases: Model

The private endpoint connection of an IotHub.

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

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:

properties (PrivateEndpointConnectionProperties) – The properties of a private endpoint connection. Required.

class azure.mgmt.iothub.v2023_06_30.models.PrivateEndpointConnectionProperties(*, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState, private_endpoint: _models.PrivateEndpoint | None = None, **kwargs: Any)[source]

Bases: Model

The properties of a private endpoint connection.

All required parameters must be populated in order to send to server.

Variables:

  • private_endpoint (PrivateEndpoint) – The private endpoint property of a private endpoint connection.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – The current state of a private endpoint connection. Required.

Keyword Arguments:

  • private_endpoint (PrivateEndpoint) – The private endpoint property of a private endpoint connection.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – The current state of a private endpoint connection. Required.

class azure.mgmt.iothub.v2023_06_30.models.PrivateLinkResources(*, value: List[_models.GroupIdInformation] | None = None, **kwargs: Any)[source]

Bases: Model

The available private link resources for an IotHub.

Variables:

value (list[GroupIdInformation]) – The list of available private link resources for an IotHub.

Keyword Arguments:

value (list[GroupIdInformation]) – The list of available private link resources for an IotHub.

class azure.mgmt.iothub.v2023_06_30.models.PrivateLinkServiceConnectionState(*, status: str | _models.PrivateLinkServiceConnectionStatus, description: str, actions_required: str | None = None, **kwargs: Any)[source]

Bases: Model

The current state of a private endpoint connection.

All required parameters must be populated in order to send to server.

Variables:

  • status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • description (str) – The description for the current state of a private endpoint connection. Required.

  • actions_required (str) – Actions required for a private endpoint connection.

Keyword Arguments:

  • status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • description (str) – The description for the current state of a private endpoint connection. Required.

  • actions_required (str) – Actions required for a private endpoint connection.

class azure.mgmt.iothub.v2023_06_30.models.PrivateLinkServiceConnectionStatus(*values)[source]

Bases: str, Enum

The status of a private endpoint connection.

APPROVED = 'Approved'
DISCONNECTED = 'Disconnected'
PENDING = 'Pending'
REJECTED = 'Rejected'
class azure.mgmt.iothub.v2023_06_30.models.PublicNetworkAccess(*values)[source]

Bases: str, Enum

Whether requests from Public Network are allowed.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.iothub.v2023_06_30.models.RegistryStatistics(**kwargs: Any)[source]

Bases: Model

Identity registry statistics.

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

Variables:

  • total_device_count (int) – The total count of devices in the identity registry.

  • enabled_device_count (int) – The count of enabled devices in the identity registry.

  • disabled_device_count (int) – The count of disabled devices in the identity registry.

class azure.mgmt.iothub.v2023_06_30.models.Resource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

The common properties of an Azure resource.

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

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • location (str) – The resource location. Required.

  • tags (dict[str, str]) – The resource tags.

Keyword Arguments:

  • location (str) – The resource location. Required.

  • tags (dict[str, str]) – The resource tags.

class azure.mgmt.iothub.v2023_06_30.models.ResourceIdentityType(*values)[source]

Bases: str, Enum

The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

NONE = 'None'
SYSTEM_ASSIGNED = 'SystemAssigned'
SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'
USER_ASSIGNED = 'UserAssigned'
class azure.mgmt.iothub.v2023_06_30.models.RouteCompilationError(*, message: str | None = None, severity: str | _models.RouteErrorSeverity | None = None, location: _models.RouteErrorRange | None = None, **kwargs: Any)[source]

Bases: Model

Compilation error when evaluating route.

Variables:

  • message (str) – Route error message.

  • severity (str or RouteErrorSeverity) – Severity of the route error. Known values are: “error” and “warning”.

  • location (RouteErrorRange) – Location where the route error happened.

Keyword Arguments:

  • message (str) – Route error message.

  • severity (str or RouteErrorSeverity) – Severity of the route error. Known values are: “error” and “warning”.

  • location (RouteErrorRange) – Location where the route error happened.

class azure.mgmt.iothub.v2023_06_30.models.RouteErrorPosition(*, line: int | None = None, column: int | None = None, **kwargs: Any)[source]

Bases: Model

Position where the route error happened.

Variables:

  • line (int) – Line where the route error happened.

  • column (int) – Column where the route error happened.

Keyword Arguments:

  • line (int) – Line where the route error happened.

  • column (int) – Column where the route error happened.

class azure.mgmt.iothub.v2023_06_30.models.RouteErrorRange(*, start: _models.RouteErrorPosition | None = None, end: _models.RouteErrorPosition | None = None, **kwargs: Any)[source]

Bases: Model

Range of route errors.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.RouteErrorSeverity(*values)[source]

Bases: str, Enum

Severity of the route error.

ERROR = 'error'
WARNING = 'warning'
class azure.mgmt.iothub.v2023_06_30.models.RouteProperties(*, name: str, source: str | _models.RoutingSource, endpoint_names: List[str], is_enabled: bool, condition: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. Required.

  • source (str or RoutingSource) – The source that the routing rule is to be applied to, such as DeviceMessages. Required. Known values are: “Invalid”, “DeviceMessages”, “TwinChangeEvents”, “DeviceLifecycleEvents”, “DeviceJobLifecycleEvents”, and “DeviceConnectionStateEvents”.

  • condition (str) – The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

  • endpoint_names (list[str]) – The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. Required.

  • is_enabled (bool) – Used to specify whether a route is enabled. Required.

Keyword Arguments:

  • name (str) – The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. Required.

  • source (str or RoutingSource) – The source that the routing rule is to be applied to, such as DeviceMessages. Required. Known values are: “Invalid”, “DeviceMessages”, “TwinChangeEvents”, “DeviceLifecycleEvents”, “DeviceJobLifecycleEvents”, and “DeviceConnectionStateEvents”.

  • condition (str) – The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

  • endpoint_names (list[str]) – The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. Required.

  • is_enabled (bool) – Used to specify whether a route is enabled. Required.

class azure.mgmt.iothub.v2023_06_30.models.RoutingCosmosDBSqlApiProperties(*, name: str, endpoint_uri: str, database_name: str, container_name: str, subscription_id: str | None = None, resource_group: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, primary_key: str | None = None, secondary_key: str | None = None, partition_key_name: str | None = None, partition_key_template: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties related to a cosmos DB sql container endpoint.

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

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. Required.

  • id (str) – Id of the cosmos DB sql container endpoint.

  • subscription_id (str) – The subscription identifier of the cosmos DB account.

  • resource_group (str) – The name of the resource group of the cosmos DB account.

  • endpoint_uri (str) – The url of the cosmos DB account. It must include the protocol https://. Required.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the cosmos DB sql container endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing cosmos DB container endpoint.

  • primary_key (str) – The primary key of the cosmos DB account.

  • secondary_key (str) – The secondary key of the cosmos DB account.

  • database_name (str) – The name of the cosmos DB database in the cosmos DB account. Required.

  • container_name (str) – The name of the cosmos DB sql container in the cosmos DB database. Required.

  • partition_key_name (str) – The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.

  • partition_key_template (str) – The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.

Keyword Arguments:

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. Required.

  • subscription_id (str) – The subscription identifier of the cosmos DB account.

  • resource_group (str) – The name of the resource group of the cosmos DB account.

  • endpoint_uri (str) – The url of the cosmos DB account. It must include the protocol https://. Required.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the cosmos DB sql container endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing cosmos DB container endpoint.

  • primary_key (str) – The primary key of the cosmos DB account.

  • secondary_key (str) – The secondary key of the cosmos DB account.

  • database_name (str) – The name of the cosmos DB database in the cosmos DB account. Required.

  • container_name (str) – The name of the cosmos DB sql container in the cosmos DB database. Required.

  • partition_key_name (str) – The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.

  • partition_key_template (str) – The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.

class azure.mgmt.iothub.v2023_06_30.models.RoutingEndpoints(*, service_bus_queues: List[_models.RoutingServiceBusQueueEndpointProperties] | None = None, service_bus_topics: List[_models.RoutingServiceBusTopicEndpointProperties] | None = None, event_hubs: List[_models.RoutingEventHubProperties] | None = None, storage_containers: List[_models.RoutingStorageContainerProperties] | None = None, cosmos_db_sql_containers: List[_models.RoutingCosmosDBSqlApiProperties] | None = None, **kwargs: Any)[source]

Bases: Model

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.RoutingEventHubProperties(*, name: str, id: str | None = None, connection_string: str | None = None, endpoint_uri: str | None = None, entity_path: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, subscription_id: str | None = None, resource_group: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties related to an event hub endpoint.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Id of the event hub endpoint.

  • connection_string (str) – The connection string of the event hub endpoint.

  • endpoint_uri (str) – The url of the event hub endpoint. It must include the protocol sb://.

  • entity_path (str) – Event hub name on the event hub namespace.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the event hub endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing event hub endpoint.

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. Required.

  • subscription_id (str) – The subscription identifier of the event hub endpoint.

  • resource_group (str) – The name of the resource group of the event hub endpoint.

Keyword Arguments:

  • id (str) – Id of the event hub endpoint.

  • connection_string (str) – The connection string of the event hub endpoint.

  • endpoint_uri (str) – The url of the event hub endpoint. It must include the protocol sb://.

  • entity_path (str) – Event hub name on the event hub namespace.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the event hub endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing event hub endpoint.

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. Required.

  • subscription_id (str) – The subscription identifier of the event hub endpoint.

  • resource_group (str) – The name of the resource group of the event hub endpoint.

class azure.mgmt.iothub.v2023_06_30.models.RoutingMessage(*, body: str | None = None, app_properties: Dict[str, str] | None = None, system_properties: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Routing message.

Variables:

  • body (str) – Body of routing message.

  • app_properties (dict[str, str]) – App properties.

  • system_properties (dict[str, str]) – System properties.

Keyword Arguments:

  • body (str) – Body of routing message.

  • app_properties (dict[str, str]) – App properties.

  • system_properties (dict[str, str]) – System properties.

class azure.mgmt.iothub.v2023_06_30.models.RoutingProperties(*, endpoints: _models.RoutingEndpoints | None = None, routes: List[_models.RouteProperties] | None = None, fallback_route: _models.FallbackRouteProperties | None = None, enrichments: List[_models.EnrichmentProperties] | None = None, **kwargs: Any)[source]

Bases: Model

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

Variables:

  • endpoints (RoutingEndpoints) – The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

  • routes (list[RouteProperties]) – The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.

  • fallback_route (FallbackRouteProperties) – The properties of the route that is used as a fall-back route when none of the conditions specified in the ‘routes’ section are met. This is an optional parameter. When this property is not present in the template, the fallback route is disabled by default.

  • enrichments (list[EnrichmentProperties]) – The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid.

Keyword Arguments:

  • endpoints (RoutingEndpoints) – The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

  • routes (list[RouteProperties]) – The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.

  • fallback_route (FallbackRouteProperties) – The properties of the route that is used as a fall-back route when none of the conditions specified in the ‘routes’ section are met. This is an optional parameter. When this property is not present in the template, the fallback route is disabled by default.

  • enrichments (list[EnrichmentProperties]) – The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid.

class azure.mgmt.iothub.v2023_06_30.models.RoutingServiceBusQueueEndpointProperties(*, name: str, id: str | None = None, connection_string: str | None = None, endpoint_uri: str | None = None, entity_path: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, subscription_id: str | None = None, resource_group: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties related to service bus queue endpoint types.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Id of the service bus queue endpoint.

  • connection_string (str) – The connection string of the service bus queue endpoint.

  • endpoint_uri (str) – The url of the service bus queue endpoint. It must include the protocol sb://.

  • entity_path (str) – Queue name on the service bus namespace.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the service bus queue endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing service bus queue endpoint.

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. Required.

  • subscription_id (str) – The subscription identifier of the service bus queue endpoint.

  • resource_group (str) – The name of the resource group of the service bus queue endpoint.

Keyword Arguments:

  • id (str) – Id of the service bus queue endpoint.

  • connection_string (str) – The connection string of the service bus queue endpoint.

  • endpoint_uri (str) – The url of the service bus queue endpoint. It must include the protocol sb://.

  • entity_path (str) – Queue name on the service bus namespace.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the service bus queue endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing service bus queue endpoint.

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. Required.

  • subscription_id (str) – The subscription identifier of the service bus queue endpoint.

  • resource_group (str) – The name of the resource group of the service bus queue endpoint.

class azure.mgmt.iothub.v2023_06_30.models.RoutingServiceBusTopicEndpointProperties(*, name: str, id: str | None = None, connection_string: str | None = None, endpoint_uri: str | None = None, entity_path: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, subscription_id: str | None = None, resource_group: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties related to service bus topic endpoint types.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Id of the service bus topic endpoint.

  • connection_string (str) – The connection string of the service bus topic endpoint.

  • endpoint_uri (str) – The url of the service bus topic endpoint. It must include the protocol sb://.

  • entity_path (str) – Queue name on the service bus topic.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the service bus topic endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing service bus topic endpoint.

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. Required.

  • subscription_id (str) – The subscription identifier of the service bus topic endpoint.

  • resource_group (str) – The name of the resource group of the service bus topic endpoint.

Keyword Arguments:

  • id (str) – Id of the service bus topic endpoint.

  • connection_string (str) – The connection string of the service bus topic endpoint.

  • endpoint_uri (str) – The url of the service bus topic endpoint. It must include the protocol sb://.

  • entity_path (str) – Queue name on the service bus topic.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the service bus topic endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing service bus topic endpoint.

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. Required.

  • subscription_id (str) – The subscription identifier of the service bus topic endpoint.

  • resource_group (str) – The name of the resource group of the service bus topic endpoint.

class azure.mgmt.iothub.v2023_06_30.models.RoutingSource(*values)[source]

Bases: str, Enum

The source that the routing rule is to be applied to, such as DeviceMessages.

DEVICE_CONNECTION_STATE_EVENTS = 'DeviceConnectionStateEvents'
DEVICE_JOB_LIFECYCLE_EVENTS = 'DeviceJobLifecycleEvents'
DEVICE_LIFECYCLE_EVENTS = 'DeviceLifecycleEvents'
DEVICE_MESSAGES = 'DeviceMessages'
INVALID = 'Invalid'
TWIN_CHANGE_EVENTS = 'TwinChangeEvents'
class azure.mgmt.iothub.v2023_06_30.models.RoutingStorageContainerProperties(*, name: str, container_name: str, id: str | None = None, connection_string: str | None = None, endpoint_uri: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, subscription_id: str | None = None, resource_group: str | None = None, file_name_format: str | None = None, batch_frequency_in_seconds: int | None = None, max_chunk_size_in_bytes: int | None = None, encoding: str | _models.RoutingStorageContainerPropertiesEncoding | None = None, **kwargs: Any)[source]

Bases: Model

The properties related to a storage container endpoint.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Id of the storage container endpoint.

  • connection_string (str) – The connection string of the storage account.

  • endpoint_uri (str) – The url of the storage endpoint. It must include the protocol https://.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the storage endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing storage endpoint.

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. Required.

  • subscription_id (str) – The subscription identifier of the storage account.

  • resource_group (str) – The name of the resource group of the storage account.

  • container_name (str) – The name of storage container in the storage account. Required.

  • file_name_format (str) – File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

  • batch_frequency_in_seconds (int) – Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.

  • max_chunk_size_in_bytes (int) – Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).

  • encoding (str or RoutingStorageContainerPropertiesEncoding) – Encoding that is used to serialize messages to blobs. Supported values are ‘avro’, ‘avrodeflate’, and ‘JSON’. Default value is ‘avro’. Known values are: “Avro”, “AvroDeflate”, and “JSON”.

Keyword Arguments:

  • id (str) – Id of the storage container endpoint.

  • connection_string (str) – The connection string of the storage account.

  • endpoint_uri (str) – The url of the storage endpoint. It must include the protocol https://.

  • authentication_type (str or AuthenticationType) – Method used to authenticate against the storage endpoint. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of routing storage endpoint.

  • name (str) – The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. Required.

  • subscription_id (str) – The subscription identifier of the storage account.

  • resource_group (str) – The name of the resource group of the storage account.

  • container_name (str) – The name of storage container in the storage account. Required.

  • file_name_format (str) – File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

  • batch_frequency_in_seconds (int) – Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.

  • max_chunk_size_in_bytes (int) – Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).

  • encoding (str or RoutingStorageContainerPropertiesEncoding) – Encoding that is used to serialize messages to blobs. Supported values are ‘avro’, ‘avrodeflate’, and ‘JSON’. Default value is ‘avro’. Known values are: “Avro”, “AvroDeflate”, and “JSON”.

class azure.mgmt.iothub.v2023_06_30.models.RoutingStorageContainerPropertiesEncoding(*values)[source]

Bases: str, Enum

Encoding that is used to serialize messages to blobs. Supported values are ‘avro’, ‘avrodeflate’, and ‘JSON’. Default value is ‘avro’.

AVRO = 'Avro'
AVRO_DEFLATE = 'AvroDeflate'
JSON = 'JSON'
class azure.mgmt.iothub.v2023_06_30.models.RoutingTwin(*, tags: MutableMapping[str, Any] | None = None, properties: _models.RoutingTwinProperties | None = None, **kwargs: Any)[source]

Bases: Model

Twin reference input parameter. This is an optional parameter.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.RoutingTwinProperties(*, desired: MutableMapping[str, Any] | None = None, reported: MutableMapping[str, Any] | None = None, **kwargs: Any)[source]

Bases: Model

RoutingTwinProperties.

Variables:

  • desired (JSON) – Twin desired properties.

  • reported (JSON) – Twin desired properties.

Keyword Arguments:

  • desired (JSON) – Twin desired properties.

  • reported (JSON) – Twin desired properties.

class azure.mgmt.iothub.v2023_06_30.models.SharedAccessSignatureAuthorizationRule(*, key_name: str, rights: str | _models.AccessRights, primary_key: str | None = None, secondary_key: str | None = None, **kwargs: Any)[source]

Bases: Model

The properties of an IoT hub shared access policy.

All required parameters must be populated in order to send to server.

Variables:

  • key_name (str) – The name of the shared access policy. Required.

  • primary_key (str) – The primary key.

  • secondary_key (str) – The secondary key.

  • rights (str or AccessRights) – The permissions assigned to the shared access policy. Required. Known values are: “RegistryRead”, “RegistryWrite”, “ServiceConnect”, “DeviceConnect”, “RegistryRead, RegistryWrite”, “RegistryRead, ServiceConnect”, “RegistryRead, DeviceConnect”, “RegistryWrite, ServiceConnect”, “RegistryWrite, DeviceConnect”, “ServiceConnect, DeviceConnect”, “RegistryRead, RegistryWrite, ServiceConnect”, “RegistryRead, RegistryWrite, DeviceConnect”, “RegistryRead, ServiceConnect, DeviceConnect”, “RegistryWrite, ServiceConnect, DeviceConnect”, and “RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect”.

Keyword Arguments:

  • key_name (str) – The name of the shared access policy. Required.

  • primary_key (str) – The primary key.

  • secondary_key (str) – The secondary key.

  • rights (str or AccessRights) – The permissions assigned to the shared access policy. Required. Known values are: “RegistryRead”, “RegistryWrite”, “ServiceConnect”, “DeviceConnect”, “RegistryRead, RegistryWrite”, “RegistryRead, ServiceConnect”, “RegistryRead, DeviceConnect”, “RegistryWrite, ServiceConnect”, “RegistryWrite, DeviceConnect”, “ServiceConnect, DeviceConnect”, “RegistryRead, RegistryWrite, ServiceConnect”, “RegistryRead, RegistryWrite, DeviceConnect”, “RegistryRead, ServiceConnect, DeviceConnect”, “RegistryWrite, ServiceConnect, DeviceConnect”, and “RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect”.

class azure.mgmt.iothub.v2023_06_30.models.SharedAccessSignatureAuthorizationRuleListResult(*, value: List[_models.SharedAccessSignatureAuthorizationRule] | None = None, **kwargs: Any)[source]

Bases: Model

The list of shared access policies with a next link.

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

Variables:
Keyword Arguments:

value (list[SharedAccessSignatureAuthorizationRule]) – The list of shared access policies.

class azure.mgmt.iothub.v2023_06_30.models.StorageEndpointProperties(*, connection_string: str, container_name: str, sas_ttl_as_iso8601: timedelta | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, **kwargs: Any)[source]

Bases: Model

The properties of the Azure Storage endpoint for file upload.

All required parameters must be populated in order to send to server.

Variables:

  • sas_ttl_as_iso8601 (timedelta) – The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. # pylint: disable=line-too-long

  • connection_string (str) – The connection string for the Azure Storage account to which files are uploaded. Required.

  • container_name (str) – The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. Required.

  • authentication_type (str or AuthenticationType) – Specifies authentication type being used for connecting to the storage account. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of storage endpoint for file upload.

Keyword Arguments:

  • sas_ttl_as_iso8601 (timedelta) – The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. # pylint: disable=line-too-long

  • connection_string (str) – The connection string for the Azure Storage account to which files are uploaded. Required.

  • container_name (str) – The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. Required.

  • authentication_type (str or AuthenticationType) – Specifies authentication type being used for connecting to the storage account. Known values are: “keyBased” and “identityBased”.

  • identity (ManagedIdentity) – Managed identity properties of storage endpoint for file upload.

class azure.mgmt.iothub.v2023_06_30.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.iothub.v2023_06_30.models.TagsResource(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.

Variables:

tags (dict[str, str]) – Resource tags.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.

class azure.mgmt.iothub.v2023_06_30.models.TestAllRoutesInput(*, routing_source: str | _models.RoutingSource | None = None, message: _models.RoutingMessage | None = None, twin: _models.RoutingTwin | None = None, **kwargs: Any)[source]

Bases: Model

Input for testing all routes.

Variables:

  • routing_source (str or RoutingSource) – Routing source. Known values are: “Invalid”, “DeviceMessages”, “TwinChangeEvents”, “DeviceLifecycleEvents”, “DeviceJobLifecycleEvents”, and “DeviceConnectionStateEvents”.

  • message (RoutingMessage) – Routing message.

  • twin (RoutingTwin) – Routing Twin Reference.

Keyword Arguments:

  • routing_source (str or RoutingSource) – Routing source. Known values are: “Invalid”, “DeviceMessages”, “TwinChangeEvents”, “DeviceLifecycleEvents”, “DeviceJobLifecycleEvents”, and “DeviceConnectionStateEvents”.

  • message (RoutingMessage) – Routing message.

  • twin (RoutingTwin) – Routing Twin Reference.

class azure.mgmt.iothub.v2023_06_30.models.TestAllRoutesResult(*, routes: List[_models.MatchedRoute] | None = None, **kwargs: Any)[source]

Bases: Model

Result of testing all routes.

Variables:

routes (list[MatchedRoute]) – JSON-serialized array of matched routes.

Keyword Arguments:

routes (list[MatchedRoute]) – JSON-serialized array of matched routes.

class azure.mgmt.iothub.v2023_06_30.models.TestResultStatus(*values)[source]

Bases: str, Enum

Result of testing route.

FALSE = 'false'
TRUE = 'true'
UNDEFINED = 'undefined'
class azure.mgmt.iothub.v2023_06_30.models.TestRouteInput(*, route: _models.RouteProperties, message: _models.RoutingMessage | None = None, twin: _models.RoutingTwin | None = None, **kwargs: Any)[source]

Bases: Model

Input for testing route.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.TestRouteResult(*, result: str | _models.TestResultStatus | None = None, details: _models.TestRouteResultDetails | None = None, **kwargs: Any)[source]

Bases: Model

Result of testing one route.

Variables:
Keyword Arguments:
class azure.mgmt.iothub.v2023_06_30.models.TestRouteResultDetails(*, compilation_errors: List[_models.RouteCompilationError] | None = None, **kwargs: Any)[source]

Bases: Model

Detailed result of testing a route.

Variables:

compilation_errors (list[RouteCompilationError]) – JSON-serialized list of route compilation errors.

Keyword Arguments:

compilation_errors (list[RouteCompilationError]) – JSON-serialized list of route compilation errors.

class azure.mgmt.iothub.v2023_06_30.models.UserSubscriptionQuota(*, id: str | None = None, type: str | None = None, unit: str | None = None, current_value: int | None = None, limit: int | None = None, name: _models.Name | None = None, **kwargs: Any)[source]

Bases: Model

User subscription quota response.

Variables:

  • id (str) – IotHub type id.

  • type (str) – Response type.

  • unit (str) – Unit of IotHub type.

  • current_value (int) – Current number of IotHub type.

  • limit (int) – Numerical limit on IotHub type.

  • name (Name) – IotHub type.

Keyword Arguments:

  • id (str) – IotHub type id.

  • type (str) – Response type.

  • unit (str) – Unit of IotHub type.

  • current_value (int) – Current number of IotHub type.

  • limit (int) – Numerical limit on IotHub type.

  • name (Name) – IotHub type.

class azure.mgmt.iothub.v2023_06_30.models.UserSubscriptionQuotaListResult(*, value: List[_models.UserSubscriptionQuota] | None = None, **kwargs: Any)[source]

Bases: Model

Json-serialized array of User subscription quota response.

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

Variables:
Keyword Arguments:

value (list[UserSubscriptionQuota])