Microsoft.Network (preview:2017-09-01)

2025/10/30 • 4 new, 4 deleted methods

HeatMap_Get (new)
Description :  Gets latest heatmap for Traffic Manager profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
heatMapType:
{
Description: The type of HeatMap for the Traffic Manager profile. ,
Required: True ,
}
string ,
topLeft:
{
Description: The top left latitude,longitude pair of the rectangular viewport to query for. ,
Required: False ,
}
array ,
botRight:
{
Description: The bottom right latitude,longitude pair of the rectangular viewport to query for. ,
Required: False ,
}
array ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Traffic Manager HeatMap. ,
Required: False ,
}
{
startTime:
{
Description: The beginning of the time window for this HeatMap, inclusive. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The ending of the time window for this HeatMap, exclusive. ,
Format: date-time ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints used in this HeatMap calculation. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ARM Resource ID of this Traffic Manager endpoint. ,
Required: False ,
}
string ,
endpointId:
{
Description: A number uniquely identifying this endpoint in query experiences. ,
Required: False ,
}
integer ,
}
,
]
,
trafficFlows:
{
Description: The traffic flows produced in this HeatMap calculation. ,
Required: False ,
}
[
{
sourceIp:
{
Description: The IP address that this query experience originated from. ,
Required: False ,
}
string ,
latitude:
{
Description: The approximate latitude that these queries originated from. ,
Format: double ,
Required: False ,
}
number ,
longitude:
{
Description: The approximate longitude that these queries originated from. ,
Format: double ,
Required: False ,
}
number ,
queryExperiences:
{
Description: The query experiences produced in this HeatMap calculation. ,
Required: False ,
}
[
{
endpointId:
{
Description: The id of the endpoint from the 'endpoints' array which these queries were routed to. ,
Required: True ,
}
integer ,
queryCount:
{
Description: The number of queries originating from this location. ,
Required: True ,
}
integer ,
latency:
{
Description: The latency experienced by queries originating from this location. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrafficManagerUserMetricsKeys_Get (new)
Description :  Get the subscription-level key used for Real User Metrics collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. Ex - /providers/Microsoft.Network/trafficManagerUserMetricsKeys ,
Required: False ,
}
string ,
name:
{
Description: The word default. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. Ex- Microsoft.Network/trafficManagerUserMetricsKeys. ,
Required: False ,
}
string ,
key:
{
Description: The key returned by the Real User Metrics operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrafficManagerUserMetricsKeys_CreateOrUpdate (new)
Description :  Create or update a subscription-level key used for Real User Metrics collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Fully qualified resource Id for the resource. Ex - /providers/Microsoft.Network/trafficManagerUserMetricsKeys ,
Required: False ,
}
string ,
name:
{
Description: The word default. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. Ex- Microsoft.Network/trafficManagerUserMetricsKeys. ,
Required: False ,
}
string ,
key:
{
Description: The key returned by the Real User Metrics operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrafficManagerUserMetricsKeys_Delete (new)
Description :  Delete a subscription-level key used for Real User Metrics collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boolean:
{
Description: The result of the operation or request. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
HeatMap_Get (removed)
Description :  Gets latest heatmap for Traffic Manager profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
heatMapType:
{
Description: The type of HeatMap for the Traffic Manager profile. ,
Required: True ,
}
string ,
topLeft:
{
Description: The top left latitude,longitude pair of the rectangular viewport to query for. ,
Required: False ,
}
array ,
botRight:
{
Description: The bottom right latitude,longitude pair of the rectangular viewport to query for. ,
Required: False ,
}
array ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Traffic Manager HeatMap. ,
Required: False ,
}
{
startTime:
{
Description: The beginning of the time window for this HeatMap, inclusive. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The ending of the time window for this HeatMap, exclusive. ,
Format: date-time ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints used in this HeatMap calculation. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ARM Resource ID of this Traffic Manager endpoint. ,
Required: False ,
}
string ,
endpointId:
{
Description: A number uniquely identifying this endpoint in query experiences. ,
Required: False ,
}
integer ,
}
,
]
,
trafficFlows:
{
Description: The traffic flows produced in this HeatMap calculation. ,
Required: False ,
}
[
{
sourceIp:
{
Description: The IP address that this query experience originated from. ,
Required: False ,
}
string ,
latitude:
{
Description: The approximate latitude that these queries originated from. ,
Format: double ,
Required: False ,
}
number ,
longitude:
{
Description: The approximate longitude that these queries originated from. ,
Format: double ,
Required: False ,
}
number ,
queryExperiences:
{
Description: The query experiences produced in this HeatMap calculation. ,
Required: False ,
}
[
{
endpointId:
{
Description: The id of the endpoint from the 'endpoints' array which these queries were routed to. ,
Required: True ,
}
integer ,
queryCount:
{
Description: The number of queries originating from this location. ,
Required: True ,
}
integer ,
latency:
{
Description: The latency experienced by queries originating from this location. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrafficManagerUserMetricsKeys_Get (removed)
Description :  Get the subscription-level key used for Real User Metrics collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. Ex - /providers/Microsoft.Network/trafficManagerUserMetricsKeys ,
Required: False ,
}
string ,
name:
{
Description: The word default. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. Ex- Microsoft.Network/trafficManagerUserMetricsKeys. ,
Required: False ,
}
string ,
key:
{
Description: The key returned by the Real User Metrics operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrafficManagerUserMetricsKeys_CreateOrUpdate (removed)
Description :  Create or update a subscription-level key used for Real User Metrics collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Fully qualified resource Id for the resource. Ex - /providers/Microsoft.Network/trafficManagerUserMetricsKeys ,
Required: False ,
}
string ,
name:
{
Description: The word default. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. Ex- Microsoft.Network/trafficManagerUserMetricsKeys. ,
Required: False ,
}
string ,
key:
{
Description: The key returned by the Real User Metrics operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrafficManagerUserMetricsKeys_Delete (removed)
Description :  Delete a subscription-level key used for Real User Metrics collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boolean:
{
Description: The result of the operation or request. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}