Package: azure-mgmt-eventgrid
Microsoft Azure SDK for PythonThis is the Microsoft Azure Event Grid Management Client Library.
This package has been tested with Python 3.6+.
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/20691UsageTo learn how to use this package, see thequickstart guideFor docs and references, seePython SDK ReferencesCode samples for this package can be found atEvent Grid Managementon docs.microsoft.com.
Additional code samples for different Azure services are available atSamples RepoProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History10.2.0 (2022-06-20)FeaturesAdded operation group ChannelsOperationsAdded operation group DomainEventSubscriptionsOperationsAdded operation group DomainTopicEventSubscriptionsOperationsAdded operation group PartnerConfigurationsOperationsAdded operation group PartnerNamespacesOperationsAdded operation group PartnerRegistrationsOperationsAdded operation group PartnerTopicEventSubscriptionsOperationsAdded operation group PartnerTopicsOperationsAdded operation group TopicEventSubscriptionsOperationsAdded operation group VerifiedPartnersOperationsModel Domain has a new parameter data_residency_boundaryModel DomainUpdateParameters has a new parameter data_residency_boundaryModel Operation has a new parameter is_data_actionModel Topic has a new parameter data_residency_boundaryModel TopicUpdateParameters has a new parameter data_residency_boundary10.2.0b2 (2022-05-30)Breaking changesOperation DomainEventSubscriptionsOperations.list has a new parameter filterOperation DomainEventSubscriptionsOperations.list has a new parameter topOperation DomainTopicEventSubscriptionsOperations.list has a new parameter filterOperation DomainTopicEventSubscriptionsOperations.list has a new parameter topOperation TopicEventSubscriptionsOperations.list has a new parameter filterOperation TopicEventSubscriptionsOperations.list has a new parameter top10.2.0b1 (2022-04-07)FeaturesAdded operation group ChannelsOperationsAdded operation group DomainEventSubscriptionsOperationsAdded operation group DomainTopicEventSubscriptionsOperationsAdded operation group EventChannelsOperationsAdded operation group PartnerConfigurationsOperationsAdded operation group PartnerDestinationsOperationsAdded operation group PartnerNamespacesOperationsAdded operation group PartnerRegistrationsOperationsAdded operation group PartnerTopicEventSubscriptionsOperationsAdded operation group PartnerTopicsOperationsAdded operation group TopicEventSubscriptionsOperationsAdded operation group VerifiedPartnersOperationsModel Domain has a new parameter data_residency_boundaryModel Domain has a new parameter skuModel DomainUpdateParameters has a new parameter data_residency_boundaryModel DomainUpdateParameters has a new parameter skuModel Operation has a new parameter is_data_actionModel Topic has a new parameter data_residency_boundaryModel Topic has a new parameter extended_locationModel Topic has a new parameter kindModel Topic has a new parameter skuModel TopicUpdateParameters has a new parameter data_residency_boundaryModel TopicUpdateParameters has a new parameter sku10.1.0 (2021-12-13)FeaturesAdded model NumberInRangeAdvancedFilterAdded model StringNotContainsAdvancedFilterAdded model NumberNotInRangeAdvancedFilterAdded model IsNullOrUndefinedAdvancedFilterAdded model IsNotNullAdvancedFilterAdded model StringNotBeginsWithAdvancedFilterAdded model StringNotEndsWithAdvancedFilter10.0.0 (2021-10-21)FeaturesModel Domain has a new parameter disable_local_authModel Domain has a new parameter auto_delete_topic_with_last_subscriptionModel Domain has a new parameter auto_create_topic_with_first_subscriptionModel Topic has a new parameter disable_local_authModel DomainUpdateParameters has a new parameter disable_local_authModel DomainUpdateParameters has a new parameter auto_delete_topic_with_last_subscriptionModel DomainUpdateParameters has a new parameter auto_create_topic_with_first_subscriptionModel ExtensionTopic has a new parameter system_dataModel TopicUpdateParameters has a new parameter disable_local_authBreaking changesModel Domain no longer has parameter skuModel Topic no longer has parameter skuModel Topic no longer has parameter extended_locationModel Topic no longer has parameter kindModel DomainUpdateParameters no longer has parameter skuModel TopicUpdateParameters no longer has parameter skuRemoved operation group EventChannelsOperationsRemoved operation group PartnerRegistrationsOperationsRemoved operation group PartnerTopicEventSubscriptionsOperationsRemoved operation group PartnerNamespacesOperationsRemoved operation group PartnerTopicsOperations9.0.0 (2021-05-24)FeaturesModel EventHubEventSubscriptionDestination has a new parameter delivery_attribute_mappingsModel StorageQueueEventSubscriptionDestination has a new parameter queue_message_time_to_live_in_secondsModel TopicTypeInfo has a new parameter supported_scopes_for_sourceModel Topic has a new parameter extended_locationModel Topic has a new parameter kindModel Topic has a new parameter system_dataModel Topic has a new parameter identityModel Topic has a new parameter skuModel EventSubscriptionFilter has a new parameter enable_advanced_filtering_on_arraysModel AzureFunctionEventSubscriptionDestination has a new parameter delivery_attribute_mappingsModel EventSubscriptionUpdateParameters has a new parameter dead_letter_with_resource_identityModel EventSubscriptionUpdateParameters has a new parameter delivery_with_resource_identityModel ServiceBusQueueEventSubscriptionDestination has a new parameter delivery_attribute_mappingsModel DomainTopic has a new parameter system_dataModel DomainUpdateParameters has a new parameter skuModel DomainUpdateParameters has a new parameter identityModel HybridConnectionEventSubscriptionDestination has a new parameter delivery_attribute_mappingsModel TopicUpdateParameters has a new parameter skuModel TopicUpdateParameters has a new parameter identityModel ServiceBusTopicEventSubscriptionDestination has a new parameter delivery_attribute_mappingsModel Domain has a new parameter skuModel Domain has a new parameter system_dataModel Domain has a new parameter identityModel EventSubscription has a new parameter dead_letter_with_resource_identityModel EventSubscription has a new parameter system_dataModel EventSubscription has a new parameter delivery_with_resource_identityModel WebHookEventSubscriptionDestination has a new parameter delivery_attribute_mappingsAdded operation TopicsOperations.begin_regenerate_keyAdded operation EventSubscriptionsOperations.get_delivery_attributesAdded operation group PartnerRegistrationsOperationsAdded operation group SystemTopicsOperationsAdded operation group EventChannelsOperationsAdded operation group PartnerNamespacesOperationsAdded operation group ExtensionTopicsOperationsAdded operation group PartnerTopicsOperationsAdded operation group PartnerTopicEventSubscriptionsOperationsAdded operation group SystemTopicEventSubscriptionsOperationsBreaking changesRemoved operation TopicsOperations.regenerate_key8.0.0 (2020-12-21)Breaking changesOperation TopicsOperations.regenerate_key has a new signatureOperation DomainsOperations.regenerate_key has a new signature8.0.0b1 (2020-10-31)This is beta preview version.
For detailed changelog please refer to equivalent stable version 3.0.0rc8(https://pypi.org/project/azure-mgmt-eventgrid/3.0.0rc8/)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.3.0.0rc8 (2020-06-05)Breaking changesModel EventSubscriptionUpdateParameters no longer has parameter dead_letter_with_resource_identityModel EventSubscriptionUpdateParameters no longer has parameter delivery_with_resource_identityModel DomainUpdateParameters no longer has parameter skuModel DomainUpdateParameters no longer has parameter identityModel Domain no longer has parameter skuModel Domain no longer has parameter identityModel EventSubscription no longer has parameter dead_letter_with_resource_identityModel EventSubscription no longer has parameter delivery_with_resource_identityModel TopicUpdateParameters no longer has parameter skuModel TopicUpdateParameters no longer has parameter identityModel Topic no longer has parameter skuModel Topic no longer has parameter identityRemoved operation group ExtensionTopicsOperationsRemoved operation group PartnerNamespacesOperationsRemoved operation group PartnerRegistrationsOperationsRemoved operation group PartnerTopicsOperationsRemoved operation group SystemTopicEventSubscriptionsOperationsRemoved operation group SystemTopicsOperationsRemoved operation group PartnerTopicEventSubscriptionsOperationsRemoved operation group EventChannelsOperations3.0.0rc7 (2020-05-14)FeaturesModel PartnerTopic has a new parameter expiration_time_if_not_activated_utcModel PartnerTopic has a new parameter partner_topic_friendly_descriptionModel EventChannel has a new parameter partner_topic_readiness_stateModel EventChannel has a new parameter expiration_time_if_not_activated_utcModel EventChannel has a new parameter partner_topic_friendly_descriptionModel PartnerRegistration has a new parameter partner_customer_service_numberModel PartnerRegistration has a new parameter partner_customer_service_extensionModel PartnerRegistration has a new parameter long_descriptionModel PartnerRegistration has a new parameter customer_service_uriBreaking changesModel EventChannelFilter has a new signature3.0.0rc6 (2020-04-03)FeaturesModel PartnerRegistrationUpdateParameters has a new parameter tagsModel EventChannel has a new parameter filterBreaking changesOperation PrivateEndpointConnectionsOperations.update has a new signatureOperation SystemTopicEventSubscriptionsOperations.list_by_system_topic has a new signatureOperation PartnerTopicEventSubscriptionsOperations.list_by_partner_topic has a new signature3.0.0rc5 (2020-03-19)FeaturesModel Domain has a new parameter public_network_accessModel Domain has a new parameter identityModel Domain has a new parameter private_endpoint_connectionsModel Domain has a new parameter skuModel DomainUpdateParameters has a new parameter public_network_accessModel DomainUpdateParameters has a new parameter identityModel DomainUpdateParameters has a new parameter skuModel TopicUpdateParameters has a new parameter public_network_accessModel TopicUpdateParameters has a new parameter identityModel TopicUpdateParameters has a new parameter skuModel EventSubscriptionUpdateParameters has a new parameter dead_letter_with_resource_identityModel EventSubscriptionUpdateParameters has a new parameter delivery_with_resource_identityModel Topic has a new parameter public_network_accessModel Topic has a new parameter identityModel Topic has a new parameter private_endpoint_connectionsModel Topic has a new parameter skuModel EventSubscription has a new parameter dead_letter_with_resource_identityModel EventSubscription has a new parameter delivery_with_resource_identityAdded operation group PrivateLinkResourcesOperationsAdded operation group SystemTopicsOperationsAdded operation group PrivateEndpointConnectionsOperationsAdded operation group PartnerTopicsOperationsAdded operation group PartnerNamespacesOperationsAdded operation group PartnerTopicEventSubscriptionsOperationsAdded operation group PartnerRegistrationsOperationsAdded operation group ExtensionTopicsOperationsAdded operation group SystemTopicEventSubscriptionsOperationsAdded operation group EventChannelsOperationsBreaking changesModel Domain no longer has parameter allow_traffic_from_all_ipsModel DomainUpdateParameters no longer has parameter allow_traffic_from_all_ipsModel TopicUpdateParameters no longer has parameter allow_traffic_from_all_ipsModel Topic no longer has parameter allow_traffic_from_all_ips3.0.0rc4 (2020-01-17)FeaturesModel DomainUpdateParameters has a new parameter
allow_traffic_from_all_ipsModel DomainUpdateParameters has a new parameter inbound_ip_rulesModel TopicUpdateParameters has a new parameter
allow_traffic_from_all_ipsModel TopicUpdateParameters has a new parameter inbound_ip_rulesBreaking changesOperation DomainsOperations.update has a new signatureOperation TopicsOperations.update has a new signature3.0.0rc3 (2020-01-12)FeaturesModel Domain has a new parameter allow_traffic_from_all_ipsModel Domain has a new parameter inbound_ip_rulesModel Topic has a new parameter allow_traffic_from_all_ipsModel Topic has a new parameter inbound_ip_rulesModel TopicTypeInfo has a new parameter source_resource_format3.0.0rc2 (2019-11-11)FeaturesModel WebHookEventSubscriptionDestination has a new parameter
azure_active_directory_tenant_id3.0.0rc1 (2019-10-24)FeaturesModel Domain has a new parameter input_schemaModel Domain has a new parameter input_schema_mappingModel Domain has a new parameter metric_resource_idModel EventSubscription has a new parameter event_delivery_schemaModel Topic has a new parameter input_schemaModel Topic has a new parameter input_schema_mappingModel Topic has a new parameter metric_resource_idModel WebHookEventSubscriptionDestination has a new parameter
preferred_batch_size_in_kilobytesModel WebHookEventSubscriptionDestination has a new parameter
azure_active_directory_application_id_or_uriModel WebHookEventSubscriptionDestination has a new parameter
max_events_per_batchModel EventSubscriptionUpdateParameters has a new parameter
event_delivery_schemaGeneral Breaking ChangesThis version uses a next-generation code generator thatmightintroduce breaking changes. 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.EventGridManagementClient cannot be imported fromazure.mgmt.eventgrid.event_grid_management_clientanymore
(import fromazure.mgmt.eventgridworks like before)EventGridManagementClientConfiguration import has been moved fromazure.mgmt.eventgrid.event_grid_management_clienttoazure.mgmt.eventgridA modelMyClassfrom a "models" sub-module cannot be imported
anymore usingazure.mgmt.eventgrid.models.my_class(import fromazure.mgmt.eventgrid.modelsworks like before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.eventgrid.operations.my_class_operations(import
fromazure.mgmt.eventgrid.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.1.0 (2019-05-22)Not all preview features of the 2.1.0rc1 were confirmed in this 2.1.0
stable version. In particular, the following features will still be
available only in the 2.1.0rc1 for now:Input mapping/Delivery Schema."label" filtering parameter in all operationsAll other features are now considerd stable to use in production. This
includes:Domains, which include all domain related operation including
adding/deleting domain topics manually.Pagination/filteringServicebus queue as destinationAdvanced filtering, which was introduced in previous preview
version.Showing and selecting default event types instead of ‘all’2.1.0rc1 (2019-03-11)DisclaimerPreview features that were on 2.0.0rc2 only and not on 2.0.0 has been
ported in this version.This version also adds the following preview features: - Manual
Add/delete of domain topics. - Pagination/search filtering for list
operations. - Adding service bus queue as destination2.0.0 (2019-02-01)DisclaimerNot all preview features of the 2.0.0rc2 were confirmed in this 2.0.0
stable version. In particular, the following features will still be
available only in the 2.0.0rc2 for now:Domains.Advanced filters support.Event subscription expiration dateInput mapping and event delivery schema.All other features are now considerd stable to use in production. This
includes:Deadletter destination.Storage queue as destination.Hybrid connection as destination.Retry policy.Manual handshake.2.0.0rc2 (2018-10-24)FeaturesModel EventSubscriptionFilter has a new parameter advanced_filtersModel EventSubscriptionUpdateParameters has a new parameter
expiration_time_utcModel EventSubscription has a new parameter expiration_time_utcAdded operation EventSubscriptionsOperations.list_by_domain_topicAdded operation group DomainTopicsOperationsAdded operation group DomainsOperationsInternal API version is 2018-09-15-preview2.0.0rc1 (2018-05-04)Featuresinput mappings for topicsCloudEvents support for topicscustomizable delivery schemasdelivering events to Azure Storage queue and Azure hybrid
connectionsdeadletteringretry policiesmanual subscription validation handshake validation.Internal API version is 2018-05-01-preview1.0.0 (2018-04-26)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 performance0.4.0 (2018-01-16)Breaking changesEventSubscription create is renamed to create_or_update.Regenerated SDK based on 2018-01-01 API version.OperationOrigin enum is removed. Origin of the operation is now a
string.0.3.0 (2017-11-02)FeaturesSupport for updating Topic properties0.2.0 (2017-09-13)Breaking changesUse WebHookEventSubscriptionDestination for webhook endpoint URLs.Regenerated based on 2017-09-15-preview version0.1.1 (2017-08-17)BugfixesFix unexpected exception in some delete call0.1.0 (2017-08-17)Initial Release