Baselines - List

Service:

Monitor

API Version:

2019-03-01

Listor måttbaslinjevärdena för en resurs.

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-parametrar

Name	I	Obligatorisk	Typ	Description
resourceUri	path	True	string	Resursens identifierare.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
$filter	query		string	Den $filter används för att minska mängden måttdata som returneras. Exempel: Mått innehåller metadata A, B och C. - Returnera alla tidsserier för C där A = a1 och B = b1 eller b2 $filter=A eq 'a1' och B eq 'b1' eller B eq 'b2' och C eq '*' - Ogiltig variant: $filter=A eq 'a1' och B eq 'b1' och C eq '*' eller B = 'b2' Detta är ogiltigt eftersom den logiska operatorn eller operatorn inte kan separera två olika metadatanamn. - Returnera alla tidsserier där A = a1, B = b1 och C = c1: $filter=A eq 'a1' och B eq 'b1' och C eq 'c1' - Returnera alla tidsserier där A = a1 $filter=A eq 'a1' och B eq '' och C eq ''. Specialfall: När dimensionsnamnet eller dimensionsvärdet använder runda hakparenteser. Exempel: När dimensionsnamnet är dim (test) 1 I stället för att använda $filter= "dim (test) 1 eq '' " använd **$filter= "dim %2528test%2529 1 eq '' "** När dimensionsnamnet är dim (test) 3 och dimensionsvärdet är dim3 (test) val i stället för att använda $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "
aggregation	query		string	Listan över sammansättningstyper (kommaavgränsade) som ska hämtas.
interval	query		string duration	Intervallet (t.ex. timegrain) för frågan.
metricnames	query		string	Namnen på de mått (kommaavgränsade) som ska hämtas. Specialfall: Om ett måttnamn har ett kommatecken i sig använder du %2 för att ange det. T.ex. "Metric,Name1" ska vara "Metric%2Name1"
metricnamespace	query		string	Måttnamnrymd att fråga efter måttdefinitioner för.
resultType	query		ResultType	Tillåter endast hämtning av metadata för baslinjen. Vid databegäran hämtas all information.
sensitivities	query		string	Listan över känsligheter (kommaavgränsade) som ska hämtas.
timespan	query		string	Tidsintervallet för frågan. Det är en sträng med följande format startDateTime_ISO/endDateTime_ISO.

Svar

Name	Typ	Description
200 OK	MetricBaselinesResponse	Lyckad begäran om att hämta listan över måttbaslinjevärden.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
BaselineMetadata	Representerar ett värde för baslinjemetadata.
BaselineSensitivity	baslinjens känslighet.
ErrorResponse	Beskriver formatet för felsvar.
MetricBaselinesResponse	En lista över måttbaslinjer.
MetricSingleDimension	Måttdimensionens namn och värde.
ResultType	Tillåter endast hämtning av metadata för baslinjen. Vid databegäran hämtas all information.
SingleBaseline	Baslinjevärdena för ett enda känslighetsvärde.
SingleMetricBaseline	Baslinjeresultatet för ett enskilt mått.
TimeSeriesBaseline	Baslinjevärdena för en enskild tidsserie.

BaselineMetadata

Representerar ett värde för baslinjemetadata.

Name	Typ	Description
name	string	Namnet på baslinjemetadata.
value	string	Värdet för baslinjemetadata.

BaselineSensitivity

baslinjens känslighet.

Name	Typ	Description
High	string
Low	string
Medium	string

ErrorResponse

Beskriver formatet för felsvar.

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

MetricBaselinesResponse

En lista över måttbaslinjer.

Name	Typ	Description
value	SingleMetricBaseline[]	Listan över måttbaslinjer.

MetricSingleDimension

Måttdimensionens namn och värde.

Name	Typ	Description
name	string	Namnet på dimensionen.
value	string	Dimensionens värde.

ResultType

Tillåter endast hämtning av metadata för baslinjen. Vid databegäran hämtas all information.

Name	Typ	Description
Data	string
Metadata	string

SingleBaseline

Baslinjevärdena för ett enda känslighetsvärde.

Name	Typ	Description
highThresholds	number[]	De höga tröskelvärdena för baslinjen.
lowThresholds	number[]	De låga tröskelvärdena för baslinjen.
sensitivity	BaselineSensitivity	baslinjens känslighet.

SingleMetricBaseline

Baslinjeresultatet för ett enskilt mått.

Name	Typ	Description
id	string	Måttbaslinje-ID: t.
name	string	Namnet på måttet som baslinjerna hämtades för.
properties.baselines	TimeSeriesBaseline[]	Baslinjen för varje tidsserie som efterfrågades.
properties.interval	string	Intervallet (fönsterstorlek) som måttdata returnerades för. Detta kan justeras i framtiden och returneras från det som ursprungligen begärdes. Detta finns inte om en begäran om metadata har gjorts.
properties.namespace	string	Namnområdet för måtten har efterfrågats.
properties.timespan	string	Tidsintervallet som data hämtades för. Dess värde består av två sammanlänkade datetimes, avgränsade med "/". Detta kan justeras i framtiden och returneras från det som ursprungligen begärdes.
type	string	Resurstypen för måttbaslinjeresursen.

TimeSeriesBaseline

Baslinjevärdena för en enskild tidsserie.

Name	Typ	Description
aggregation	string	Måttets sammansättningstyp.
data	SingleBaseline[]	Baslinjevärdena för varje känslighet.
dimensions	MetricSingleDimension[]	Dimensionerna i den här tidsserien.
metadataValues	BaselineMetadata[]	Metadatavärdena för baslinjen.
timestamps	string[]	Listan över tidsstämplar för baslinjerna.