Microsoft Azure SDK for Python

This is the Microsoft Azure Traffic Manager 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-trafficmanager
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.trafficmanager import TrafficManagerManagementClient
import os

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

Examples

Code samples for this package can be found at:

• Search Traffic Manager 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

2.0.0 (2026-09-16)

Features Added

• Client TrafficManagerManagementClient added parameter cloud_setting in method __init__
• Client TrafficManagerManagementClient added method send_request
• Model Endpoint added property properties
• Model HeatMapModel added property properties
• Model Profile added property properties
• Model TrafficManagerGeographicHierarchy added property properties
• Model UserMetricsModel added property properties
• Added model CloudError
• Added model EndpointProperties
• Added model GeographicHierarchyProperties
• Added model HeatMapProperties
• Added enum HeatMapType
• Added model ProfileProperties
• Added enum RecordType
• Added model UserMetricsProperties

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 Endpoint moved instance variable always_serve, custom_headers, endpoint_location, endpoint_monitor_status, endpoint_status, geo_mapping, min_child_endpoints, min_child_endpoints_i_pv4, min_child_endpoints_i_pv6, priority, subnets, target, target_resource_id and weight under property properties whose type is EndpointProperties
• Model HeatMapModel moved instance variable end_time, endpoints, start_time and traffic_flows under property properties whose type is HeatMapProperties
• Model Profile moved instance variable allowed_endpoint_record_types, dns_config, endpoints, max_return, monitor_config, profile_status, traffic_routing_method and traffic_view_enrollment_status under property properties whose type is ProfileProperties
• Model TrafficManagerGeographicHierarchy moved instance variable geographic_hierarchy under property properties whose type is GeographicHierarchyProperties
• Model UserMetricsModel moved instance variable key under property properties whose type is UserMetricsProperties
• Deleted or renamed model ProfileListResult
• Parameter heat_map_type of method HeatMapOperations.get is now required
• Method HeatMapOperations.get changed type of its parameter bot_right from List[float] to list[float]
• Method HeatMapOperations.get changed its parameter bot_right from positional_or_keyword to keyword_only
• Method HeatMapOperations.get changed type of its parameter heat_map_type from str to Union[str, HeatMapType]
• Method HeatMapOperations.get changed its parameter heat_map_type from keyword_only to positional_or_keyword
• Method HeatMapOperations.get changed type of its parameter top_left from List[float] to list[float]
• Method HeatMapOperations.get changed its parameter top_left from positional_or_keyword to keyword_only

2.0.0b1 (2026-05-08)

Features Added

• Client TrafficManagerManagementClient added parameter cloud_setting in method __init__
• Client TrafficManagerManagementClient added method send_request
• Added model CloudError
• Added enum HeatMapType
• Added enum RecordType

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 HeatMapModel moved instance variable start_time, end_time, endpoints and traffic_flows under property properties whose type is HeatMapProperties
• Model TrafficManagerGeographicHierarchy moved instance variable geographic_hierarchy under property properties whose type is GeographicHierarchyProperties
• Model UserMetricsModel moved instance variable key under property properties whose type is UserMetricsProperties
• Method HeatMapOperations.get changed its parameter top_left/bot_right from positional_or_keyword to keyword_only
• Method HeatMapOperations.get inserted a positional_or_keyword parameter heat_map_type

1.1.0 (2023-06-16)

Features Added

• Added operation ProfilesOperations.check_traffic_manager_name_availability_v2
• Model Endpoint has a new parameter always_serve

1.1.0b1 (2022-11-17)

Features Added

• Model Endpoint has a new parameter always_serve

1.0.0 (2022-01-19)

Features

• Added model EndpointType

1.0.0b1 (2021-05-13)

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

0.51.0 (2019-01-08)

Features

• Model Endpoint has a new parameter subnets
• Model Profile has a new parameter max_return
• Added operation group TrafficManagerUserMetricsKeysOperations

0.50.0 (2018-05-25)

Features

• Model Endpoint has a new parameter custom_headers
• Model MonitorConfig has a new parameter custom_headers
• Model MonitorConfig has a new parameter expected_status_code_ranges
• Model Profile has a new parameter traffic_view_enrollment_status
• Added operation group HeatMapOperations
• Client class can be used as a context manager to keep the underlying HTTP session open for performance

General Breaking changes

This version uses a next-generation code generator that might introduce 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#others At a glance:
  • "is" should not be used at all.
  • "format" will return the string value, where "%s" string formatting will return NameOfEnum.stringvalue. Format syntax should be prefered.
• New Long Running Operation:
  • Return type changes from msrestazure.azure_operation.AzureOperationPoller to msrest.polling.LROPoller. External API is the same.
  • Return type is now always a msrest.polling.LROPoller, regardless of the optional parameters used.
  • The behavior has changed when using raw=True. Instead of returning the initial call result as ClientRawResponse, without polling, now this returns an LROPoller. After polling, the final resource will be returned as a ClientRawResponse.
  • New polling parameter. The default behavior is Polling=True which will poll using ARM algorithm. When Polling=False, the response of the initial call will be returned without polling.
  • polling parameter accepts instances of subclasses of msrest.polling.PollingMethod.
  • add_done_callback will no longer raise if called after polling is finished, but will instead execute the callback right away.

Bugfixes

• Compatibility of the sdist with wheel 0.31.0

0.40.0 (2017-07-03)

Features

• New MonitorConfig settings
• New Api Version 2017-05-01

Breaking changes

• Rename "list_by_in_resource_group" to "list_by_resource_group"
• Rename "list_all" to "list_by_subscription"

0.30.0 (2017-04-20)

• Initial Release (ApiVersion 2017-03-01)

This wheel package is built with the azure wheel extension