azure.mgmt.trafficmanager.models module

class azure.mgmt.trafficmanager.models.DeleteOperationResult[source]

Bases: msrest.serialization.Model

The result of the request or operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:operation_result (bool) – The result of the operation or request.
class azure.mgmt.trafficmanager.models.Endpoint(target_resource_id=None, target=None, endpoint_status=None, weight=None, priority=None, endpoint_location=None, endpoint_monitor_status=None, min_child_endpoints=None, geo_mapping=None)[source]

Bases: azure.mgmt.trafficmanager.models.proxy_resource.ProxyResource

Class representing a Traffic Manager endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
  • name (str) – The name of the resource
  • type (str) – The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles.
Parameters:
  • target_resource_id (str) – The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’.
  • target (str) – The fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
  • endpoint_status (str or EndpointStatus) – The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values include: ‘Enabled’, ‘Disabled’
  • weight (long) – The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000.
  • priority (long) – The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.
  • endpoint_location (str) – Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method.
  • endpoint_monitor_status (str or EndpointMonitorStatus) – The monitoring status of the endpoint. Possible values include: ‘CheckingEndpoint’, ‘Online’, ‘Degraded’, ‘Disabled’, ‘Inactive’, ‘Stopped’
  • min_child_endpoints (long) – The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’.
  • geo_mapping (list of str) – The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.
class azure.mgmt.trafficmanager.models.CheckTrafficManagerRelativeDnsNameAvailabilityParameters(name=None, type=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to check Traffic Manager name operation.

Parameters:
  • name (str) – The name of the resource.
  • type (str) – The type of the resource.
class azure.mgmt.trafficmanager.models.DnsConfig(relative_name=None, ttl=None)[source]

Bases: msrest.serialization.Model

Class containing DNS settings in a Traffic Manager profile.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters:
  • relative_name (str) – The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.
  • ttl (long) – The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.
Variables:

fqdn (str) – The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.

class azure.mgmt.trafficmanager.models.MonitorConfig(profile_monitor_status=None, protocol=None, port=None, path=None, interval_in_seconds=None, timeout_in_seconds=None, tolerated_number_of_failures=None)[source]

Bases: msrest.serialization.Model

Class containing endpoint monitoring settings in a Traffic Manager profile.

Parameters:
  • profile_monitor_status (str or ProfileMonitorStatus) – The profile-level monitoring status of the Traffic Manager profile. Possible values include: ‘CheckingEndpoints’, ‘Online’, ‘Degraded’, ‘Disabled’, ‘Inactive’
  • protocol (str or MonitorProtocol) – The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. Possible values include: ‘HTTP’, ‘HTTPS’, ‘TCP’
  • port (long) – The TCP port used to probe for endpoint health.
  • path (str) – The path relative to the endpoint domain name used to probe for endpoint health.
  • interval_in_seconds (long) – The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.
  • timeout_in_seconds (long) – The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.
  • tolerated_number_of_failures (long) – The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.
class azure.mgmt.trafficmanager.models.Profile(tags=None, location=None, profile_status=None, traffic_routing_method=None, dns_config=None, monitor_config=None, endpoints=None)[source]

Bases: azure.mgmt.trafficmanager.models.tracked_resource.TrackedResource

Class representing a Traffic Manager profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
  • name (str) – The name of the resource
  • type (str) – The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles.
Parameters:
  • tags (dict) – Resource tags.
  • location (str) – The Azure Region where the resource lives
  • profile_status (str or ProfileStatus) – The status of the Traffic Manager profile. Possible values include: ‘Enabled’, ‘Disabled’
  • traffic_routing_method (str or TrafficRoutingMethod) – The traffic routing method of the Traffic Manager profile. Possible values include: ‘Performance’, ‘Priority’, ‘Weighted’, ‘Geographic’
  • dns_config (DnsConfig) – The DNS settings of the Traffic Manager profile.
  • monitor_config (MonitorConfig) – The endpoint monitoring settings of the Traffic Manager profile.
  • endpoints (list of Endpoint) – The list of endpoints in the Traffic Manager profile.
class azure.mgmt.trafficmanager.models.TrafficManagerNameAvailability(name=None, type=None, name_available=None, reason=None, message=None)[source]

Bases: msrest.serialization.Model

Class representing a Traffic Manager Name Availability response.

Parameters:
  • name (str) – The relative name.
  • type (str) – Traffic Manager profile resource type.
  • name_available (bool) – Describes whether the relative name is available or not.
  • reason (str) – The reason why the name is not available, when applicable.
  • message (str) – Descriptive message that explains why the name is not available, when applicable.
class azure.mgmt.trafficmanager.models.Region(code=None, name=None, regions=None)[source]

Bases: msrest.serialization.Model

Class representing a region in the Geographic hierarchy used with the Geographic traffic routing method.

Parameters:
  • code (str) – The code of the region
  • name (str) – The name of the region
  • regions (list of Region) – The list of Regions grouped under this Region in the Geographic Hierarchy.
class azure.mgmt.trafficmanager.models.TrafficManagerGeographicHierarchy(geographic_hierarchy=None)[source]

Bases: azure.mgmt.trafficmanager.models.proxy_resource.ProxyResource

Class representing the Geographic hierarchy used with the Geographic traffic routing method.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
  • name (str) – The name of the resource
  • type (str) – The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles.
Parameters:

geographic_hierarchy (Region) – The region at the root of the hierarchy from all the regions in the hierarchy can be retrieved.

class azure.mgmt.trafficmanager.models.Resource[source]

Bases: msrest.serialization.Model

The core properties of ARM resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
  • name (str) – The name of the resource
  • type (str) – The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles.
class azure.mgmt.trafficmanager.models.TrackedResource(tags=None, location=None)[source]

Bases: azure.mgmt.trafficmanager.models.resource.Resource

The resource model definition for a ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
  • name (str) – The name of the resource
  • type (str) – The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles.
Parameters:
  • tags (dict) – Resource tags.
  • location (str) – The Azure Region where the resource lives
class azure.mgmt.trafficmanager.models.ProxyResource[source]

Bases: azure.mgmt.trafficmanager.models.resource.Resource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
  • name (str) – The name of the resource
  • type (str) – The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles.
class azure.mgmt.trafficmanager.models.ProfilePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Profile object

class azure.mgmt.trafficmanager.models.EndpointStatus[source]

Bases: enum.Enum

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.trafficmanager.models.EndpointMonitorStatus[source]

Bases: enum.Enum

checking_endpoint = 'CheckingEndpoint'
degraded = 'Degraded'
disabled = 'Disabled'
inactive = 'Inactive'
online = 'Online'
stopped = 'Stopped'
class azure.mgmt.trafficmanager.models.ProfileMonitorStatus[source]

Bases: enum.Enum

checking_endpoints = 'CheckingEndpoints'
degraded = 'Degraded'
disabled = 'Disabled'
inactive = 'Inactive'
online = 'Online'
class azure.mgmt.trafficmanager.models.MonitorProtocol[source]

Bases: enum.Enum

http = 'HTTP'
https = 'HTTPS'
tcp = 'TCP'
class azure.mgmt.trafficmanager.models.ProfileStatus[source]

Bases: enum.Enum

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.trafficmanager.models.TrafficRoutingMethod[source]

Bases: enum.Enum

geographic = 'Geographic'
performance = 'Performance'
priority = 'Priority'
weighted = 'Weighted'