Package: azure-mgmt-iothub
Microsoft Azure SDK for PythonThis is the Microsoft Azure IoT Hub Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.7+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-mgmt-iothub
pipinstallazure-identityAuthenticationBy default,Azure Active Directorytoken authentication depends on correct configure of following environment variables.AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.In addition, Azure subscription ID can be configured via environment variableAZURE_SUBSCRIPTION_ID.With above configuration, client can be authenticated by following code:fromazure.identityimportDefaultAzureCredentialfromazure.mgmt.iothubimportIotHubClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=IotHubClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search IoT Hub Managementon docs.microsoft.comAzure Python Mgmt SDK Samples RepoTroubleshootingNext stepsProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History3.0.0 (2023-09-19)Features AddedModel RoutingEndpoints has a new parameter cosmos_db_sql_containersBreaking ChangesModel RoutingCosmosDBSqlApiProperties has a new required parameter container_nameModel RoutingCosmosDBSqlApiProperties no longer has parameter collection_nameModel RoutingEndpoints no longer has parameter cosmos_db_sql_collections2.4.0 (2023-04-20)Features AddedModel IotHubProperties has a new parameter ip_version2.4.0b1 (2023-02-15)Other ChangesAdded generated samples in github repoDrop support for python<3.7.02.3.0 (2022-09-02)Features AddedModel IotHubProperties has a new parameter device_streamsModel IotHubProperties has a new parameter encryptionModel IotHubProperties has a new parameter root_certificateModel RoutingEndpoints has a new parameter cosmos_db_sql_collections2.2.0 (2022-01-29)FeaturesModel IotHubDescription has a new parameter system_dataModel IotHubProperties has a new parameter enable_data_residency2.1.0 (2021-08-25)FeaturesModel IotHubProperties has a new parameter disable_local_authModel IotHubProperties has a new parameter disable_device_sasModel IotHubProperties has a new parameter restrict_outbound_network_accessModel IotHubProperties has a new parameter allowed_fqdn_listModel IotHubProperties has a new parameter disable_module_sasModel CertificateBodyDescription has a new parameter is_verified2.0.0 (2021-05-14)FeaturesModel EndpointHealthData has a new parameter last_send_attempt_timeModel EndpointHealthData has a new parameter last_known_error_timeModel EndpointHealthData has a new parameter last_known_errorModel EndpointHealthData has a new parameter last_successful_send_attempt_timeModel ImportDevicesRequest has a new parameter identityModel ImportDevicesRequest has a new parameter configurations_blob_nameModel ImportDevicesRequest has a new parameter include_configurationsModel RoutingServiceBusTopicEndpointProperties has a new parameter identityModel RoutingStorageContainerProperties has a new parameter identityModel StorageEndpointProperties has a new parameter identityModel IotHubDescription has a new parameter identityModel IotHubProperties has a new parameter network_rule_setsModel ExportDevicesRequest has a new parameter identityModel ExportDevicesRequest has a new parameter configurations_blob_nameModel ExportDevicesRequest has a new parameter include_configurationsModel RoutingServiceBusQueueEndpointProperties has a new parameter identityModel RoutingEventHubProperties has a new parameter identityBreaking changesOperation IotHubResourceOperations.create_event_hub_consumer_group has a new signature1.0.0 (2020-12-18)GA release1.0.0b1 (2020-11-12)This is beta preview version.This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).General breaking changesCredential system has been completly revamped:azure.common.credentialsormsrestazure.azure_active_directoryinstances are no longer supported, use theazure-identityclasses instead:https://pypi.org/project/azure-identity/credentialsparameter has been renamedcredentialTheconfigattribute no longer exists on a client, configuration should be passed as kwarg. Example:MyClient(credential, subscription_id, enable_logging=True). For a complete set of
supported options, see theparameters accept in init documentation of azure-coreYou can't import aversionmodule anymore, use__version__insteadOperations that used to return amsrest.polling.LROPollernow returns aazure.core.polling.LROPollerand are prefixed withbegin_.Exceptions tree have been simplified and most exceptions are nowazure.core.exceptions.HttpResponseError(CloudErrorhas been removed).Most of the operation kwarg have changed. Some of the most noticeable:rawhas been removed. Equivalent feature can be found usingcls, a callback that will give access to internal HTTP response for advanced userFor a complete set of
supported options, see theparameters accept in Request documentation of azure-coreGeneral new featuresType annotations support usingtyping. SDKs are mypy ready.This client has now stable and official support for async. Check theaionamespace of your package to find the async client.This client now support natively tracing library like OpenCensus or OpenTelemetry. See thistracing quickstartfor an overview.0.12.0 (2020-05-12)FeaturesModel RoutingEventHubProperties has a new parameter entity_pathModel RoutingEventHubProperties has a new parameter authentication_typeModel RoutingEventHubProperties has a new parameter endpoint_uriModel RoutingEventHubProperties has a new parameter idModel RoutingServiceBusQueueEndpointProperties has a new parameter entity_pathModel RoutingServiceBusQueueEndpointProperties has a new parameter authentication_typeModel RoutingServiceBusQueueEndpointProperties has a new parameter endpoint_uriModel RoutingServiceBusQueueEndpointProperties has a new parameter idModel ImportDevicesRequest has a new parameter authentication_typeModel ImportDevicesRequest has a new parameter output_blob_nameModel ImportDevicesRequest has a new parameter input_blob_nameModel ExportDevicesRequest has a new parameter authentication_typeModel ExportDevicesRequest has a new parameter export_blob_nameModel RoutingServiceBusTopicEndpointProperties has a new parameter entity_pathModel RoutingServiceBusTopicEndpointProperties has a new parameter authentication_typeModel RoutingServiceBusTopicEndpointProperties has a new parameter endpoint_uriModel RoutingServiceBusTopicEndpointProperties has a new parameter idModel RoutingStorageContainerProperties has a new parameter authentication_typeModel RoutingStorageContainerProperties has a new parameter endpoint_uriModel RoutingStorageContainerProperties has a new parameter idModel IotHubProperties has a new parameter public_network_accessModel IotHubProperties has a new parameter private_endpoint_connectionsModel IotHubProperties has a new parameter min_tls_versionModel StorageEndpointProperties has a new parameter authentication_typeAdded operation group PrivateEndpointConnectionsOperationsAdded operation group PrivateLinkResourcesOperationsBreaking changesOperation IotHubResourceOperations.export_devices has a new signatureOperation IotHubResourceOperations.import_devices has a new signature0.11.0 (2020-03-17)Preview API versions 2018-12-01-preview, 2019-03-22-preview, 2019-07-01-preview included0.10.0 (2020-01-09)FeaturesSupport for multi-apiBreaking changesModel IotHubProperties no longer has parameter device_streams0.9.0 (2019-10-09)Release 0.9.0 as stable.0.9.0rc1 (2019-09-29)FeaturesModel IotHubProperties has a new parameter locationsGeneral breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes if from some import. In summary, some modules
were incorrectly visible/importable and have been renamed. This fixed
several issues caused by usage of classes that were not supposed to be
used in the first place.IotHubClient cannot be imported fromazure.mgmt.iothub.iot_hub_clientanymore (import fromazure.mgmt.iothubworks like before)IotHubClientConfiguration import has been moved fromazure.mgmt.iothub.iot_hub_clienttoazure.mgmt.iothubA modelMyClassfrom a "models" sub-module cannot be imported
anymore usingazure.mgmt.iothub.models.my_class(import fromazure.mgmt.iothub.modelsworks like before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.iothub.operations.my_class_operations(import fromazure.mgmt.iothub.operationsworks like before)Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one client per process.0.8.2 (2019-05-15)BugfixesFix manual_failover operation type0.8.1 (2019-05-13)BugfixesRe-shipping 0.8.0 with wheel 0.33.4
(https://github.com/pypa/wheel/issues/294)0.8.0 (2019-05-10)FeaturesModel RoutingProperties has a new parameter enrichmentsAdded operation group IotHubOperationsBreaking changesModel IotHubProperties no longer has parameter
operations_monitoring_properties0.7.0 (2018-12-14)FeaturesModel OperationDisplay has a new parameter descriptionModel TestRouteInput has a new parameter twinModel IotHubProperties has a new parameter device_streamsModel TestAllRoutesInput has a new parameter twinBreaking changesOperation IotHubResourceOperations.test_route has a new signatureOperation IotHubResourceOperations.test_all_routes has a new
signature0.6.0 (2018-08-27)FeaturesModel CertificatePropertiesWithNonce has a new parameter certificateModel CertificateProperties has a new parameter certificateAdded operation IotHubResourceOperations.test_all_routesAdded operation IotHubResourceOperations.test_routeAdded operation IotHubResourceOperations.get_endpoint_healthAdded operation group ResourceProviderCommonOperationsClient class can be used as a context manager to keep the underlying
HTTP session open for performance0.5.0 (2018-04-17)General Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes.Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:https://docs.python.org/3/library/enum.html#othersAt a glance:"is" should not be used at all."format" will return the string value, where "%s" string
formatting will returnNameOfEnum.stringvalue. Format syntax
should be prefered.New Long Running Operation:Return type changes frommsrestazure.azure_operation.AzureOperationPollertomsrest.polling.LROPoller. External API is the same.Return type is nowalwaysamsrest.polling.LROPoller,
regardless of the optional parameters used.The behavior has changed when usingraw=True. Instead of
returning the initial call result asClientRawResponse,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as aClientRawResponse.Newpollingparameter. The default behavior isPolling=Truewhich will poll using ARM algorithm. WhenPolling=False, the response of the initial call will be
returned without polling.pollingparameter accepts instances of subclasses ofmsrest.polling.PollingMethod.add_done_callbackwill no longer raise if called after
polling is finished, but will instead execute the callback right
away.BugfixesCompatibility of the sdist with wheel 0.31.0FeaturesAdd new ApiVersion 2018-04-010.4.0 (2017-10-11)FeaturesNew API version 2017-07-01. This is a backward compatible.Add "if_match" parameter when applicableAdd certificates operation groupAdd list available operations methodAdd "storage_containers" attribute to RoutingEndpoints0.3.0 (2017-06-13)FeaturesNew API version 2017-01-19. This is a backward compatible.Adding "routing" information0.2.2 (2017-04-20)BugfixesFix possible deserialization error, but updating from dict<str,
enumtype> to dict<str, str> when applicableNotesThis wheel package is now built with the azure wheel extension0.2.1 (2016-12-16)BugfixesFix #920 - Invalid return type forlist_event_hub_consumer_groups0.2.0 (2016-12-12)BugfixesBetter parameters checking (change exception from CloudError to
TypeError)Date parsing fix (incorrect None date)CreateOrUpdate random exception fix0.1.0 (2016-08-12)Initial Release