heat_map

Creates, updates, deletes, gets or lists a heat_map resource.

Overview

Name	heat_map
Type	Resource
Id	azure.traffic_manager.heat_map

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}.
name	string	The name of the resource.
endTime	string (date-time)	The ending of the time window for this HeatMap, exclusive.
endpoints	array	The endpoints used in this HeatMap calculation.
startTime	string (date-time)	The beginning of the time window for this HeatMap, inclusive.
trafficFlows	array	The traffic flows produced in this HeatMap calculation.
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, profile_name, heat_map_type, subscription_id	topLeft, botRight	Gets latest heatmap for Traffic Manager profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
heat_map_type	string	The type of the heatmap. "default" Required.
profile_name	string	The name of the Traffic Manager profile. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
botRight	array	The bottom right latitude,longitude pair of the rectangular viewport to query for. Default value is None.
topLeft	array	The top left latitude,longitude pair of the rectangular viewport to query for. Default value is None.

SELECT examples

get

Gets latest heatmap for Traffic Manager profile.

SELECT
id,
name,
endTime,
endpoints,
startTime,
trafficFlows,
type
FROM azure.traffic_manager.heat_map
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND heat_map_type = '{{ heat_map_type }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND topLeft = '{{ topLeft }}'
AND botRight = '{{ botRight }}'
;