SALES: 1-800-867-1380

Get Definition


Updated: July 10, 2015

The Get Definition operation returns an existing profile definition.

The Get Definition request is specified as follows. Replace <subscription-id> with the subscription ID and <profile-name> with the name of the profile. For example myapp-trafficmanager.


Request URI


You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.

The following table describes the request headers.

Request Header



Required. Specifies the version of the operation to use for this request. This header should be set to 2011-10-01 or later. For more information about versioning headers, see Service Management Versioning.

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 200 (OK). For information about status codes, see Service Management Status and Error Codes.

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header



A value that uniquely identifies a request made against the management service.

The format of the response body is as follows:

<Definition xmlns="">

Element Name



Specifies the DNS Time-to-Live (TTL) that informs the Local DNS resolvers how long to cache DNS entries.

The value is an integer from 30 through 999,999.


Indicates whether this definition is enabled or disabled for the profile.

Possible values are:

  • Enabled

  • Disabled


Indicates the version of the definition returned. This value is always 1.


Specifies the number of seconds between consecutive attempts to check the status of a monitoring endpoint.


Specifies the time to wait for a response from the monitoring endpoint.


Specifies the number of consecutive failures to allow on an endpoint before taking the endpoint out of the rotation in the load balancer.


Specifies the protocol to use to monitor endpoint health.

Possible values are:

  • HTTP



Specifies the port used to monitor endpoint health.


Specifies the verb to use when making an HTTP request to monitor endpoint health.


Specifies the path relative to the endpoint domain name to probe for health state.


Specifies the HTTP status code expected from a healthy endpoint. Endpoint is considered unhealthy otherwise.


Specifies the load balancing method to use to distribute connections.

Possible values are:

  • Performance

  • Failover

  • RoundRobin


Encapsulates the list of Azure Traffic Manager endpoints.

If the load balancing method is set to Failover, traffic to the endpoints is load balanced in the sequential order in which the endpoints are returned.


Specifies the endpoint domain name.


Specifies the status of monitoring for the endpoint.

If set to enabled, the endpoint is considered by the load balancing method and is monitored.

Possible values are:

  • Enabled

  • Disabled


When defined as part of a Policy, indicates health status for the overall load balancing policy.

Possible values are:

  • Online

  • Degraded

  • Inactive

  • Disabled

  • CheckingEndpoints

When defined as part of an Endpoint, indicates health status for the endpoint.

Possible values are:

  • Online

  • Degraded

  • Inactive

  • Disabled

  • Stopped

  • CheckingEndpoint


Specifies the location for the TrafficManager and Any endpoint types, but only if they have been set. For the CloudService and AzureWebsite endpoint types, the location cannot be set and is not returned. You can determine the location for these types from the Azure website or Cloud Service.


Specifies the minimum number of healthy endpoints within a nested profile that determines whether any of the endpoints within that profile can receive traffic. Default value is 1.


Specifies the priority of the endpoint in load balancing. The higher the weight, the more frequently the endpoint will be made available to the load balancer. For endpoints that do not specify a weight value, a default weight of 1 will be used.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft