azure.mgmt.trafficmanager.operations module¶

class azure.mgmt.trafficmanager.operations.EndpointsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through TrafficManagerManagementClient’s endpoints attribute.

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

Create 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

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Endpoint or the result of cls(response)

Return type

Endpoint

Raises

HttpResponseError –

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

DeleteOperationResult or None

Raises

HttpResponseError –

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

Endpoint

Raises

HttpResponseError –

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

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

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Endpoint or the result of cls(response)

Return type

Endpoint

Raises

HttpResponseError –

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: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through TrafficManagerManagementClient’s geographic_hierarchies attribute.

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: TrafficManagerGeographicHierarchy
Raises: HttpResponseError –

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: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through TrafficManagerManagementClient’s heat_map attribute.

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

heat_map_type (str) – The type of HeatMap for the Traffic Manager profile. Default value is “default”. Note that overriding this default value may result in unsupported behavior.
cls (callable) – A custom type or function that will be passed the direct response

Returns

HeatMapModel or the result of cls(response)

Return type

HeatMapModel

Raises

HttpResponseError –

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: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through TrafficManagerManagementClient’s profiles attribute.

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

Checks the availability of a Traffic Manager Relative DNS name.

Parameters

parameters (CheckTrafficManagerRelativeDnsNameAvailabilityParameters or IO) – The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

TrafficManagerNameAvailability or the result of cls(response)

Return type

TrafficManagerNameAvailability

Raises

HttpResponseError –

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

Create 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

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Profile or the result of cls(response)

Return type

Profile

Raises

HttpResponseError –

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

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

DeleteOperationResult or None

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.mgmt.trafficmanager.models._models_py3.Profile[source]¶

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

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

Profile

Raises

HttpResponseError –

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: ItemPaged[Profile]
Raises: HttpResponseError –

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: ItemPaged[Profile]
Raises: HttpResponseError –

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

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 Update operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Profile or the result of cls(response)

Return type

Profile

Raises

HttpResponseError –

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: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through TrafficManagerManagementClient’s traffic_manager_user_metrics_keys attribute.

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: UserMetricsModel
Raises: HttpResponseError –

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: DeleteOperationResult
Raises: HttpResponseError –

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: UserMetricsModel
Raises: HttpResponseError –

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'>¶