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 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceUri	path	True	string	리소스의 식별자입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
$filter	query		string	$filter 반환된 메트릭 데이터 집합을 줄이는 데 사용됩니다. 예: 메트릭에는 메타데이터 A, B 및 C가 포함됩니다. - A = a1 및 B = b1 또는 b2 $filter=A eq 'a1' 및 B eq 'b1' 또는 B eq 'b2' 및 C eq '*' 인 C의 모든 시계열을 반환합니다. 잘못된 변형: $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 ''인 모든 시계열을 반환합니다. 특수 사례: 차원 이름 또는 차원 값이 둥근 대괄호를 사용하는 경우 예: 차원 이름이 어둡게(테스트) 1 인 경우 $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** 차원 이름이 어둡게(테스트) 3 이고 차원 값이 흐리게 표시되면 3 (테스트) 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' 형식의 문자열입니다.

응답

Name	형식	Description
200 OK	MetricBaselinesResponse	메트릭 기준 값 목록을 가져오기 위한 요청이 성공했습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

Get metric baselines

Sample Request

HTTP

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

Java

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

Go

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

JavaScript

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
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

정의

Name	Description
BaselineMetadata	기준 메타데이터 값을 나타냅니다.
BaselineSensitivity	기준선의 민감도입니다.
ErrorResponse	오류 응답의 형식을 설명합니다.
MetricBaselinesResponse	메트릭 기준 목록입니다.
MetricSingleDimension	메트릭 차원 이름 및 값입니다.
ResultType	기준의 메타데이터만 검색할 수 있습니다. 데이터 요청에서 모든 정보가 검색됩니다.
SingleBaseline	단일 민감도 값에 대한 기준 값입니다.
SingleMetricBaseline	단일 메트릭의 기준 결과입니다.
TimeSeriesBaseline	단일 시계열의 기준 값입니다.

BaselineMetadata

기준 메타데이터 값을 나타냅니다.

Name	형식	Description
name	string	기준 메타데이터의 이름입니다.
value	string	기준 메타데이터의 값입니다.

BaselineSensitivity

기준선의 민감도입니다.

Name	형식	Description
High	string
Low	string
Medium	string

ErrorResponse

오류 응답의 형식을 설명합니다.

Name	형식	Description
code	string	오류 코드
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

MetricBaselinesResponse

메트릭 기준 목록입니다.

Name	형식	Description
value	SingleMetricBaseline[]	메트릭 기준 목록입니다.

MetricSingleDimension

메트릭 차원 이름 및 값입니다.

Name	형식	Description
name	string	차원의 이름입니다.
value	string	차원의 값입니다.

ResultType

기준의 메타데이터만 검색할 수 있습니다. 데이터 요청에서 모든 정보가 검색됩니다.

Name	형식	Description
Data	string
Metadata	string

SingleBaseline

단일 민감도 값에 대한 기준 값입니다.

Name	형식	Description
highThresholds	number[]	기준선의 높은 임계값입니다.
lowThresholds	number[]	기준선의 낮은 임계값입니다.
sensitivity	BaselineSensitivity	기준선의 민감도입니다.

SingleMetricBaseline

단일 메트릭의 기준 결과입니다.

Name	형식	Description
id	string	메트릭 기준 ID입니다.
name	string	기준선을 검색한 메트릭의 이름입니다.
properties.baselines	TimeSeriesBaseline[]	쿼리된 각 시계열의 기준입니다.
properties.interval	string	메트릭 데이터가 반환된 간격(창 크기)입니다. 이는 나중에 조정되어 원래 요청된 내용에서 다시 반환될 수 있습니다. 메타데이터 요청이 수행된 경우에는 이 값이 없습니다.
properties.namespace	string	메트릭의 네임스페이스가 쿼리되었습니다.
properties.timespan	string	데이터가 검색된 시간 범위입니다. 해당 값은 '/'로 구분된 두 개의 날짜/시간으로 구성됩니다. 이는 나중에 조정되어 원래 요청된 내용에서 다시 반환될 수 있습니다.
type	string	메트릭 기준 리소스의 리소스 종류입니다.

TimeSeriesBaseline

단일 시계열의 기준 값입니다.

Name	형식	Description
aggregation	string	메트릭의 집계 형식입니다.
data	SingleBaseline[]	각 민감도에 대한 기준 값입니다.
dimensions	MetricSingleDimension[]	이 시계열의 차원입니다.
metadataValues	BaselineMetadata[]	기준 메타데이터 값입니다.
timestamps	string[]	기준의 타임스탬프 목록입니다.