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

Baselines - List

参考

Service:: Monitor

API Version:: 2019-03-01

Lists资源的指标基线值。

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?api-version=2019-03-01

With optional parameters:

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?metricnames={metricnames}&metricnamespace={metricnamespace}&timespan={timespan}&interval={interval}&aggregation={aggregation}&sensitivities={sensitivities}&$filter={$filter}&resultType={resultType}&api-version=2019-03-01

URI 参数

名称	在	必需	类型	说明
resourceUri	path	True	string	资源的标识符。
api-version	query	True	string	要用于此操作的 API 版本。
$filter	query		string	$filter用于减少返回的指标数据集。示例：指标包含元数据 A、B 和 C。 - 返回 C 的所有时序，其中 A = a1 且 B = b1 或 b2 *$filter=A eq 'a1' 和 B eq 'b1' 或 B eq 'b2' 和 C eq '' - 无效变量： $filter=A eq 'a1' 和 B eq 'b1' 和 C eq '' 或 B = 'b2'* 这无效，因为逻辑或运算符无法分隔两个不同的元数据名称。 - 返回 A = a1、B = b1 且 C = c1 的所有时序： $filter=A eq 'a1' 和 B eq 'b1' 和 C eq 'c1' - 返回 A = a1 *$filter=A eq 'a1' 和 B eq '' 和 C eq ''的所有时序。特殊情况：当维度名称或维度值使用圆括号时。例如：当维度名称为 dim (test) 1* 而不是使用 $filter= “dim (test) 1 eq '” 时，请使用 $filter= “dim %2528test%2529 1 eq '' ” 当维度名称为 dim 时， (测试) 3 且维度值为 dim3 (test) val 而不是使用 $filter= “dim (test) 3 eq 'dim3 (test) val' ” use $filter= “dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' ”**
aggregation	query		string	要检索的聚合类型列表 (逗号分隔) 。
interval	query		string duration	间隔 (即查询的 timegrain) 。
metricnames	query		string	要检索的指标名称 (逗号分隔) 。特殊情况：如果指标名称本身包含逗号，则使用 %2 来指示它。例如：“Metric，Name1”应为 “Metric%2Name1”
metricnamespace	query		string	要查询其指标定义的指标命名空间。
resultType	query		ResultType	仅允许检索基线的元数据。在数据请求中检索所有信息。
sensitivities	query		string	要检索的敏感度列表 (逗号分隔) 。
timespan	query		string	查询的时间跨度。它是格式为“startDateTime_ISO/endDateTime_ISO”的字符串。

响应

名称	类型	说明
200 OK	MetricBaselinesResponse	成功请求获取指标基线值列表。
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	模拟用户帐户

示例

Get metric baselines

Sample Request

GET https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Insights/metricBaselines?timespan=2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z&interval=PT1H&aggregation=average&sensitivities=Low,Medium&api-version=2019-03-01


import java.time.Duration;

/**
 * Samples for Baselines List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/examples/metricBaselines.json
     */
    /**
     * Sample code: Get metric baselines.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getMetricBaselines(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getBaselines().list(
            "subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1",
            null, null, "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z", Duration.parse("PT1H"), "average",
            "Low,Medium", 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

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/examples/metricBaselines.json
func ExampleBaselinesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBaselinesClient().NewListPager("subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1", &armmonitor.BaselinesClientListOptions{Metricnames: nil,
		Metricnamespace: nil,
		Timespan:        to.Ptr("2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z"),
		Interval:        to.Ptr("PT1H"),
		Aggregation:     to.Ptr("average"),
		Sensitivities:   to.Ptr("Low,Medium"),
		Filter:          nil,
		ResultType:      nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MetricBaselinesResponse = armmonitor.MetricBaselinesResponse{
		// 	Value: []*armmonitor.SingleMetricBaseline{
		// 		{
		// 			Name: to.Ptr("Percentage CPU"),
		// 			Type: to.Ptr("microsoft.insights/metricBaselines"),
		// 			ID: to.Ptr("/subscriptions/11aeb0ed-456b-4ca0-8df5-b9fbdc63d0d3/resourceGroups/SmartAnalytics-DEV-VM/providers/Microsoft.Compute/virtualMachines/DemoVM1/providers/microsoft.insights/metricBaselines/Percentage CPU"),
		// 			Properties: &armmonitor.MetricBaselinesProperties{
		// 				Baselines: []*armmonitor.TimeSeriesBaseline{
		// 					{
		// 						Aggregation: to.Ptr("average"),
		// 						Data: []*armmonitor.SingleBaseline{
		// 							{
		// 								HighThresholds: []*float64{
		// 									to.Ptr[float64](90.3453),
		// 									to.Ptr[float64](91.3453)},
		// 									LowThresholds: []*float64{
		// 										to.Ptr[float64](30),
		// 										to.Ptr[float64](31.1)},
		// 										Sensitivity: to.Ptr(armmonitor.BaselineSensitivityLow),
		// 									},
		// 									{
		// 										HighThresholds: []*float64{
		// 											to.Ptr[float64](70.3453),
		// 											to.Ptr[float64](71.3453)},
		// 											LowThresholds: []*float64{
		// 												to.Ptr[float64](50),
		// 												to.Ptr[float64](51.1)},
		// 												Sensitivity: to.Ptr(armmonitor.BaselineSensitivityMedium),
		// 										}},
		// 										Dimensions: []*armmonitor.MetricSingleDimension{
		// 										},
		// 										MetadataValues: []*armmonitor.BaselineMetadata{
		// 											{
		// 												Name: to.Ptr("ErrorType"),
		// 												Value: to.Ptr("TooManyAnomalies"),
		// 											},
		// 											{
		// 												Name: to.Ptr("SeasonalityFrequency"),
		// 												Value: to.Ptr("288"),
		// 										}},
		// 										Timestamps: []*time.Time{
		// 											to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-12T11:00:00.000Z"); return t}()),
		// 											to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-12T12:00:00.000Z"); return t}())},
		// 									}},
		// 									Interval: to.Ptr("PT1H"),
		// 									Namespace: to.Ptr("microsoft.compute/virtualmachines"),
		// 									Timespan: to.Ptr("2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z"),
		// 								},
		// 						}},
		// 					}
	}
}

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

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

/**
 * This sample demonstrates how to **Lists the metric baseline values for a resource**.
 *
 * @summary **Lists the metric baseline values for a resource**.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/examples/metricBaselines.json
 */
async function getMetricBaselines() {
  const resourceUri =
    "subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1";
  const timespan = "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z";
  const interval = "PT1H";
  const aggregation = "average";
  const sensitivities = "Low,Medium";
  const options = {
    timespan,
    interval,
    aggregation,
    sensitivities,
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential);
  const resArray = new Array();
  for await (let item of client.baselines.list(resourceUri, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "id": "/subscriptions/11aeb0ed-456b-4ca0-8df5-b9fbdc63d0d3/resourceGroups/SmartAnalytics-DEV-VM/providers/Microsoft.Compute/virtualMachines/DemoVM1/providers/microsoft.insights/metricBaselines/Percentage CPU",
      "type": "microsoft.insights/metricBaselines",
      "name": "Percentage CPU",
      "properties": {
        "interval": "PT1H",
        "timespan": "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z",
        "namespace": "microsoft.compute/virtualmachines",
        "baselines": [
          {
            "aggregation": "average",
            "dimensions": [],
            "metadataValues": [
              {
                "name": "ErrorType",
                "value": "TooManyAnomalies"
              },
              {
                "name": "SeasonalityFrequency",
                "value": "288"
              }
            ],
            "timestamps": [
              "2019-03-12T11:00:00.000Z",
              "2019-03-12T12:00:00.000Z"
            ],
            "data": [
              {
                "sensitivity": "Low",
                "lowThresholds": [
                  30,
                  31.1
                ],
                "highThresholds": [
                  90.3453,
                  91.3453
                ]
              },
              {
                "sensitivity": "Medium",
                "lowThresholds": [
                  50,
                  51.1
                ],
                "highThresholds": [
                  70.3453,
                  71.3453
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

定义

名称	说明
BaselineMetadata	表示基线元数据值。
BaselineSensitivity	基线的敏感度。
ErrorResponse	描述错误响应的格式。
MetricBaselinesResponse	指标基线列表。
MetricSingleDimension	指标维度名称和值。
ResultType	仅允许检索基线的元数据。在数据请求中检索所有信息。
SingleBaseline	单个敏感度值的基线值。
SingleMetricBaseline	单个指标的基线结果。
TimeSeriesBaseline	单个时序的基线值。

BaselineMetadata

表示基线元数据值。

名称	类型	说明
name	string	基线元数据的名称。
value	string	基线元数据的值。

BaselineSensitivity

基线的敏感度。

名称	类型	说明
High	string
Low	string
Medium	string

ErrorResponse

描述错误响应的格式。

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

MetricBaselinesResponse

指标基线列表。

名称	类型	说明
value	SingleMetricBaseline[]	指标基线列表。

MetricSingleDimension

指标维度名称和值。

名称	类型	说明
name	string	维度的名称。
value	string	维度的值。

ResultType

仅允许检索基线的元数据。在数据请求中检索所有信息。

名称	类型	说明
Data	string
Metadata	string

SingleBaseline

单个敏感度值的基线值。

名称	类型	说明
highThresholds	number[]	基线的高阈值。
lowThresholds	number[]	基线的低阈值。
sensitivity	BaselineSensitivity	基线的敏感度。

SingleMetricBaseline

单个指标的基线结果。

名称	类型	说明
id	string	指标基线 ID。
name	string	为其检索基线的指标的名称。
properties.baselines	TimeSeriesBaseline[]	查询的每个时序的基线。
properties.interval	string	返回指标数据的间隔 (窗口大小) 。将来可能会对此进行调整，并从最初请求的内容返回。如果发出了元数据请求，则不存在此请求。
properties.namespace	string	已查询指标的命名空间。
properties.timespan	string	检索数据的时间跨度。其值由两个连接在一起的日期/时间组成，以“/”分隔。将来可能会对此进行调整，并从最初请求的内容返回。
type	string	指标基线资源的资源类型。

TimeSeriesBaseline

单个时序的基线值。

名称	类型	说明
aggregation	string	指标的聚合类型。
data	SingleBaseline[]	每个敏感度的基线值。
dimensions	MetricSingleDimension[]	此时序的尺寸。
metadataValues	BaselineMetadata[]	基线元数据值。
timestamps	string[]	基线的时间戳列表。

通过

Baselines - List

URI 参数

响应

安全性

azure_auth

Scopes

示例

Get metric baselines

Sample Request

Sample Response

定义

BaselineMetadata

BaselineSensitivity

ErrorResponse

MetricBaselinesResponse

MetricSingleDimension

ResultType

SingleBaseline

SingleMetricBaseline

TimeSeriesBaseline

其他资源