Baselines - List

Service:

Monitor

API Version:

2019-03-01

Списки базовые значения метрик для ресурса.

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' and C eq '*' — Недопустимый вариант: $filter=A eq 'a1' and Bq 'b1' and 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 "" "** When dimension name is dim (test) 3 и dimension value value is 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, чтобы указать его. Например: "Метрика,Имя1" должна иметь значение "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

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
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
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

Определения

Имя	Описание
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	Базовый идентификатор метрики.
name	string	Имя метрики, для которой были получены базовые показатели.
properties.baselines	TimeSeriesBaseline[]	Базовый план для каждого запрашиваемого временного ряда.
properties.interval	string	Интервал (размер окна), для которого были возвращены данные метрики. Это может быть скорректировано в будущем и возвращено обратно из того, что было первоначально запрошено. Этот параметр отсутствует, если был сделан запрос на метаданные.
properties.namespace	string	Пространство имен метрик было запрошено.
properties.timespan	string	Интервал времени, для которого были получены данные. Его значение состоит из двух объединенных значений datetime, разделенных "/". Это может быть скорректировано в будущем и возвращено обратно из того, что было первоначально запрошено.
type	string	Тип ресурса базового ресурса метрики.

TimeSeriesBaseline

Базовые значения для одного временного ряда.

Имя	Тип	Описание
aggregation	string	Тип агрегирования метрики.
data	SingleBaseline[]	Базовые значения для каждой конфиденциальности.
dimensions	MetricSingleDimension[]	Измерения этого временного ряда.
metadataValues	BaselineMetadata[]	Базовые значения метаданных.
timestamps	string[]	Список меток времени базовых показателей.