azure.mgmt.trafficmanager.operations module

class azure.mgmt.trafficmanager.operations.EndpointsOperations(client, config, serializer, deserializer)[source]

Bases: object

EndpointsOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-04-01”.

create_or_update(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create or update a Traffic Manager endpoint.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager endpoint to be created or updated.

  • profile_name (str) – The name of the Traffic Manager profile.

  • endpoint_type (str) – The type of the Traffic Manager endpoint to be created or updated.

  • endpoint_name (str) – The name of the Traffic Manager endpoint to be created or updated.

  • parameters (Endpoint) – The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Endpoint or ClientRawResponse if raw=true

Return type

Endpoint or ClientRawResponse

Raises

CloudError

delete(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a Traffic Manager endpoint.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager endpoint to be deleted.

  • profile_name (str) – The name of the Traffic Manager profile.

  • endpoint_type (str) – The type of the Traffic Manager endpoint to be deleted.

  • endpoint_name (str) – The name of the Traffic Manager endpoint to be deleted.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

DeleteOperationResult or ClientRawResponse if raw=true

Return type

DeleteOperationResult or ClientRawResponse

Raises

CloudError

get(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Traffic Manager endpoint.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager endpoint.

  • profile_name (str) – The name of the Traffic Manager profile.

  • endpoint_type (str) – The type of the Traffic Manager endpoint.

  • endpoint_name (str) – The name of the Traffic Manager endpoint.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Endpoint or ClientRawResponse if raw=true

Return type

Endpoint or ClientRawResponse

Raises

CloudError

update(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Update a Traffic Manager endpoint.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager endpoint to be updated.

  • profile_name (str) – The name of the Traffic Manager profile.

  • endpoint_type (str) – The type of the Traffic Manager endpoint to be updated.

  • endpoint_name (str) – The name of the Traffic Manager endpoint to be updated.

  • parameters (Endpoint) – The Traffic Manager endpoint parameters supplied to the Update operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Endpoint or ClientRawResponse if raw=true

Return type

Endpoint or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.trafficmanager.models' from '/home/vsts/work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>
class azure.mgmt.trafficmanager.operations.ProfilesOperations(client, config, serializer, deserializer)[source]

Bases: object

ProfilesOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-04-01”.

check_traffic_manager_relative_dns_name_availability(name=None, type=None, custom_headers=None, raw=False, **operation_config)[source]

Checks the availability of a Traffic Manager Relative DNS name.

Parameters

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

TrafficManagerNameAvailability or ClientRawResponse if raw=true

Return type

TrafficManagerNameAvailability or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, profile_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create or update a Traffic Manager profile.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager profile.

  • profile_name (str) – The name of the Traffic Manager profile.

  • parameters (Profile) – The Traffic Manager profile parameters supplied to the CreateOrUpdate operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Profile or ClientRawResponse if raw=true

Return type

Profile or ClientRawResponse

Raises

CloudError

delete(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a Traffic Manager profile.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager profile to be deleted.

  • profile_name (str) – The name of the Traffic Manager profile to be deleted.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

DeleteOperationResult or ClientRawResponse if raw=true

Return type

DeleteOperationResult or ClientRawResponse

Raises

CloudError

get(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Traffic Manager profile.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager profile.

  • profile_name (str) – The name of the Traffic Manager profile.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Profile or ClientRawResponse if raw=true

Return type

Profile or ClientRawResponse

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all Traffic Manager profiles within a resource group.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager profiles to be listed.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Profile

Return type

ProfilePaged[Profile]

Raises

CloudError

list_by_subscription(custom_headers=None, raw=False, **operation_config)[source]

Lists all Traffic Manager profiles within a subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Profile

Return type

ProfilePaged[Profile]

Raises

CloudError

update(resource_group_name, profile_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Update a Traffic Manager profile.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager profile.

  • profile_name (str) – The name of the Traffic Manager profile.

  • parameters (Profile) – The Traffic Manager profile parameters supplied to the Update operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Profile or ClientRawResponse if raw=true

Return type

Profile or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.trafficmanager.models' from '/home/vsts/work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>
class azure.mgmt.trafficmanager.operations.GeographicHierarchiesOperations(client, config, serializer, deserializer)[source]

Bases: object

GeographicHierarchiesOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-04-01”.

get_default(custom_headers=None, raw=False, **operation_config)[source]

Gets the default Geographic Hierarchy used by the Geographic traffic routing method.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

TrafficManagerGeographicHierarchy or ClientRawResponse if raw=true

Return type

TrafficManagerGeographicHierarchy or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.trafficmanager.models' from '/home/vsts/work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>
class azure.mgmt.trafficmanager.operations.HeatMapOperations(client, config, serializer, deserializer)[source]

Bases: object

HeatMapOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

  • heat_map_type – The type of HeatMap for the Traffic Manager profile. Constant value: “default”.

  • api_version – Client Api Version. Constant value: “2018-04-01”.

get(resource_group_name, profile_name, top_left=None, bot_right=None, custom_headers=None, raw=False, **operation_config)[source]

Gets latest heatmap for Traffic Manager profile.

Parameters

  • resource_group_name (str) – The name of the resource group containing the Traffic Manager endpoint.

  • profile_name (str) – The name of the Traffic Manager profile.

  • top_left (list[float]) – The top left latitude,longitude pair of the rectangular viewport to query for.

  • bot_right (list[float]) – The bottom right latitude,longitude pair of the rectangular viewport to query for.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

HeatMapModel or ClientRawResponse if raw=true

Return type

HeatMapModel or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.trafficmanager.models' from '/home/vsts/work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>
class azure.mgmt.trafficmanager.operations.TrafficManagerUserMetricsKeysOperations(client, config, serializer, deserializer)[source]

Bases: object

TrafficManagerUserMetricsKeysOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-04-01”.

create_or_update(custom_headers=None, raw=False, **operation_config)[source]

Create or update a subscription-level key used for Real User Metrics collection.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

UserMetricsModel or ClientRawResponse if raw=true

Return type

UserMetricsModel or ClientRawResponse

Raises

CloudError

delete(custom_headers=None, raw=False, **operation_config)[source]

Delete a subscription-level key used for Real User Metrics collection.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

DeleteOperationResult or ClientRawResponse if raw=true

Return type

DeleteOperationResult or ClientRawResponse

Raises

CloudError

get(custom_headers=None, raw=False, **operation_config)[source]

Get the subscription-level key used for Real User Metrics collection.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

UserMetricsModel or ClientRawResponse if raw=true

Return type

UserMetricsModel or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.trafficmanager.models' from '/home/vsts/work/1/s/sdk/trafficmanager/azure-mgmt-trafficmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/trafficmanager/models/__init__.py'>