Profiles - List By Subscription

Service:: Traffic Manager

API Version:: 2022-04-01

Lists all Traffic Manager profiles within a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles?api-version=2022-04-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ProfileListResult	Azure operation completed successfully.
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListBySubscription

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Network/trafficmanagerprofiles?api-version=2022-04-01

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "azsmnet5183",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "id": "/subscriptions/{subscription-id}/resourceGroups/azsmnet1719/providers/Microsoft.Network/trafficManagerProfiles/azsmnet5183",
      "location": "global",
      "properties": {
        "dnsConfig": {
          "fqdn": "azsmnet4696.tmpreview.watmtest.azure-test.net",
          "relativeName": "azsmnet4696",
          "ttl": 35
        },
        "endpoints": [],
        "monitorConfig": {
          "path": "/testpath.aspx",
          "intervalInSeconds": 30,
          "port": 80,
          "profileMonitorStatus": "Online",
          "timeoutInSeconds": 10,
          "toleratedNumberOfFailures": 3,
          "protocol": "HTTP"
        },
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance"
      },
      "tags": {}
    },
    {
      "name": "azuresdkfornetautoresttrafficmanager3440",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440",
      "location": "global",
      "properties": {
        "dnsConfig": {
          "fqdn": "azuresdkfornetautoresttrafficmanager3440.tmpreview.watmtest.azure-test.net",
          "relativeName": "azuresdkfornetautoresttrafficmanager3440",
          "ttl": 35
        },
        "endpoints": [
          {
            "name": "My external endpoint",
            "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
            "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440/externalEndpoints/My external endpoint",
            "properties": {
              "endpointLocation": "North Europe",
              "endpointMonitorStatus": "Online",
              "endpointStatus": "Enabled",
              "priority": 1,
              "target": "foobar.contoso.com",
              "weight": 1
            }
          }
        ],
        "monitorConfig": {
          "path": "/testpath.aspx",
          "intervalInSeconds": 30,
          "port": 80,
          "profileMonitorStatus": "Online",
          "timeoutInSeconds": 10,
          "toleratedNumberOfFailures": 3,
          "protocol": "HTTP"
        },
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance"
      },
      "tags": {}
    },
    {
      "name": "onesdk8819",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "id": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819",
      "location": "global",
      "properties": {
        "dnsConfig": {
          "fqdn": "onesdk7242.tmpreview.watmtest.azure-test.net",
          "relativeName": "onesdk7242",
          "ttl": 51
        },
        "endpoints": [
          {
            "name": "MyNestedEndpoint",
            "type": "Microsoft.Network/trafficManagerProfiles/nestedEndpoints",
            "id": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819/nestedEndpoints/MyNestedEndpoint",
            "properties": {
              "endpointLocation": "West Europe",
              "endpointMonitorStatus": "Stopped",
              "endpointStatus": "Enabled",
              "minChildEndpoints": 1,
              "priority": 1,
              "target": "onesdk4285.tmpreview.watmtest.azure-test.net",
              "targetResourceId": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk1792",
              "weight": 1
            }
          }
        ],
        "monitorConfig": {
          "path": "/testparent.asp",
          "intervalInSeconds": 30,
          "port": 111,
          "profileMonitorStatus": "Online",
          "timeoutInSeconds": 10,
          "toleratedNumberOfFailures": 3,
          "protocol": "HTTPS"
        },
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance"
      },
      "tags": {}
    }
  ]
}

Definitions

Name	Description
AllowedEndpointRecordType	The allowed type DNS record types for this profile.
AlwaysServe	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
CloudError	An error returned by the Azure Resource Manager
CloudErrorBody	The content of an error returned by the Azure Resource Manager
DnsConfig	Class containing DNS settings in a Traffic Manager profile.
Endpoint	Class representing a Traffic Manager endpoint.
EndpointMonitorStatus	The monitoring status of the endpoint.
EndpointPropertiesCustomHeadersItem	Custom header name and value.
EndpointPropertiesSubnetsItem	Subnet first address, scope, and/or last address.
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.
MonitorConfig	Class containing endpoint monitoring settings in a Traffic Manager profile.
MonitorConfigCustomHeadersItem	Custom header name and value.
MonitorConfigExpectedStatusCodeRangesItem	Min and max value of a status code range.
MonitorProtocol	The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
Profile	Class representing a Traffic Manager profile.
ProfileListResult	The response of a Profile list operation.
ProfileMonitorStatus	The profile-level monitoring status of the Traffic Manager profile.
ProfileStatus	The status of the Traffic Manager profile.
TrafficRoutingMethod	The traffic routing method of the Traffic Manager profile.
TrafficViewEnrollmentStatus	Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.

AllowedEndpointRecordType

Enumeration

The allowed type DNS record types for this profile.

Value	Description
DomainName
IPv4Address
IPv6Address
Any

AlwaysServe

Enumeration

If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.

Value	Description
Enabled
Disabled

CloudError

Object

An error returned by the Azure Resource Manager

Name	Type	Description
error	CloudErrorBody	The content of the error.

CloudErrorBody

Object

The content of an error returned by the Azure Resource Manager

Name	Type	Description
code	string	Error code
details	CloudErrorBody[]	Error details
message	string	Error message
target	string	Error target

DnsConfig

Object

Class containing DNS settings in a Traffic Manager profile.

Name	Type	Description
fqdn	string	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.
relativeName	string	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	integer (int64)	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.

Endpoint

Object

Class representing a Traffic Manager endpoint.

Name	Type	Description
id	string (arm-id)	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	The name of the resource
properties.alwaysServe	AlwaysServe	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
properties.customHeaders	EndpointPropertiesCustomHeadersItem[]	List of custom headers.
properties.endpointLocation	string	Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
properties.endpointMonitorStatus	EndpointMonitorStatus	The monitoring status of the endpoint.
properties.endpointStatus	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.
properties.geoMapping	string[]	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.
properties.minChildEndpoints	integer (int64)	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'.
properties.minChildEndpointsIPv4	integer (int64)	The minimum number of IPv4 (DNS record type A) 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'.
properties.minChildEndpointsIPv6	integer (int64)	The minimum number of IPv6 (DNS record type AAAA) 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'.
properties.priority	integer (int64)	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.
properties.subnets	EndpointPropertiesSubnetsItem[]	The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.
properties.target	string	The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
properties.targetResourceId	string	The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
properties.weight	integer (int64)	The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Enumeration

The monitoring status of the endpoint.

Value	Description
CheckingEndpoint
Online
Degraded
Disabled
Inactive
Stopped
Unmonitored

EndpointPropertiesCustomHeadersItem

Object

Custom header name and value.

Name	Type	Description
name	string	Header name.
value	string	Header value.

EndpointPropertiesSubnetsItem

Object

Subnet first address, scope, and/or last address.

Name	Type	Description
first	string	First address in the subnet.
last	string	Last address in the subnet.
scope	integer (int32)	Block size (number of leading bits in the subnet mask).

EndpointStatus

Enumeration

The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.

Value	Description
Enabled
Disabled

MonitorConfig

Object

Class containing endpoint monitoring settings in a Traffic Manager profile.

Name	Type	Description
customHeaders	MonitorConfigCustomHeadersItem[]	List of custom headers.
expectedStatusCodeRanges	MonitorConfigExpectedStatusCodeRangesItem[]	List of expected status code ranges.
intervalInSeconds	integer (int64)	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.
path	string	The path relative to the endpoint domain name used to probe for endpoint health.
port	integer (int64)	The TCP port used to probe for endpoint health.
profileMonitorStatus	ProfileMonitorStatus	The profile-level monitoring status of the Traffic Manager profile.
protocol	MonitorProtocol	The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
timeoutInSeconds	integer (int64)	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.
toleratedNumberOfFailures	integer (int64)	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.

MonitorConfigCustomHeadersItem

Object

Custom header name and value.

Name	Type	Description
name	string	Header name.
value	string	Header value.

MonitorConfigExpectedStatusCodeRangesItem

Object

Min and max value of a status code range.

Name	Type	Description
max	integer (int32)	Max status code.
min	integer (int32)	Min status code.

MonitorProtocol

Enumeration

The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.

Value	Description
HTTP
HTTPS
TCP

Profile

Object

Class representing a Traffic Manager profile.

Name	Type	Description
id	string (arm-id)	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
location	string	The Azure Region where the resource lives
name	string	The name of the resource
properties.allowedEndpointRecordTypes	AllowedEndpointRecordType[]	The list of allowed endpoint record types.
properties.dnsConfig	DnsConfig	The DNS settings of the Traffic Manager profile.
properties.endpoints	Endpoint[]	The list of endpoints in the Traffic Manager profile.
properties.maxReturn	integer (int64)	Maximum number of endpoints to be returned for MultiValue routing type.
properties.monitorConfig	MonitorConfig	The endpoint monitoring settings of the Traffic Manager profile.
properties.profileStatus	ProfileStatus	The status of the Traffic Manager profile.
properties.trafficRoutingMethod	TrafficRoutingMethod	The traffic routing method of the Traffic Manager profile.
properties.trafficViewEnrollmentStatus	TrafficViewEnrollmentStatus	Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

ProfileListResult

Object

The response of a Profile list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	Profile[]	The Profile items on this page

ProfileMonitorStatus

Enumeration

The profile-level monitoring status of the Traffic Manager profile.

Value	Description
CheckingEndpoints
Online
Degraded
Disabled
Inactive

ProfileStatus

Enumeration

The status of the Traffic Manager profile.

Value	Description
Enabled
Disabled

TrafficRoutingMethod

Enumeration

The traffic routing method of the Traffic Manager profile.

Value	Description
Performance
Priority
Weighted
Geographic
MultiValue
Subnet

TrafficViewEnrollmentStatus

Enumeration

Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.

Value	Description
Enabled
Disabled

Share via

Profiles - List By Subscription

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ListBySubscription

Sample request

Sample response

Definitions

AllowedEndpointRecordType

AlwaysServe

CloudError

CloudErrorBody

DnsConfig

Endpoint

EndpointMonitorStatus

EndpointPropertiesCustomHeadersItem

EndpointPropertiesSubnetsItem

EndpointStatus

MonitorConfig

MonitorConfigCustomHeadersItem

MonitorConfigExpectedStatusCodeRangesItem

MonitorProtocol

Profile

ProfileListResult

ProfileMonitorStatus

ProfileStatus

TrafficRoutingMethod

TrafficViewEnrollmentStatus