List Definitions

Article
08/13/2015

The List Definitions operation returns all definitions of a profile.

Request

The List Definitions 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-net.

Method	Request URI
GET	https://management.core.windows.net/<subscription-id>/services/WATM/profiles/<profile-name>/definitions

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

URI Parameters

None.

Request Headers

The following table describes the request headers.

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

Request Body

None.

Response

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

Status Code

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

Response Headers

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	Description
x-ms-request-id	A value that uniquely identifies a request made against the management service.

Response Body

The format of the response body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<Definitions xmlns="https://schemas.microsoft.com/windowsazure">
  <Definition>    
    <DnsOptions>
      <TimeToLiveInSeconds>dns-time-to-live</TimeToLiveInSeconds>
    </DnsOptions>  
    <Status>definition-status</Status>
    <Version>1</Version>
    <Monitors>
      <Monitor>
        <IntervalInSeconds>interval-in-seconds</IntervalInSeconds>
        <TimeoutInSeconds>timeout-in-seconds</TimeoutInSeconds>
        <ToleratedNumberOfFailures>number-of-failures</ToleratedNumberOfFailures>
        <Protocol>monitor-protocol</Protocol>
        <Port>port-number</Port>
        <HttpOptions>
          <Verb>http-verb</Verb>
          <RelativePath>path-relative-to-endpoint</RelativePath>
          <ExpectedStatusCode>expected-status</ExpectedStatusCode>
        </HttpOptions>
      </Monitor>
    </Monitors>
    <Policy>
      <LoadBalancingMethod>load-balancing-method</LoadBalancingMethod>
      <Endpoints>
        <Endpoint>
          <DomainName>domain-name</DomainName>
          <Status>endpoint-status</Status>
          <MonitorStatus>monitor-status</MonitorStatus>
          <Location>endpoint-location</Location>
          <MinChildEndpoints>min-child-endpoints</MinChildEndpoints>
        </Endpoint>
      </Endpoints>
    </Policy>
  </Definition>
</Definitions>

The following table describes the element in the response body.

Element Name	Description
Definitions	Specifies a definition for a profile in the specified subscription.
TimeToLiveInSeconds	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.
Status	Indicates whether this definition is enabled or disabled for the profile. Possible values are: Enabled Disabled
Version	Specifies the version of the definition. This value is always 1.
IntervalInSeconds	Specifies the number of seconds between consecutive attempts to check the status of a monitoring endpoint.
TimeoutInSeconds	Specifies the time to wait for a response from the monitoring endpoint.
ToleratedNumberOfFailures	Specifies the number of consecutive failures to allow on an endpoint before taking the endpoint out of the rotation in the load balancer.
Protocol	Specifies the protocol to use to monitor endpoint health. Possible values are: HTTP HTTPS
Port	Specifies the port used to monitor endpoint health.
Verb	Specifies the verb to use when making an HTTP request to monitor endpoint health.
RelativePath	Specifies the path relative to the endpoint domain name to probe for health state.
ExpectedStatusCode	Specifies the HTTP status code expected from a healthy endpoint. The endpoint is considered unhealthy otherwise.
LoadBalancingMethod	Specifies the load balancing method to use to distribute connections. Possible values are: Performance Failover RoundRobin
Endpoints	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.
DomainName	Specifies the endpoint domain name.
Status	Specifies the status of the 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
MonitorStatus	When defined as part of a policy, indicates the health status for the overall load balancing policy. Possible values are: Online Degraded Inactive Disabled CheckingEndpoints When defined as part of an endpoint, indicates the health status for the endpoint. Possible values are: Online Degraded Inactive Disabled Stopped CheckingEndpoint
Location	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.
MinChildEndpoints	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.

Share via