Baselines - List

Referencia

Service:: Monitor

API Version:: 2019-03-01

Listas los valores de línea base de métrica de un 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 identificador URI

Nombre	En	Requerido	Tipo	Description
resourceUri	path	True	string	Identificador del recurso.
api-version	query	True	string	Versión de API que se usará para la operación.
$filter	query		string	El $filter se usa para reducir el conjunto de datos de métricas devueltos. Ejemplo: la métrica contiene los metadatos A, B y C. - Devuelve todas las series temporales de C donde A = a1 y B = b1 o b2 *$filter=A eq 'a1' y B eq 'b1' o B eq 'b2' y C eq '' - Variante no válida: $filter=A eq 'a1' y B eq 'b1' y C eq '' o B = 'b2'* Esto no es válido porque el operador lógico o no puede separar dos nombres de metadatos diferentes. - Devuelve todas las series temporales donde A = a1, B = b1 y C = c1: $filter=A eq 'a1' y B eq 'b1' y C eq 'c1' - Devuelve todas las series temporales donde A = a1 $filter=A eq 'a1' y B eq '' y C eq ''. Caso especial: cuando el nombre de dimensión o el valor de dimensión usan corchetes redondos. Por ejemplo: Cuando el nombre de dimensión es dim (test) 1 En lugar 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 dim (test) 3 and dimension value is dim3 (prueba) val En lugar de usar $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "**
aggregation	query		string	Lista de tipos de agregación (separados por comas) que se van a recuperar.
interval	query		string duration	Intervalo (es decir, timegrain) de la consulta.
metricnames	query		string	Nombres de las métricas (separadas por comas) que se van a recuperar. Caso especial: si un nombre de métrica tiene una coma en él, use %2 para indicarlo. Por ejemplo: 'Métrica,Nombre1' debe ser 'Métrica%2Name1'
metricnamespace	query		string	Espacio de nombres de métrica para el que se van a consultar las definiciones de métricas.
resultType	query		ResultType	Permite recuperar solo los metadatos de la línea base. En la solicitud de datos, se recupera toda la información.
sensitivities	query		string	Lista de sensibilidades (separadas por comas) que se van a recuperar.
timespan	query		string	El intervalo de tiempo de la consulta. Es una cadena con el siguiente formato "startDateTime_ISO/endDateTime_ISO".

Respuestas

Nombre	Tipo	Description
200 OK	MetricBaselinesResponse	Solicitud correcta para obtener la lista de valores de línea base de métricas.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
BaselineMetadata	Representa un valor de metadatos de línea base.
BaselineSensitivity	la sensibilidad de la línea base.
ErrorResponse	Describe el formato de respuesta de error.
MetricBaselinesResponse	Lista de líneas base de métricas.
MetricSingleDimension	Nombre y valor de la dimensión de métrica.
ResultType	Permite recuperar solo los metadatos de la línea base. En la solicitud de datos, se recupera toda la información.
SingleBaseline	Valores de línea base para un valor de confidencialidad único.
SingleMetricBaseline	Resultados de línea base de una sola métrica.
TimeSeriesBaseline	Los valores de línea base de una sola serie temporal.

BaselineMetadata

Representa un valor de metadatos de línea base.

Nombre	Tipo	Description
name	string	Nombre de los metadatos de línea base.
value	string	Valor de los metadatos de línea base.

BaselineSensitivity

la sensibilidad de la línea base.

Nombre	Tipo	Description
High	string
Low	string
Medium	string

ErrorResponse

Describe el formato de respuesta de error.

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

MetricBaselinesResponse

Lista de líneas base de métricas.

Nombre	Tipo	Description
value	SingleMetricBaseline[]	Lista de líneas base de métricas.

MetricSingleDimension

Nombre y valor de la dimensión de métrica.

Nombre	Tipo	Description
name	string	Nombre de la dimensión.
value	string	Valor de la dimensión.

ResultType

Permite recuperar solo los metadatos de la línea base. En la solicitud de datos, se recupera toda la información.

Nombre	Tipo	Description
Data	string
Metadata	string

SingleBaseline

Valores de línea base para un valor de confidencialidad único.

Nombre	Tipo	Description
highThresholds	number[]	Umbrales altos de la línea base.
lowThresholds	number[]	Umbrales bajos de la línea base.
sensitivity	BaselineSensitivity	la sensibilidad de la línea base.

SingleMetricBaseline

Resultados de línea base de una sola métrica.

Nombre	Tipo	Description
id	string	Identificador de línea de base de métrica.
name	string	Nombre de la métrica para la que se recuperaron las líneas base.
properties.baselines	TimeSeriesBaseline[]	Línea base de cada serie temporal que se ha consultado.
properties.interval	string	Intervalo (tamaño de ventana) en el que se devolvieron los datos de métricas. Esto puede ajustarse en el futuro y devolverse de lo que se solicitó originalmente. Esto no está presente si se realizó una solicitud de metadatos.
properties.namespace	string	Espacio de nombres de las métricas consultadas.
properties.timespan	string	Intervalo de tiempo para el que se recuperaron los datos. Su valor consta de dos datetimes concatenadas, separadas por '/'. Esto puede ajustarse en el futuro y devolverse de lo que se solicitó originalmente.
type	string	Tipo de recurso del recurso de línea de base de métrica.

TimeSeriesBaseline

Los valores de línea base de una sola serie temporal.

Nombre	Tipo	Description
aggregation	string	Tipo de agregación de la métrica.
data	SingleBaseline[]	Valores de línea base para cada confidencialidad.
dimensions	MetricSingleDimension[]	Dimensiones de esta serie temporal.
metadataValues	BaselineMetadata[]	Los valores de metadatos de línea base.
timestamps	string[]	Lista de marcas de tiempo de las líneas base.

Baselines - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Get metric baselines

Sample Request

Sample Response

Definiciones

BaselineMetadata

BaselineSensitivity

ErrorResponse

MetricBaselinesResponse

MetricSingleDimension

ResultType

SingleBaseline

SingleMetricBaseline

TimeSeriesBaseline

Recursos adicionales