Baselines - List

Riferimento

Servizio:: Monitor

Versione API:: 2019-03-01

Elenchi i valori di base delle metriche per una risorsa.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceUri	path	True	string	Identificatore della risorsa.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$filter	query		string	Il $filter viene usato per ridurre il set di dati delle metriche restituiti. Esempio: la metrica contiene metadati A, B e C. - Restituisce tutte le serie temporali di C dove A = a1 e B = b1 o b2 $filter=A eq 'a1' e B eq 'b1' o B eq ' b2' eq 'b2 ' - Variante non valida: $filter=A eq 'a1 ' eq 'b1' e C eq '' o B = 'b2' Non è valida perché l'operatore logico o non può separare due nomi di metadati diversi. - Restituisce tutte le serie temporali in cui A = a1, B = b1 e C = c1: $filter=A eq 'a1' e B eq 'b1' e C eq 'c1'* - Restituisce tutte le serie temporali in cui A = a1 $filter=A eq 'a1' eq '' eQ '' e C eq ''. Caso speciale: quando il nome della dimensione o il valore della dimensione utilizza parentesi quadre arrotondate. Eg: quando il nome della dimensione è dim (test) 1 Anziché usare $filter= "dim (test) 1 eq '' " use $filter= "dim %2528test%2529 1 eq '' " Quando il nome della dimensione è dim (test) 3 e il valore della dimensione è dim valm3 (test) Val Anziché usare $filter= "dim (test) 3 eq 'dim3 (test) val' " usare $filter = "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "**
aggregation	query		string	Elenco di tipi di aggregazione (delimitati da virgole) da recuperare.
interval	query		string duration	Intervallo (ad esempio timegrain) della query.
metricnames	query		string	Nomi delle metriche (delimitate da virgole) da recuperare. Caso speciale: se un nome metrica stesso ha una virgola in esso, usare %2 per indicare. Ad esempio: 'Metric,Name1' deve essere 'Metric%2Name1'
metricnamespace	query		string	Spazio dei nomi delle metriche per cui eseguire query sulle definizioni delle metriche.
resultType	query		ResultType	Consente di recuperare solo i metadati della baseline. Nella richiesta dati vengono recuperate tutte le informazioni.
sensitivities	query		string	Elenco di sensibilità (delimitato da virgole) da recuperare.
timespan	query		string	Intervallo di tempo della query. È una stringa con il formato seguente 'startDateTime_ISO/endDateTime_ISO'.

Risposte

Nome	Tipo	Descrizione
200 OK	MetricBaselinesResponse	Richiesta riuscita per ottenere l'elenco dei valori di base delle metriche.
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get metric baselines

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
BaselineMetadata	Rappresenta un valore di metadati di base.
BaselineSensitivity	riservatezza della baseline.
ErrorResponse	Descrive il formato della risposta all'errore.
MetricBaselinesResponse	Elenco delle baseline delle metriche.
MetricSingleDimension	Nome e valore della dimensione della metrica.
ResultType	Consente di recuperare solo i metadati della baseline. Nella richiesta dati vengono recuperate tutte le informazioni.
SingleBaseline	Valori di base per un singolo valore di riservatezza.
SingleMetricBaseline	Risultati della baseline di una singola metrica.
TimeSeriesBaseline	Valori di base per una singola serie temporale.

BaselineMetadata

Rappresenta un valore di metadati di base.

Nome	Tipo	Descrizione
name	string	Nome dei metadati di base.
value	string	Valore dei metadati di base.

BaselineSensitivity

riservatezza della baseline.

Nome	Tipo	Descrizione
High	string
Low	string
Medium	string

ErrorResponse

Descrive il formato della risposta all'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.

MetricBaselinesResponse

Elenco delle baseline delle metriche.

Nome	Tipo	Descrizione
value	SingleMetricBaseline[]	Elenco delle baseline delle metriche.

MetricSingleDimension

Nome e valore della dimensione della metrica.

Nome	Tipo	Descrizione
name	string	Nome della dimensione.
value	string	Valore della dimensione.

ResultType

Consente di recuperare solo i metadati della baseline. Nella richiesta dati vengono recuperate tutte le informazioni.

Nome	Tipo	Descrizione
Data	string
Metadata	string

SingleBaseline

Valori di base per un singolo valore di riservatezza.

Nome	Tipo	Descrizione
highThresholds	number[]	Soglie elevate della baseline.
lowThresholds	number[]	Soglie basse della baseline.
sensitivity	BaselineSensitivity	riservatezza della baseline.

SingleMetricBaseline

Risultati della baseline di una singola metrica.

Nome	Tipo	Descrizione
id	string	ID della baseline della metrica.
name	string	Nome della metrica per cui sono state recuperate le baseline.
properties.baselines	TimeSeriesBaseline[]	Baseline per ogni serie temporale che è stata eseguita una query.
properties.interval	string	Intervallo (dimensione finestra) in cui sono stati restituiti i dati delle metriche. Questo può essere modificato in futuro e restituito da ciò che è stato originariamente richiesto. Questa operazione non è presente se è stata effettuata una richiesta di metadati.
properties.namespace	string	Lo spazio dei nomi delle metriche è stato sottoposto a query.
properties.timespan	string	Intervallo di tempo per il quale sono stati recuperati i dati. Il valore è costituito da due datetime concatenate, separate da '/'. Questo può essere modificato in futuro e restituito da ciò che è stato originariamente richiesto.
type	string	Tipo di risorsa della risorsa di base della metrica.

TimeSeriesBaseline

Valori di base per una singola serie temporale.

Nome	Tipo	Descrizione
aggregation	string	Tipo di aggregazione della metrica.
data	SingleBaseline[]	Valori di base per ogni riservatezza.
dimensions	MetricSingleDimension[]	Dimensioni di questa serie temporale.
metadataValues	BaselineMetadata[]	Valori dei metadati di base.
timestamps	string[]	Elenco di timestamp delle baseline.

Condividi tramite

Baselines - List

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Get metric baselines

Esempio di richiesta

Risposta di esempio

Definizioni

BaselineMetadata

BaselineSensitivity

ErrorResponse

MetricBaselinesResponse

MetricSingleDimension

ResultType

SingleBaseline

SingleMetricBaseline

TimeSeriesBaseline

Risorse aggiuntive