Baselines - List

Referência

Service:: Monitor

API Version:: 2019-03-01

Listas os valores de linha de base de métrica de um recurso.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceUri	path	True	string	O identificador do recurso.
api-version	query	True	string	A versão da API a ser usada para esta operação.
$filter	query		string	O $filter é usado para reduzir o conjunto de dados de métrica retornados. Exemplo: a métrica contém metadados A, B e C. - Retornar todas as séries temporais de C em que A = a1 e B = b1 ou b2 *$filter=A eq 'a1' e B eq 'b1' ou B eq 'b2' e C eq '' - Variante inválida: $filter=A eq 'a1' e B eq 'b1' e C eq '' ou B = 'b2'* Isso é inválido porque o operador lógico ou não pode separar dois nomes de metadados diferentes. - Retornar todas as séries temporais em que A = a1, B = b1 e C = c1: $filter=A eq 'a1' e B eq 'b1' e C eq 'c1' - retornar todas as séries temporais em que A = a1 *$filter=A eq 'a1' e B eq '' e C eq ''. Caso especial: quando o nome da dimensão ou o valor da dimensão usa colchetes redondos. Por exemplo: quando o nome da dimensão é dim (teste) 1* Em vez de usar $filter= "dim (test) 1 eq '' use $filter= "dim %2528test%2529 1 eq '' " When dimension name is dim (test) 3 and dimension value is dim3 (teste) val Em vez de usar $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "**
aggregation	query		string	A lista de tipos de agregação (separados por vírgula) a serem recuperados.
interval	query		string duration	O intervalo (ou seja, timegrain) da consulta.
metricnames	query		string	Os nomes das métricas (separados por vírgula) a serem recuperados. Caso especial: se um nome de métrica tiver uma vírgula, use %2 para indique-o. Por exemplo: 'Metric,Name1' deve ser 'Metric%2Name1'
metricnamespace	query		string	Namespace de métrica para o qual consultar definições de métrica.
resultType	query		ResultType	Permite recuperar apenas metadados da linha de base. Na solicitação de dados, todas as informações são recuperadas.
sensitivities	query		string	A lista de confidencialidades (separadas por vírgulas) a serem recuperadas.
timespan	query		string	O período de tempo da consulta. É uma cadeia de caracteres com o seguinte formato 'startDateTime_ISO/endDateTime_ISO'.

Respostas

Nome	Tipo	Description
200 OK	MetricBaselinesResponse	Solicitação bem-sucedida para obter a lista de valores de linha de base de métrica.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
BaselineMetadata	Representa um valor de metadados de linha de base.
BaselineSensitivity	a sensibilidade da linha de base.
ErrorResponse	Descreve o formato da resposta de erro.
MetricBaselinesResponse	Uma lista de linhas de base de métrica.
MetricSingleDimension	O nome e o valor da dimensão da métrica.
ResultType	Permite recuperar apenas metadados da linha de base. Na solicitação de dados, todas as informações são recuperadas.
SingleBaseline	Os valores de linha de base para um único valor de confidencialidade.
SingleMetricBaseline	Os resultados da linha de base de uma única métrica.
TimeSeriesBaseline	Os valores de linha de base para uma única série temporal.

BaselineMetadata

Representa um valor de metadados de linha de base.

Nome	Tipo	Description
name	string	Nome dos metadados de linha de base.
value	string	Valor dos metadados de linha de base.

BaselineSensitivity

a sensibilidade da linha de base.

Nome	Tipo	Description
High	string
Low	string
Medium	string

ErrorResponse

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

MetricBaselinesResponse

Uma lista de linhas de base de métrica.

Nome	Tipo	Description
value	SingleMetricBaseline[]	A lista de linhas de base de métrica.

MetricSingleDimension

O nome e o valor da dimensão da métrica.

Nome	Tipo	Description
name	string	Nome da dimensão.
value	string	Valor da dimensão.

ResultType

Permite recuperar apenas metadados da linha de base. Na solicitação de dados, todas as informações são recuperadas.

Nome	Tipo	Description
Data	string
Metadata	string

SingleBaseline

Os valores de linha de base para um único valor de confidencialidade.

Nome	Tipo	Description
highThresholds	number[]	Os limites altos da linha de base.
lowThresholds	number[]	Os limites baixos da linha de base.
sensitivity	BaselineSensitivity	a sensibilidade da linha de base.

SingleMetricBaseline

Os resultados da linha de base de uma única métrica.

Nome	Tipo	Description
id	string	A ID da linha de base da métrica.
name	string	O nome da métrica para a qual as linhas de base foram recuperadas.
properties.baselines	TimeSeriesBaseline[]	A linha de base para cada série temporal que foi consultada.
properties.interval	string	O intervalo (tamanho da janela) no qual os dados de métrica foram retornados. Isso pode ser ajustado no futuro e retornado do que foi originalmente solicitado. Isso não está presente se uma solicitação de metadados foi feita.
properties.namespace	string	O namespace das métricas foi consultado.
properties.timespan	string	O período de tempo para o qual os dados foram recuperados. Seu valor consiste em dois datetimes concatenados, separados por '/'. Isso pode ser ajustado no futuro e retornado do que foi originalmente solicitado.
type	string	O tipo de recurso do recurso de linha de base de métrica.

TimeSeriesBaseline

Os valores de linha de base para uma única série temporal.

Nome	Tipo	Description
aggregation	string	O tipo de agregação da métrica.
data	SingleBaseline[]	Os valores de linha de base para cada confidencialidade.
dimensions	MetricSingleDimension[]	As dimensões desta série temporal.
metadataValues	BaselineMetadata[]	Os valores de metadados de linha de base.
timestamps	string[]	A lista de carimbos de data/hora das linhas de base.

Baselines - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

Get metric baselines

Sample Request

Sample Response

Definições

BaselineMetadata

BaselineSensitivity

ErrorResponse

MetricBaselinesResponse

MetricSingleDimension

ResultType

SingleBaseline

SingleMetricBaseline

TimeSeriesBaseline

Recursos adicionais