Share via

Heat Map - Get

Service:
Traffic Manager
API Version:
2022-04-01

Gets latest heatmap for Traffic Manager profile.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/default?api-version=2022-04-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/default?api-version=2022-04-01&topLeft={topLeft}&botRight={botRight}

URI Parameters

Name In Required Type Description
heatMapType
 path True

HeatMapType

The type of the heatmap.
profileName
 path True

string

The name of the Traffic Manager profile.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
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.
botRight
 query

number[]

The bottom right latitude,longitude pair of the rectangular viewport to query for.
topLeft
 query

number[]

The top left latitude,longitude pair of the rectangular viewport to query for.

Responses

Name Type Description
200 OK

HeatMapModel

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

HeatMap-GET
HeatMap-GET-With-Null-Values
HeatMap-GET-With-TopLeft-BotRight

HeatMap-GET

Sample request

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

Sample response

Status code:
200 
{
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation",
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation",
  "properties": {
    "endTime": "2017-08-22T12:50:00Z",
    "endpoints": [
      {
        "endpointId": 1,
        "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"
      },
      {
        "endpointId": 2,
        "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"
      }
    ],
    "startTime": "2017-08-15T12:00:00Z",
    "trafficFlows": [
      {
        "latitude": 99.99,
        "longitude": 0,
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 99.222,
            "queryCount": 1000000
          },
          {
            "endpointId": 2,
            "latency": 1.222,
            "queryCount": 1
          }
        ],
        "sourceIp": "1.1.1.1"
      },
      {
        "latitude": -99.99,
        "longitude": 1,
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 96.222,
            "queryCount": 100
          },
          {
            "endpointId": 2,
            "latency": 4.222,
            "queryCount": 500
          }
        ],
        "sourceIp": "2.255.1.1"
      }
    ]
  }
}

HeatMap-GET-With-Null-Values

Sample request

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

Sample response

Status code:
200 
{
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/default",
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default",
  "properties": {
    "endTime": "2017-08-22T12:50:00Z",
    "endpoints": [
      {
        "endpointId": 0,
        "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"
      },
      {
        "endpointId": 1,
        "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"
      }
    ],
    "startTime": "2017-08-15T12:00:00Z",
    "trafficFlows": [
      {
        "latitude": 99.99,
        "longitude": 0,
        "queryExperiences": [
          {
            "endpointId": 0,
            "latency": 99,
            "queryCount": 1000000
          },
          {
            "endpointId": 1,
            "latency": 1,
            "queryCount": 1
          }
        ],
        "sourceIp": "1.1.1.1"
      },
      {
        "latitude": 1.11,
        "longitude": -2.35,
        "queryExperiences": [
          {
            "endpointId": 0,
            "queryCount": 100
          },
          {
            "endpointId": 1,
            "latency": 4.222,
            "queryCount": 500
          }
        ],
        "sourceIp": "2.255.1.1"
      }
    ]
  }
}

HeatMap-GET-With-TopLeft-BotRight

Sample request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default?api-version=2022-04-01&topLeft=10,50.001&botRight=-50.001,80

Sample response

Status code:
200 
{
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation",
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation",
  "properties": {
    "endTime": "2017-08-22T12:50:00Z",
    "endpoints": [
      {
        "endpointId": 1,
        "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"
      },
      {
        "endpointId": 2,
        "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"
      }
    ],
    "startTime": "2017-08-15T12:00:00Z",
    "trafficFlows": [
      {
        "latitude": 9.99,
        "longitude": 75.01,
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 99.222,
            "queryCount": 1000000
          },
          {
            "endpointId": 2,
            "latency": 1.222,
            "queryCount": 1
          }
        ],
        "sourceIp": "1.1.1.1"
      },
      {
        "latitude": -49.99,
        "longitude": 51,
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 96.222,
            "queryCount": 100
          },
          {
            "endpointId": 2,
            "latency": 4.222,
            "queryCount": 500
          }
        ],
        "sourceIp": "2.255.1.1"
      }
    ]
  }
}

Definitions

Name Description
CloudError

An error returned by the Azure Resource Manager
CloudErrorBody

The content of an error returned by the Azure Resource Manager
HeatMapEndpoint

Class which is a sparse representation of a Traffic Manager endpoint.
HeatMapModel

Class representing a Traffic Manager HeatMap.
HeatMapType

The type of the heatmap.
QueryExperience

Class representing a Traffic Manager HeatMap query experience properties.
TrafficFlow

Class representing a Traffic Manager HeatMap traffic flow properties.

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

HeatMapEndpoint

Object

Class which is a sparse representation of a Traffic Manager endpoint.

Name Type Description
endpointId

integer (int32)

A number uniquely identifying this endpoint in query experiences.
resourceId

string

The ARM Resource ID of this Traffic Manager endpoint.

HeatMapModel

Object

Class representing a Traffic Manager HeatMap.

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.endTime

string (date-time)

The ending of the time window for this HeatMap, exclusive.
properties.endpoints

HeatMapEndpoint[]

The endpoints used in this HeatMap calculation.
properties.startTime

string (date-time)

The beginning of the time window for this HeatMap, inclusive.
properties.trafficFlows

TrafficFlow[]

The traffic flows produced in this HeatMap calculation.
type

string

The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

HeatMapType

Enumeration

The type of the heatmap.

Value Description
default

QueryExperience

Object

Class representing a Traffic Manager HeatMap query experience properties.

Name Type Description
endpointId

integer (int32)

The id of the endpoint from the 'endpoints' array which these queries were routed to.
latency

number (double)

The latency experienced by queries originating from this location.
queryCount

integer (int32)

The number of queries originating from this location.

TrafficFlow

Object

Class representing a Traffic Manager HeatMap traffic flow properties.

Name Type Description
latitude

number (double)

The approximate latitude that these queries originated from.
longitude

number (double)

The approximate longitude that these queries originated from.
queryExperiences

QueryExperience[]

The query experiences produced in this HeatMap calculation.
sourceIp

string

The IP address that this query experience originated from.