azure.mgmt.trafficmanager.operations module — Azure SDK for Python 2.0.0 documentation
Christopher Ramos
Published Feb 16, 2026
- class
azure.mgmt.trafficmanager.operations.EndpointsOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
TrafficManagerManagementClient’sendpointsattribute.create_or_update(resource_group_name: str, profile_name: str, endpoint_type: Union[str,_models.EndpointType], endpoint_name: str, parameters: _models.Endpoint, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Endpoint[source]¶create_or_update(resource_group_name: str, profile_name: str, endpoint_type: Union[str,_models.EndpointType], endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EndpointCreate or update a Traffic Manager endpoint.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
profile_name (str) – The name of the Traffic Manager profile. Required.
endpoint_type (str or EndpointType) – The type of the Traffic Manager endpoint to be created or updated. Known values are: “AzureEndpoints”, “ExternalEndpoints”, and “NestedEndpoints”. Required.
endpoint_name (str) – The name of the Traffic Manager endpoint to be created or updated. Required.
parameters (Endpoint or IO) – The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
Endpoint or the result of cls(response)
- Return type
- Raises
delete(resource_group_name: str, profile_name: str, endpoint_type: Union[str,azure.mgmt.trafficmanager.models._traffic_manager_management_client_enums.EndpointType], endpoint_name: str, **kwargs: Any) → Optional[azure.mgmt.trafficmanager.models._models_py3.DeleteOperationResult][source]¶Deletes a Traffic Manager endpoint.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
profile_name (str) – The name of the Traffic Manager profile. Required.
endpoint_type (str or EndpointType) – The type of the Traffic Manager endpoint to be deleted. Known values are: “AzureEndpoints”, “ExternalEndpoints”, and “NestedEndpoints”. Required.
endpoint_name (str) – The name of the Traffic Manager endpoint to be deleted. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DeleteOperationResult or None or the result of cls(response)
- Return type
- Raises
get(resource_group_name: str, profile_name: str, endpoint_type: Union[str,azure.mgmt.trafficmanager.models._traffic_manager_management_client_enums.EndpointType], endpoint_name: str, **kwargs: Any) → azure.mgmt.trafficmanager.models._models_py3.Endpoint[source]¶Gets a Traffic Manager endpoint.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
profile_name (str) – The name of the Traffic Manager profile. Required.
endpoint_type (str or EndpointType) – The type of the Traffic Manager endpoint. Known values are: “AzureEndpoints”, “ExternalEndpoints”, and “NestedEndpoints”. Required.
endpoint_name (str) – The name of the Traffic Manager endpoint. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Endpoint or the result of cls(response)
- Return type
- Raises
update(resource_group_name: str, profile_name: str, endpoint_type: Union[str,_models.EndpointType], endpoint_name: str, parameters: _models.Endpoint, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Endpoint[source]¶update(resource_group_name: str, profile_name: str, endpoint_type: Union[str,_models.EndpointType], endpoint_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EndpointUpdate a Traffic Manager endpoint.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
profile_name (str) – The name of the Traffic Manager profile. Required.
endpoint_type (str or EndpointType) – The type of the Traffic Manager endpoint to be updated. Known values are: “AzureEndpoints”, “ExternalEndpoints”, and “NestedEndpoints”. Required.
endpoint_name (str) – The name of the Traffic Manager endpoint to be updated. Required.
parameters (Endpoint or IO) – The Traffic Manager endpoint parameters supplied to the Update operation. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
Endpoint or the result of cls(response)
- Return type
- Raises
models= <module 'azure.mgmt.trafficmanager.models' from '/mnt/vss/_work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>¶
- class
azure.mgmt.trafficmanager.operations.GeographicHierarchiesOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
TrafficManagerManagementClient’sgeographic_hierarchiesattribute.get_default(**kwargs: Any) → azure.mgmt.trafficmanager.models._models_py3.TrafficManagerGeographicHierarchy[source]¶Gets the default Geographic Hierarchy used by the Geographic traffic routing method.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
TrafficManagerGeographicHierarchy or the result of cls(response)
- Return type
- Raises
models= <module 'azure.mgmt.trafficmanager.models' from '/mnt/vss/_work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>¶
- class
azure.mgmt.trafficmanager.operations.HeatMapOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
TrafficManagerManagementClient’sheat_mapattribute.get(resource_group_name: str, profile_name: str, top_left: Optional[List[float]] = None, bot_right: Optional[List[float]] = None, **kwargs: Any) → azure.mgmt.trafficmanager.models._models_py3.HeatMapModel[source]¶Gets latest heatmap for Traffic Manager profile.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
profile_name (str) – The name of the Traffic Manager profile. Required.
top_left (list[float]) – The top left latitude,longitude pair of the rectangular viewport to query for. Default value is None.
bot_right (list[float]) – The bottom right latitude,longitude pair of the rectangular viewport to query for. Default value is None.
- Keyword Arguments
- Returns
HeatMapModel or the result of cls(response)
- Return type
- Raises
models= <module 'azure.mgmt.trafficmanager.models' from '/mnt/vss/_work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>¶
- class
azure.mgmt.trafficmanager.operations.ProfilesOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
TrafficManagerManagementClient’sprofilesattribute.check_traffic_manager_relative_dns_name_availability(parameters: _models.CheckTrafficManagerRelativeDnsNameAvailabilityParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TrafficManagerNameAvailability[source]¶check_traffic_manager_relative_dns_name_availability(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TrafficManagerNameAvailabilityChecks the availability of a Traffic Manager Relative DNS name.
- Parameters
parameters (CheckTrafficManagerRelativeDnsNameAvailabilityParameters orIO) – The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
TrafficManagerNameAvailability or the result of cls(response)
- Return type
- Raises
create_or_update(resource_group_name: str, profile_name: str, parameters: _models.Profile, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Profile[source]¶create_or_update(resource_group_name: str, profile_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProfileCreate or update a Traffic Manager profile.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
profile_name (str) – The name of the Traffic Manager profile. Required.
parameters (Profile or IO) – The Traffic Manager profile parameters supplied to the CreateOrUpdate operation. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
Profile or the result of cls(response)
- Return type
- Raises
delete(resource_group_name: str, profile_name: str, **kwargs: Any) → Optional[azure.mgmt.trafficmanager.models._models_py3.DeleteOperationResult][source]¶Deletes a Traffic Manager profile.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DeleteOperationResult or None or the result of cls(response)
- Return type
- Raises
get(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.mgmt.trafficmanager.models._models_py3.Profile[source]¶Gets a Traffic Manager profile.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Profile or the result of cls(response)
- Return type
- Raises
list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.trafficmanager.models._models_py3.Profile][source]¶Lists all Traffic Manager profiles within a resource group.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Profile or the result of cls(response)
- Return type
- Raises
list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.trafficmanager.models._models_py3.Profile][source]¶Lists all Traffic Manager profiles within a subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Profile or the result of cls(response)
- Return type
- Raises
update(resource_group_name: str, profile_name: str, parameters: _models.Profile, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Profile[source]¶update(resource_group_name: str, profile_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProfileUpdate a Traffic Manager profile.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
profile_name (str) – The name of the Traffic Manager profile. Required.
parameters (Profile or IO) – The Traffic Manager profile parameters supplied to the Update operation. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
Profile or the result of cls(response)
- Return type
- Raises
models= <module 'azure.mgmt.trafficmanager.models' from '/mnt/vss/_work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>¶
- class
azure.mgmt.trafficmanager.operations.TrafficManagerUserMetricsKeysOperations(*args, **kwargs)[source]¶ Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
TrafficManagerManagementClient’straffic_manager_user_metrics_keysattribute.create_or_update(**kwargs: Any) → azure.mgmt.trafficmanager.models._models_py3.UserMetricsModel[source]¶Create or update a subscription-level key used for Real User Metrics collection.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
UserMetricsModel or the result of cls(response)
- Return type
- Raises
delete(**kwargs: Any) → azure.mgmt.trafficmanager.models._models_py3.DeleteOperationResult[source]¶Delete a subscription-level key used for Real User Metrics collection.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DeleteOperationResult or the result of cls(response)
- Return type
- Raises
get(**kwargs: Any) → azure.mgmt.trafficmanager.models._models_py3.UserMetricsModel[source]¶Get the subscription-level key used for Real User Metrics collection.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
UserMetricsModel or the result of cls(response)
- Return type
- Raises
models= <module 'azure.mgmt.trafficmanager.models' from '/mnt/vss/_work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>¶