Package: azure-mgmt-eventhub
Microsoft Azure SDK for PythonThis is the Microsoft Azure Event 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-eventhub
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.eventhubimportEventHubManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=EventHubManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search Event 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 History11.0.0 (2023-04-14)Features AddedModel Eventhub has a new parameter retention_descriptionBreaking ChangesModel NetworkSecurityPerimeterConfiguration no longer has parameter locationModel NetworkSecurityPerimeterConfiguration no longer has parameter tags11.0.0b1 (2023-02-14)Features AddedModel Eventhub has a new parameter retention_descriptionBreaking ChangesModel NetworkSecurityPerimeterConfiguration no longer has parameter locationModel NetworkSecurityPerimeterConfiguration no longer has parameter tags10.1.0 (2022-06-22)FeaturesAdded operation group ApplicationGroupOperationsAdded operation group NetworkSecurityPerimeterConfigurationOperationsAdded operation group NetworkSecurityPerimeterConfigurationsOperationsModel Cluster has a new parameter supports_scalingModel EHNamespace has a new parameter minimum_tls_versionModel EHNamespace has a new parameter public_network_access10.0.0 (2021-11-01)FeaturesModel ErrorResponse has a new parameter errorModel NetworkRuleSet has a new parameter locationModel Eventhub has a new parameter locationModel ConsumerGroup has a new parameter locationModel ArmDisasterRecovery has a new parameter locationModel Operation has a new parameter is_data_actionModel Operation has a new parameter originModel Operation has a new parameter propertiesModel PrivateEndpointConnection has a new parameter locationModel Destination has a new parameter data_lake_account_nameModel Destination has a new parameter data_lake_subscription_idModel Destination has a new parameter data_lake_folder_pathModel EHNamespace has a new parameter alternate_nameModel OperationDisplay has a new parameter descriptionModel AuthorizationRule has a new parameter locationAdded operation NamespacesOperations.list_network_rule_setAdded operation group SchemaRegistryOperationsBreaking changesModel ErrorResponse no longer has parameter messageModel ErrorResponse no longer has parameter code9.1.0 (2021-09-17)FeaturesModel Cluster has a new parameter system_dataModel EHNamespace has a new parameter disable_local_authModel EHNamespace has a new parameter statusModel NetworkRuleSet has a new parameter public_network_accessAdded operation ClustersOperations.list_by_subscription9.0.0 (2021-05-25)FeaturesModel NetworkRuleSet has a new parameter system_dataModel ConsumerGroup has a new parameter system_dataModel PrivateEndpointConnection has a new parameter system_dataModel EHNamespace has a new parameter system_dataModel EHNamespace has a new parameter private_endpoint_connectionsModel ArmDisasterRecovery has a new parameter system_dataModel Identity has a new parameter user_assigned_identitiesModel Eventhub has a new parameter system_dataModel KeyVaultProperties has a new parameter identityModel AuthorizationRule has a new parameter system_dataModel Encryption has a new parameter require_infrastructure_encryptionBreaking changesRemoved operation NamespacesOperations.list_ip_filter_rulesRemoved operation NamespacesOperations.delete_virtual_network_ruleRemoved operation NamespacesOperations.delete_ip_filter_ruleRemoved operation NamespacesOperations.list_virtual_network_rulesRemoved operation NamespacesOperations.create_or_update_virtual_network_ruleRemoved operation NamespacesOperations.get_virtual_network_ruleRemoved operation NamespacesOperations.create_or_update_ip_filter_ruleRemoved operation NamespacesOperations.get_ip_filter_rule8.0.0 (2020-09-16)FeaturesModel NetworkRuleSet has a new parameter trusted_service_access_enabledAdded operation group PrivateEndpointConnectionsOperationsAdded operation group PrivateLinkResourcesOperations8.0.0b1 (2020-06-17)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.4.0.0 (2020-06-12)FeaturesModel Cluster has a new parameter updated_atModel Cluster has a new parameter created_atAdded operation ClustersOperations.updateAdded operation ClustersOperations.create_or_updateAdded operation ClustersOperations.list_available_cluster_region** Breaking changes**Model Cluster no longer has parameter createdModel Cluster no longer has parameter updatedRemoved operation ClustersOperations.putRemoved operation ClustersOperations.list_available_clustersRemoved operation ClustersOperations.patch3.1.0 (2020-05-13)FeaturesModel EHNamespace has a new parameter encryptionModel EHNamespace has a new parameter identityModel EHNamespace has a new parameter cluster_arm_idAdded operation NamespacesOperations.list_keysAdded operation NamespacesOperations.get_authorization_ruleAdded operation NamespacesOperations.check_name_availabilityAdded operation NamespacesOperations.list_authorization_rulesAdded operation NamespacesOperations.regenerate_keysAdded operation NamespacesOperations.create_or_update_authorization_ruleAdded operation NamespacesOperations.delete_authorization_rule3.0.0 (2019-06-18)General Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes if you were importing from the v20xx_yy_zz
API folders. 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.EventHubManagementClient cannot be imported fromazure.mgmt.eventhub.v20xx_yy_zz.event_hub_management_clientanymore (import fromazure.mgmt.eventhub.v20xx_yy_zzworks
like before)EventHubManagementClientConfiguration import has been moved fromazure.mgmt.eventhub.v20xx_yy_zz.event_hub_management_clienttoazure.mgmt.eventhub.v20xx_yy_zzA modelMyClassfrom a "models" sub-module cannot be imported
anymore usingazure.mgmt.eventhub.v20xx_yy_zz.models.my_class(import fromazure.mgmt.eventhub.v20xx_yy_zz.modelsworks like
before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.eventhub.v20xx_yy_zz.operations.my_class_operations(import fromazure.mgmt.eventhub.v20xx_yy_zz.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.2.6.0 (2019-04-29)Preview featuresAdded operation ClustersOperations.putAdded operation ClustersOperations.list_available_clustersAdded operation ClustersOperations.list_namespacesAdded operation ClustersOperations.deleteBugfixesRemove useless files packaged by mistake
(azure.mgmt.eventhub.operations folder)2.5.0 (2019-04-09)FeaturesAdded operation
NamespacesOperations.create_or_update_network_rule_set for the
2017-04-01 API versionAdded operation NamespacesOperations.get_network_rule_set for the
2017-04-01 API version2.4.0 (2019-03-06)FeaturesMultiApi support for 2015-08-01, 2017-04-01 and 2018-01-01-preview2017-04-01 is the default API version2.3.0 (2019-02-04)FeaturesModel CaptureDescription has a new parameter skip_empty_archives2.2.0 (2018-10-29)FeaturesAdd kafka_enabled attributeNoteazure-mgmt-nspkg is not installed anymore on Python 3 (PEP420-based
namespace package)2.1.0 (2018-07-31)FeaturesAdd pending_replication_operations_count supportBugfixesFix some Python3 models2.0.0 (2018-05-04)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.FeaturesClient class can be used as a context manager to keep the underlying
HTTP session open for performanceAdd region operations groupAdd skip/top to relevant operationsAdd get_messaging_plan operationBugfixesCompatibility of the sdist with wheel 0.31.01.2.0 (2017-12-12)FeaturesAdd alternate_name to some models (GEO DR pairing)Add disaster_recovery_configs.check_name_availabilityAdd disaster_recovery_configs.list_authorization_rulesAdd disaster_recovery_configs.get_authorization_ruleAdd disaster_recovery_configs.list_keysBugfixes"rights" is now required, as expected, for operations called
create_or_update_authorization_ruleFix message_retention_in_days validation ruleFix partition_count validation rule1.1.0 (2017-10-26)FeaturesAdd disaster_recovery_configs operation groupAdd Geo DR1.0.0 (2017-06-27)New API Version 2017-04-01Expect breaking changes, migrating from an unstable clientThis wheel package is built with the azure wheel extension0.2.0 (2016-10-27)Breaking changesCreateOrUpdate has flatten its parameters, moving from one big
Properties object to several small specifics.0.1.0 (2016-10-27)Initial Release