Share via


List Profiles

 

The List Profiles operation returns all profiles owned by a subscription.

Request

The List Profiles request is specified as follows. Replace <subscription-id> with the subscription ID.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/WATM/profiles

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 later. 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:

<Profiles xmlns="https://schemas.microsoft.com/windowsazure">
  <Profile>
    <DomainName>domain-name-for-the-profile</DomainName>
    <Name>profile-name</Name>
    <Status>profile-status</Status>
    <StatusDetails>
      <EnabledVersion>1</EnabledVersion>
    </StatusDetails>
    <Definitions>
      <Definition>
        <Status>definition-status</Status>         
        <Version>1</Version>
      </Definition>
    </Definitions>
</Profile>

The following table describes the element in the response body.

Element Name

Description

Profiles

Specifies a list of all profiles under the specified subscription.

Domain Name

Specifies the domain name, as specified during the creation of the profile.

Name

Specifies the profile name, as specified during the creation of the profile.

Status

Indicates whether a definition of the specified profile is enabled or disabled in Azure Traffic Manager. To set which profile is enabled, use Update Profile.

Possible values are:

  • Enabled

  • Disabled

EnabledVersion

Specifies the version of the policy definition. This value is always 1.

Definitions

Specifies the definition for the specified profile, along with the status. Only one definition version exists for a profile.

See Also

Traffic Manager Overview