你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Reports - Get Latency Scorecards

Service:

Internet Analyzer

API Version:

2019-11-01

获取给定试验的延迟记分卡

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}/LatencyScorecard?api-version=2019-11-01&aggregationInterval={aggregationInterval}

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}/LatencyScorecard?api-version=2019-11-01&endDateTimeUTC={endDateTimeUTC}&country={country}&aggregationInterval={aggregationInterval}

URI 参数

名称	在	必需	类型	说明
experimentName	path	True	string	与试验关联的试验标识符 Regex pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
profileName	path	True	string	与租户和合作伙伴关联的配置文件标识符 Regex pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
resourceGroupName	path	True	string	Azure 订阅中的资源组的名称。 Regex pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
subscriptionId	path	True	string	可以唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
aggregationInterval	query	True	latencyScorecardAggregationInterval	延迟记分卡的聚合间隔
api-version	query	True	string	客户端 API 版本。
country	query		string	与延迟记分卡关联的国家/地区。 值是此处指定的国家/地区 ISO 代码- https://www.iso.org/iso-3166-country-codes.html
endDateTimeUTC	query		string	UTC 中延迟记分卡的结束日期时间

响应

名称	类型	说明
200 OK	LatencyScorecard	成功的操作
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Gets a Latency Scorecard for a given Experiment

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment/LatencyScorecard?api-version=2019-11-01&aggregationInterval=Daily

Java

import com.azure.resourcemanager.frontdoor.models.LatencyScorecardAggregationInterval;

/** Samples for Reports GetLatencyScorecards. */
public final class Main {
    /*
     * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetLatencyScorecard.json
     */
    /**
     * Sample code: Gets a Latency Scorecard for a given Experiment.
     *
     * @param manager Entry point to FrontDoorManager.
     */
    public static void getsALatencyScorecardForAGivenExperiment(
        com.azure.resourcemanager.frontdoor.FrontDoorManager manager) {
        manager
            .reports()
            .getLatencyScorecardsWithResponse(
                "MyResourceGroup",
                "MyProfile",
                "MyExperiment",
                LatencyScorecardAggregationInterval.DAILY,
                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.frontdoor import FrontDoorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-frontdoor
# USAGE
    python network_experiment_get_latency_scorecard.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 = FrontDoorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.reports.get_latency_scorecards(
        resource_group_name="MyResourceGroup",
        profile_name="MyProfile",
        experiment_name="MyExperiment",
        aggregation_interval="Daily",
    )
    print(response)


# x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetLatencyScorecard.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 armfrontdoor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/frontdoor/armfrontdoor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b54ffc9278eff071455b1dbb4ad2e772afce885d/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetLatencyScorecard.json
func ExampleReportsClient_GetLatencyScorecards() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armfrontdoor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewReportsClient().GetLatencyScorecards(ctx, "MyResourceGroup", "MyProfile", "MyExperiment", armfrontdoor.LatencyScorecardAggregationIntervalDaily, &armfrontdoor.ReportsClientGetLatencyScorecardsOptions{EndDateTimeUTC: nil,
		Country: nil,
	})
	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.LatencyScorecard = armfrontdoor.LatencyScorecard{
	// 	Name: to.Ptr("DailyLatencyScorecard"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment/LatencyScorecard"),
	// 	Properties: &armfrontdoor.LatencyScorecardProperties{
	// 		Description: to.Ptr("This scorecard is the latency scorecard, aggregated over a day"),
	// 		Country: to.Ptr("USA"),
	// 		EndDateTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-09-21T17:32:28.000Z"); return t}()),
	// 		EndpointA: to.Ptr("https://endpointA.com"),
	// 		EndpointB: to.Ptr("https://endpoingB.com"),
	// 		StartDateTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-07-21T17:32:28.000Z"); return t}()),
	// 	},
	// }
}

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 { FrontDoorManagementClient } = require("@azure/arm-frontdoor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a Latency Scorecard for a given Experiment
 *
 * @summary Gets a Latency Scorecard for a given Experiment
 * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetLatencyScorecard.json
 */
async function getsALatencyScorecardForAGivenExperiment() {
  const subscriptionId = process.env["FRONTDOOR_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["FRONTDOOR_RESOURCE_GROUP"] || "MyResourceGroup";
  const profileName = "MyProfile";
  const experimentName = "MyExperiment";
  const aggregationInterval = "Daily";
  const credential = new DefaultAzureCredential();
  const client = new FrontDoorManagementClient(credential, subscriptionId);
  const result = await client.reports.getLatencyScorecards(
    resourceGroupName,
    profileName,
    experimentName,
    aggregationInterval,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.FrontDoor;
using Azure.ResourceManager.FrontDoor.Models;

// Generated from example definition: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetLatencyScorecard.json
// this example is just showing the usage of "Reports_GetLatencyScorecards" 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 FrontDoorExperimentResource created on azure
// for more information of creating FrontDoorExperimentResource, please refer to the document of FrontDoorExperimentResource
string subscriptionId = "subid";
string resourceGroupName = "MyResourceGroup";
string profileName = "MyProfile";
string experimentName = "MyExperiment";
ResourceIdentifier frontDoorExperimentResourceId = FrontDoorExperimentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, experimentName);
FrontDoorExperimentResource frontDoorExperiment = client.GetFrontDoorExperimentResource(frontDoorExperimentResourceId);

// invoke the operation
LatencyScorecardAggregationInterval aggregationInterval = LatencyScorecardAggregationInterval.Daily;
LatencyScorecard result = await frontDoorExperiment.GetLatencyScorecardsReportAsync(aggregationInterval);

Console.WriteLine($"Succeeded: {result}");

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment/LatencyScorecard",
  "name": "DailyLatencyScorecard",
  "properties": {
    "description": "This scorecard is the latency scorecard, aggregated over a day",
    "endpointA": "https://endpointA.com",
    "endpointB": "https://endpoingB.com",
    "startDateTimeUTC": "2019-07-21T17:32:28Z",
    "endDateTimeUTC": "2019-09-21T17:32:28Z",
    "country": "USA"
  }
}

定义

名称	说明
ErrorResponse	错误响应指示 Front Door 服务无法处理传入请求。 错误消息中提供了原因。
LatencyMetric	定义延迟记分卡中使用的延迟指标的属性
LatencyScorecard	定义 LatencyScorecard
latencyScorecardAggregationInterval	延迟记分卡的聚合间隔

ErrorResponse

错误响应指示 Front Door 服务无法处理传入请求。 错误消息中提供了原因。

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败原因的错误消息。

LatencyMetric

定义延迟记分卡中使用的延迟指标的属性

名称	类型	说明
aCLower95CI	number	终结点 A 的 95% 置信区间的下端
aHUpper95CI	number	终结点 A 的 95% 置信区间的上端
aValue	number	A 终结点的指标值
bCLower95CI	number	终结点 B 的 95% 置信区间的低端
bUpper95CI	number	终结点 B 的 95% 置信区间的上端
bValue	number	B 终结点的指标值
delta	number	终结点 A 和 B 之间的值差异
deltaPercent	number	终结点 A 和 B 之间的百分比差异
endDateTimeUTC	string	延迟记分卡的结束时间（UTC）
name	string	延迟指标的名称

LatencyScorecard

定义 LatencyScorecard

名称	类型	说明
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.country	string	与延迟记分卡关联的国家/地区。 值是此处指定的国家/地区 ISO 代码- https://www.iso.org/iso-3166-country-codes.html
properties.description	string	延迟记分卡的说明
properties.endDateTimeUTC	string	延迟记分卡的结束时间（UTC）
properties.endpointA	string	记分卡中的 A 终结点
properties.endpointB	string	记分卡中的 B 终结点
properties.id	string	延迟记分卡的唯一标识符
properties.latencyMetrics	LatencyMetric[]	延迟记分卡的延迟指标
properties.name	string	延迟记分卡的名称
properties.startDateTimeUTC	string	延迟记分卡的开始时间（UTC）
tags	object	资源标记。
type	string	资源类型。

latencyScorecardAggregationInterval

延迟记分卡的聚合间隔

名称	类型	说明
Daily	string
Monthly	string
Weekly	string