Microsoft Azure SDK for Python

This is the Microsoft Azure Communication Management Client Library. This package has been tested with Python 3.10+. For a more complete view of Azure libraries, see the azure sdk python release.

Disclaimer

Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691

Getting started

Prerequisites

• Python 3.10+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-communication
pip install azure-identity

Authentication

By default, Microsoft Entra token authentication depends on correct configuration of the following environment variables.

• AZURE_CLIENT_ID for Azure client ID.
• AZURE_TENANT_ID for Azure tenant ID.
• AZURE_CLIENT_SECRET for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.

With above configuration, client can be authenticated by following code:

from azure.identity import DefaultAzureCredential
from azure.mgmt.communication import CommunicationServiceManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = CommunicationServiceManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

Examples

Code samples for this package can be found at:

• Search Communication Management on docs.microsoft.com
• Azure Python Mgmt SDK Samples Repo

Troubleshooting

Next steps

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.

Release History

3.0.0 (2026-06-24)

Features Added

• Client CommunicationServiceManagementClient added method send_request

Breaking Changes

• This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
• Model CommunicationServiceResource moved instance variable provisioning_state, host_name, data_location, notification_hub_id, version, immutable_resource_id, linked_domains, public_network_access and disable_local_auth under property properties whose type is CommunicationServiceProperties
• Model CommunicationServiceResourceUpdate moved instance variable linked_domains, public_network_access and disable_local_auth under property properties whose type is CommunicationServiceUpdateProperties
• Model DomainResource moved instance variable provisioning_state, data_location, from_sender_domain, mail_from_sender_domain, domain_management, verification_states, verification_records and user_engagement_tracking under property properties whose type is DomainProperties
• Model EmailServiceResource moved instance variable provisioning_state and data_location under property properties whose type is EmailServiceProperties
• Model SenderUsernameResource moved instance variable data_location, username, display_name and provisioning_state under property properties whose type is SenderUsernameProperties
• Model SmtpUsernameResource moved instance variable username, entra_application_id and tenant_id under property properties whose type is SmtpUsernameProperties
• Model SuppressionListAddressResource moved instance variable email, first_name, last_name, notes, last_modified and data_location under property properties whose type is SuppressionListAddressProperties
• Model SuppressionListResource moved instance variable list_name, last_updated_time_stamp, created_time_stamp and data_location under property properties whose type is SuppressionListProperties
• Model UpdateDomainRequestParameters moved instance variable user_engagement_tracking under property properties whose type is UpdateDomainProperties

Other Changes

• Deleted model CommunicationServiceResourceList/DomainResourceList/EmailServiceResourceList/OperationListResult/SenderUsernameResourceCollection/SmtpUsernameResourceCollection/SuppressionListAddressResourceCollection/SuppressionListResourceCollection which actually were not used by SDK users
• Deleted model ErrorDetailAutoGenerated/ErrorResponseAutoGenerated which actually were not used by SDK users

3.0.0b1 (2026-03-10)

Features Added

• Client CommunicationServiceManagementClient added method send_request
• Model CommunicationServiceResource added property properties
• Model CommunicationServiceResourceUpdate added property properties
• Model DomainResource added property properties
• Model EmailServiceResource added property properties
• Model SenderUsernameResource added property properties
• Model SmtpUsernameResource added property properties
• Model SuppressionListAddressResource added property properties
• Model SuppressionListResource added property properties
• Model UpdateDomainRequestParameters added property properties
• Added model CommunicationServiceProperties
• Added model CommunicationServiceUpdateProperties
• Added model DomainProperties
• Added model EmailServiceProperties
• Added model SenderUsernameProperties
• Added model SmtpUsernameProperties
• Added model SuppressionListAddressProperties
• Added model SuppressionListProperties
• Added model UpdateDomainProperties

Breaking Changes

• This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
• For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
• Model CommunicationServiceResource moved instance variable provisioning_state, host_name, data_location, notification_hub_id, version, immutable_resource_id, linked_domains, public_network_access and disable_local_auth under property properties
• Model CommunicationServiceResourceUpdate moved instance variable linked_domains, public_network_access and disable_local_auth under property properties
• Model DomainResource moved instance variable provisioning_state, data_location, from_sender_domain, mail_from_sender_domain, domain_management, verification_states, verification_records and user_engagement_tracking under property properties
• Model EmailServiceResource moved instance variable provisioning_state and data_location under property properties
• Model SenderUsernameResource moved instance variable data_location, username, display_name and provisioning_state under property properties
• Model SmtpUsernameResource moved instance variable username, entra_application_id and tenant_id under property properties
• Model SuppressionListAddressResource moved instance variable email, first_name, last_name, notes, last_modified and data_location under property properties
• Model SuppressionListResource moved instance variable list_name, last_updated_time_stamp, created_time_stamp and data_location under property properties
• Model UpdateDomainRequestParameters deleted or renamed its instance variable user_engagement_tracking

Other Changes

• Deleted model CommunicationServiceResourceList/DomainResourceList/EmailServiceResourceList/SenderUsernameResourceCollection/SmtpUsernameResourceCollection/SuppressionListAddressResourceCollection/SuppressionListResourceCollection which actually were not used by SDK users

2.2.0 (2026-01-19)

Features Added

• Model CommunicationServiceManagementClient added parameter cloud_setting in method __init__
• Client CommunicationServiceManagementClient added operation group smtp_usernames
• Client CommunicationServiceManagementClient added operation group suppression_lists
• Client CommunicationServiceManagementClient added operation group suppression_list_addresses
• Model CommunicationServiceResource added property public_network_access
• Model CommunicationServiceResource added property disable_local_auth
• Model CommunicationServiceResourceUpdate added property public_network_access
• Model CommunicationServiceResourceUpdate added property disable_local_auth
• Added model ErrorDetailAutoGenerated
• Added model ErrorResponseAutoGenerated
• Added enum PublicNetworkAccess
• Added model SmtpUsernameResource
• Added model SmtpUsernameResourceCollection
• Added model SuppressionListAddressResource
• Added model SuppressionListAddressResourceCollection
• Added model SuppressionListResource
• Added model SuppressionListResourceCollection
• Added operation group SmtpUsernamesOperations
• Added operation group SuppressionListAddressesOperations
• Added operation group SuppressionListsOperations

2.1.0 (2024-03-18)

Features Added

• Model CommunicationServiceResource has a new parameter identity
• Model CommunicationServiceResourceUpdate has a new parameter identity

2.1.0b2 (2023-12-18)

Features Added

• Added operation group SuppressionListAddressesOperations
• Added operation group SuppressionListsOperations

2.1.0b1 (2023-09-19)

Features Added

• Model CommunicationServiceResource has a new parameter identity
• Model CommunicationServiceResourceUpdate has a new parameter identity

2.0.0 (2023-04-03)

Features Added

• Added operation group CommunicationServicesOperations
• Added operation group DomainsOperations
• Added operation group EmailServicesOperations
• Added operation group SenderUsernamesOperations
• Model CommunicationServiceResource has a new parameter linked_domains
• Model Resource has a new parameter system_data

Breaking Changes

• Parameter location of model CommunicationServiceResource is now required
• Removed operation group CommunicationServiceOperations
• Removed operation group OperationStatusesOperations

2.0.0b3 (2023-03-23)

Features Added

• Added operation CommunicationServicesOperations.regenerate_key
• Added operation CommunicationServicesOperations.update
• Added operation group SenderUsernamesOperations

Breaking Changes

• Model DomainResource no longer has parameter valid_sender_usernames
• Model UpdateDomainRequestParameters no longer has parameter valid_sender_usernames
• Removed operation CommunicationServicesOperations.begin_regenerate_key
• Removed operation CommunicationServicesOperations.begin_update

2.0.0b2 (2022-11-28)

Other Changes

• Added generated samples in github repo
• Drop support for python<3.7.0

2.0.0b1 (2022-06-07)

Features

• Added operation group CommunicationServicesOperations
• Added operation group DomainsOperations
• Added operation group EmailServicesOperations
• Model CommunicationServiceResource has a new parameter linked_domains
• Model Resource has a new parameter system_data

Breaking changes

• Parameter location of model CommunicationServiceResource is now required
• Removed operation group CommunicationServiceOperations
• Removed operation group OperationStatusesOperations

1.0.0 (2021-03-29)

Features

• Model CommunicationServiceResource has a new parameter system_data
• Model Operation has a new parameter action_type
• Model Operation has a new parameter is_data_action
• Added operation CommunicationServiceOperations.check_name_availability

Breaking changes

• Model Operation no longer has parameter properties

1.0.0b4 (2020-11-16)

• Updated azure-mgmt-communication version.

1.0.0b3 (2020-10-06)

• Updated azure-mgmt-communication version.

1.0.0b2 (2020-09-22)

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 changes

• Credential system has been completly revamped:

  • azure.common.credentials or msrestazure.azure_active_directory instances are no longer supported, use the azure-identity classes instead: https://pypi.org/project/azure-identity/
  • credentials parameter has been renamed credential

• The config attribute 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 the parameters accept in init documentation of azure-core

• You can't import a version module anymore, use __version__ instead

• Operations that used to return a msrest.polling.LROPoller now returns a azure.core.polling.LROPoller and are prefixed with begin_.

• Exceptions tree have been simplified and most exceptions are now azure.core.exceptions.HttpResponseError (CloudError has been removed).

• Most of the operation kwarg have changed. Some of the most noticeable:

  • raw has been removed. Equivalent feature can be found using cls, a callback that will give access to internal HTTP response for advanced user
  • For a complete set of supported options, see the parameters accept in Request documentation of azure-core

General new features

• Type annotations support using typing. SDKs are mypy ready.
• This client has now stable and official support for async. Check the aio namespace of your package to find the async client.
• This client now support natively tracing library like OpenCensus or OpenTelemetry. See this tracing quickstart for an overview.

1.0.0b1 (2020-09-22)

• Initial Release