Heat Map - Get

サービス:

Traffic Manager

API バージョン:

2022-04-01

Traffic Manager プロファイルの最新のヒートマップを取得します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
heatMapType	path	True	HeatMapType	Traffic Manager プロファイルの HeatMap の種類。
profileName	path	True	string	Traffic Manager プロファイルの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。
botRight	query		number[]	クエリを実行する四角形ビューポートの右下の緯度、経度のペア。
topLeft	query		number[]	クエリを実行する四角形ビューポートの左上の緯度、経度のペア。

応答

名前	型	説明
200 OK	HeatMapModel	Traffic Manager ヒートマップ。
Other Status Codes	CloudError	既定の応答。 エラー定義に従って逆シリアル化されます。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

HeatMap-GET

HeatMap-GET-With-Null-Values

HeatMap-GET-With-TopLeft-BotRight

HeatMap-GET

要求のサンプル

HTTP

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

Java

/**
 * Samples for HeatMap Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET.json
     */
    /**
     * Sample code: HeatMap-GET.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void heatMapGET(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.trafficManagerProfiles().manager().serviceClient().getHeatMaps().getWithResponse(
            "azuresdkfornetautoresttrafficmanager1323", "azuresdkfornetautoresttrafficmanager3880", null, null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-trafficmanager
# USAGE
    python heat_map_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = TrafficManagerManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.heat_map.get(
        resource_group_name="azuresdkfornetautoresttrafficmanager1323",
        profile_name="azuresdkfornetautoresttrafficmanager3880",
    )
    print(response)


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armtrafficmanager_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/trafficmanager/armtrafficmanager"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0d41e635294dce73dfa99b07f3da4b68a9c9e29c/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET.json
func ExampleHeatMapClient_Get_heatMapGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtrafficmanager.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewHeatMapClient().Get(ctx, "azuresdkfornetautoresttrafficmanager1323", "azuresdkfornetautoresttrafficmanager3880", &armtrafficmanager.HeatMapClientGetOptions{TopLeft: []float64{},
		BotRight: []float64{},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.HeatMapModel = armtrafficmanager.HeatMapModel{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation"),
	// 	Properties: &armtrafficmanager.HeatMapProperties{
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-22T12:50:00.000Z"); return t}()),
	// 		Endpoints: []*armtrafficmanager.HeatMapEndpoint{
	// 			{
	// 				EndpointID: to.Ptr[int32](1),
	// 				ResourceID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"),
	// 			},
	// 			{
	// 				EndpointID: to.Ptr[int32](2),
	// 				ResourceID: to.Ptr("/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"),
	// 		}},
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-15T12:00:00.000Z"); return t}()),
	// 		TrafficFlows: []*armtrafficmanager.TrafficFlow{
	// 			{
	// 				Latitude: to.Ptr[float64](99.99),
	// 				Longitude: to.Ptr[float64](0),
	// 				QueryExperiences: []*armtrafficmanager.QueryExperience{
	// 					{
	// 						EndpointID: to.Ptr[int32](1),
	// 						Latency: to.Ptr[float64](99.222),
	// 						QueryCount: to.Ptr[int32](1000000),
	// 					},
	// 					{
	// 						EndpointID: to.Ptr[int32](2),
	// 						Latency: to.Ptr[float64](1.222),
	// 						QueryCount: to.Ptr[int32](1),
	// 				}},
	// 				SourceIP: to.Ptr("1.1.1.1"),
	// 			},
	// 			{
	// 				Latitude: to.Ptr[float64](-99.99),
	// 				Longitude: to.Ptr[float64](1),
	// 				QueryExperiences: []*armtrafficmanager.QueryExperience{
	// 					{
	// 						EndpointID: to.Ptr[int32](1),
	// 						Latency: to.Ptr[float64](96.222),
	// 						QueryCount: to.Ptr[int32](100),
	// 					},
	// 					{
	// 						EndpointID: to.Ptr[int32](2),
	// 						Latency: to.Ptr[float64](4.222),
	// 						QueryCount: to.Ptr[int32](500),
	// 				}},
	// 				SourceIP: to.Ptr("2.255.1.1"),
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets latest heatmap for Traffic Manager profile.
 *
 * @summary Gets latest heatmap for Traffic Manager profile.
 * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET.json
 */
async function heatMapGet() {
  const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName =
    process.env["TRAFFICMANAGER_RESOURCE_GROUP"] || "azuresdkfornetautoresttrafficmanager1323";
  const profileName = "azuresdkfornetautoresttrafficmanager3880";
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.heatMap.get(resourceGroupName, profileName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.TrafficManager.Models;
using Azure.ResourceManager.TrafficManager;

// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET.json
// this example is just showing the usage of "HeatMap_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this TrafficManagerHeatMapResource created on azure
// for more information of creating TrafficManagerHeatMapResource, please refer to the document of TrafficManagerHeatMapResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager1323";
string profileName = "azuresdkfornetautoresttrafficmanager3880";
TrafficManagerHeatMapType heatMapType = TrafficManagerHeatMapType.Default;
ResourceIdentifier trafficManagerHeatMapResourceId = TrafficManagerHeatMapResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, heatMapType);
TrafficManagerHeatMapResource trafficManagerHeatMap = client.GetTrafficManagerHeatMapResource(trafficManagerHeatMapResourceId);

// invoke the operation
TrafficManagerHeatMapResource result = await trafficManagerHeatMap.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
TrafficManagerHeatMapData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation",
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation",
  "properties": {
    "startTime": "2017-08-15T12:00:00Z",
    "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"
      }
    ],
    "trafficFlows": [
      {
        "latitude": 99.99,
        "longitude": 0,
        "sourceIp": "1.1.1.1",
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 99.222,
            "queryCount": 1000000
          },
          {
            "endpointId": 2,
            "latency": 1.222,
            "queryCount": 1
          }
        ]
      },
      {
        "latitude": -99.99,
        "longitude": 1,
        "sourceIp": "2.255.1.1",
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 96.222,
            "queryCount": 100
          },
          {
            "endpointId": 2,
            "latency": 4.222,
            "queryCount": 500
          }
        ]
      }
    ]
  }
}

HeatMap-GET-With-Null-Values

要求のサンプル

HTTP

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

Java

/**
 * Samples for HeatMap Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-Null-
     * Values.json
     */
    /**
     * Sample code: HeatMap-GET-With-Null-Values.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void heatMapGETWithNullValues(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.trafficManagerProfiles().manager().serviceClient().getHeatMaps().getWithResponse(
            "azuresdkfornetautoresttrafficmanager1323", "azuresdkfornetautoresttrafficmanager3880", null, null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-trafficmanager
# USAGE
    python heat_map_get_with_null_values.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = TrafficManagerManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.heat_map.get(
        resource_group_name="azuresdkfornetautoresttrafficmanager1323",
        profile_name="azuresdkfornetautoresttrafficmanager3880",
    )
    print(response)


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-Null-Values.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armtrafficmanager_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/trafficmanager/armtrafficmanager"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0d41e635294dce73dfa99b07f3da4b68a9c9e29c/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-Null-Values.json
func ExampleHeatMapClient_Get_heatMapGetWithNullValues() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtrafficmanager.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewHeatMapClient().Get(ctx, "azuresdkfornetautoresttrafficmanager1323", "azuresdkfornetautoresttrafficmanager3880", &armtrafficmanager.HeatMapClientGetOptions{TopLeft: []float64{},
		BotRight: []float64{},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.HeatMapModel = armtrafficmanager.HeatMapModel{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Network/trafficManagerProfiles/heatMaps/default"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default"),
	// 	Properties: &armtrafficmanager.HeatMapProperties{
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-22T12:50:00.000Z"); return t}()),
	// 		Endpoints: []*armtrafficmanager.HeatMapEndpoint{
	// 			{
	// 				EndpointID: to.Ptr[int32](0),
	// 				ResourceID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"),
	// 			},
	// 			{
	// 				EndpointID: to.Ptr[int32](1),
	// 				ResourceID: to.Ptr("/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"),
	// 		}},
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-15T12:00:00.000Z"); return t}()),
	// 		TrafficFlows: []*armtrafficmanager.TrafficFlow{
	// 			{
	// 				Latitude: to.Ptr[float64](99.99),
	// 				Longitude: to.Ptr[float64](0),
	// 				QueryExperiences: []*armtrafficmanager.QueryExperience{
	// 					{
	// 						EndpointID: to.Ptr[int32](0),
	// 						Latency: to.Ptr[float64](99),
	// 						QueryCount: to.Ptr[int32](1000000),
	// 					},
	// 					{
	// 						EndpointID: to.Ptr[int32](1),
	// 						Latency: to.Ptr[float64](1),
	// 						QueryCount: to.Ptr[int32](1),
	// 				}},
	// 				SourceIP: to.Ptr("1.1.1.1"),
	// 			},
	// 			{
	// 				Latitude: to.Ptr[float64](1.11),
	// 				Longitude: to.Ptr[float64](-2.35),
	// 				QueryExperiences: []*armtrafficmanager.QueryExperience{
	// 					{
	// 						EndpointID: to.Ptr[int32](0),
	// 						QueryCount: to.Ptr[int32](100),
	// 					},
	// 					{
	// 						EndpointID: to.Ptr[int32](1),
	// 						Latency: to.Ptr[float64](4.222),
	// 						QueryCount: to.Ptr[int32](500),
	// 				}},
	// 				SourceIP: to.Ptr("2.255.1.1"),
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets latest heatmap for Traffic Manager profile.
 *
 * @summary Gets latest heatmap for Traffic Manager profile.
 * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-Null-Values.json
 */
async function heatMapGetWithNullValues() {
  const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName =
    process.env["TRAFFICMANAGER_RESOURCE_GROUP"] || "azuresdkfornetautoresttrafficmanager1323";
  const profileName = "azuresdkfornetautoresttrafficmanager3880";
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.heatMap.get(resourceGroupName, profileName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.TrafficManager.Models;
using Azure.ResourceManager.TrafficManager;

// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-Null-Values.json
// this example is just showing the usage of "HeatMap_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this TrafficManagerHeatMapResource created on azure
// for more information of creating TrafficManagerHeatMapResource, please refer to the document of TrafficManagerHeatMapResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager1323";
string profileName = "azuresdkfornetautoresttrafficmanager3880";
TrafficManagerHeatMapType heatMapType = TrafficManagerHeatMapType.Default;
ResourceIdentifier trafficManagerHeatMapResourceId = TrafficManagerHeatMapResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, heatMapType);
TrafficManagerHeatMapResource trafficManagerHeatMap = client.GetTrafficManagerHeatMapResource(trafficManagerHeatMapResourceId);

// invoke the operation
TrafficManagerHeatMapResource result = await trafficManagerHeatMap.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
TrafficManagerHeatMapData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default",
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/default",
  "properties": {
    "startTime": "2017-08-15T12:00:00Z",
    "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"
      }
    ],
    "trafficFlows": [
      {
        "latitude": 99.99,
        "longitude": 0,
        "sourceIp": "1.1.1.1",
        "queryExperiences": [
          {
            "endpointId": 0,
            "latency": 99,
            "queryCount": 1000000
          },
          {
            "endpointId": 1,
            "latency": 1,
            "queryCount": 1
          }
        ]
      },
      {
        "latitude": 1.11,
        "longitude": -2.35,
        "sourceIp": "2.255.1.1",
        "queryExperiences": [
          {
            "endpointId": 0,
            "queryCount": 100
          },
          {
            "endpointId": 1,
            "latency": 4.222,
            "queryCount": 500
          }
        ]
      }
    ]
  }
}

HeatMap-GET-With-TopLeft-BotRight

要求のサンプル

HTTP

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

Java

import java.util.Arrays;

/**
 * Samples for HeatMap Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-
     * TopLeft-BotRight.json
     */
    /**
     * Sample code: HeatMap-GET-With-TopLeft-BotRight.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void heatMapGETWithTopLeftBotRight(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.trafficManagerProfiles().manager().serviceClient().getHeatMaps().getWithResponse(
            "azuresdkfornetautoresttrafficmanager1323", "azuresdkfornetautoresttrafficmanager3880",
            Arrays.asList(10.0, 50.001), Arrays.asList(-50.001, 80.0), com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-trafficmanager
# USAGE
    python heat_map_get_with_top_left_bot_right.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = TrafficManagerManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.heat_map.get(
        resource_group_name="azuresdkfornetautoresttrafficmanager1323",
        profile_name="azuresdkfornetautoresttrafficmanager3880",
    )
    print(response)


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-TopLeft-BotRight.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armtrafficmanager_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/trafficmanager/armtrafficmanager"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0d41e635294dce73dfa99b07f3da4b68a9c9e29c/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-TopLeft-BotRight.json
func ExampleHeatMapClient_Get_heatMapGetWithTopLeftBotRight() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtrafficmanager.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewHeatMapClient().Get(ctx, "azuresdkfornetautoresttrafficmanager1323", "azuresdkfornetautoresttrafficmanager3880", &armtrafficmanager.HeatMapClientGetOptions{TopLeft: []float64{
		10,
		50.001},
		BotRight: []float64{
			-50.001,
			80},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.HeatMapModel = armtrafficmanager.HeatMapModel{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation"),
	// 	Properties: &armtrafficmanager.HeatMapProperties{
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-22T12:50:00.000Z"); return t}()),
	// 		Endpoints: []*armtrafficmanager.HeatMapEndpoint{
	// 			{
	// 				EndpointID: to.Ptr[int32](1),
	// 				ResourceID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"),
	// 			},
	// 			{
	// 				EndpointID: to.Ptr[int32](2),
	// 				ResourceID: to.Ptr("/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"),
	// 		}},
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-15T12:00:00.000Z"); return t}()),
	// 		TrafficFlows: []*armtrafficmanager.TrafficFlow{
	// 			{
	// 				Latitude: to.Ptr[float64](9.99),
	// 				Longitude: to.Ptr[float64](75.01),
	// 				QueryExperiences: []*armtrafficmanager.QueryExperience{
	// 					{
	// 						EndpointID: to.Ptr[int32](1),
	// 						Latency: to.Ptr[float64](99.222),
	// 						QueryCount: to.Ptr[int32](1000000),
	// 					},
	// 					{
	// 						EndpointID: to.Ptr[int32](2),
	// 						Latency: to.Ptr[float64](1.222),
	// 						QueryCount: to.Ptr[int32](1),
	// 				}},
	// 				SourceIP: to.Ptr("1.1.1.1"),
	// 			},
	// 			{
	// 				Latitude: to.Ptr[float64](-49.99),
	// 				Longitude: to.Ptr[float64](51),
	// 				QueryExperiences: []*armtrafficmanager.QueryExperience{
	// 					{
	// 						EndpointID: to.Ptr[int32](1),
	// 						Latency: to.Ptr[float64](96.222),
	// 						QueryCount: to.Ptr[int32](100),
	// 					},
	// 					{
	// 						EndpointID: to.Ptr[int32](2),
	// 						Latency: to.Ptr[float64](4.222),
	// 						QueryCount: to.Ptr[int32](500),
	// 				}},
	// 				SourceIP: to.Ptr("2.255.1.1"),
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets latest heatmap for Traffic Manager profile.
 *
 * @summary Gets latest heatmap for Traffic Manager profile.
 * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-TopLeft-BotRight.json
 */
async function heatMapGetWithTopLeftBotRight() {
  const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName =
    process.env["TRAFFICMANAGER_RESOURCE_GROUP"] || "azuresdkfornetautoresttrafficmanager1323";
  const profileName = "azuresdkfornetautoresttrafficmanager3880";
  const topLeft = [10, 50.001];
  const botRight = [-50.001, 80];
  const options = { topLeft, botRight };
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.heatMap.get(resourceGroupName, profileName, options);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.TrafficManager.Models;
using Azure.ResourceManager.TrafficManager;

// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/HeatMap-GET-With-TopLeft-BotRight.json
// this example is just showing the usage of "HeatMap_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this TrafficManagerHeatMapResource created on azure
// for more information of creating TrafficManagerHeatMapResource, please refer to the document of TrafficManagerHeatMapResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager1323";
string profileName = "azuresdkfornetautoresttrafficmanager3880";
TrafficManagerHeatMapType heatMapType = TrafficManagerHeatMapType.Default;
ResourceIdentifier trafficManagerHeatMapResourceId = TrafficManagerHeatMapResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, heatMapType);
TrafficManagerHeatMapResource trafficManagerHeatMap = client.GetTrafficManagerHeatMapResource(trafficManagerHeatMapResourceId);

// invoke the operation
IEnumerable<double> topLeft = new double[] { 10, 50.001 };
IEnumerable<double> botRight = new double[] { -50.001, 80 };
TrafficManagerHeatMapResource result = await trafficManagerHeatMap.GetAsync(topLeft: topLeft, botRight: botRight);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
TrafficManagerHeatMapData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation",
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation",
  "properties": {
    "startTime": "2017-08-15T12:00:00Z",
    "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"
      }
    ],
    "trafficFlows": [
      {
        "latitude": 9.99,
        "longitude": 75.01,
        "sourceIp": "1.1.1.1",
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 99.222,
            "queryCount": 1000000
          },
          {
            "endpointId": 2,
            "latency": 1.222,
            "queryCount": 1
          }
        ]
      },
      {
        "latitude": -49.99,
        "longitude": 51,
        "sourceIp": "2.255.1.1",
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 96.222,
            "queryCount": 100
          },
          {
            "endpointId": 2,
            "latency": 4.222,
            "queryCount": 500
          }
        ]
      }
    ]
  }
}

定義

名前	説明
CloudError	Azure Resource Manager によって返されるエラー
CloudErrorBody	Azure Resource Manager によって返されたエラーの内容
HeatMapEndpoint	Traffic Manager エンドポイントのスパース表現であるクラス。
HeatMapModel	Traffic Manager HeatMap を表すクラス。
HeatMapType	Traffic Manager プロファイルの HeatMap の種類。
QueryExperience	Traffic Manager HeatMap クエリ エクスペリエンスプロパティを表すクラス。
TrafficFlow	Traffic Manager HeatMap トラフィック フロープロパティを表すクラス。

CloudError

Object

Azure Resource Manager によって返されるエラー

名前	型	説明
error	CloudErrorBody	エラーの内容。

CloudErrorBody

Object

Azure Resource Manager によって返されたエラーの内容

名前	型	説明
code	string	エラー コード
details	CloudErrorBody[]	エラーの詳細
message	string	エラーメッセージ
target	string	エラー ターゲット

HeatMapEndpoint

Object

Traffic Manager エンドポイントのスパース表現であるクラス。

名前	型	説明
endpointId	integer	クエリ エクスペリエンスでこのエンドポイントを一意に識別する数値。
resourceId	string	この Traffic Manager エンドポイントの ARM リソース ID。

HeatMapModel

Object

Traffic Manager HeatMap を表すクラス。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	リソースの名前
properties.endTime	string (date-time)	この HeatMap の時間枠の終了 。排他的です。
properties.endpoints	HeatMapEndpoint[]	この HeatMap 計算で使用されるエンドポイント。
properties.startTime	string (date-time)	この HeatMap の時間枠の先頭 (両端を含む)。
properties.trafficFlows	TrafficFlow[]	このヒートマップ計算で生成されたトラフィック フロー。
type	string	リソースの種類。 例: Microsoft.Network/trafficManagerProfiles。

HeatMapType

列挙

Traffic Manager プロファイルの HeatMap の種類。

値	説明
default

QueryExperience

Object

Traffic Manager HeatMap クエリ エクスペリエンスプロパティを表すクラス。

名前	型	説明
endpointId	integer	これらのクエリがルーティングされた "endpoints" 配列のエンドポイントの ID。
latency	number (double)	この場所から発生したクエリによって発生する待機時間。
queryCount	integer	この場所から送信されたクエリの数。

TrafficFlow

Object

Traffic Manager HeatMap トラフィック フロープロパティを表すクラス。

名前	型	説明
latitude	number (double)	これらのクエリの送信元のおおよその緯度。
longitude	number (double)	これらのクエリの送信元のおおよその経度。
queryExperiences	QueryExperience[]	この HeatMap 計算で生成されたクエリ エクスペリエンス。
sourceIp	string	このクエリ エクスペリエンスの送信元の IP アドレス。