Baselines - List

Szolgáltatás:: Monitor

API-verzió:: 2019-03-01

Az erőforrás-metrika alapértékeinek felsorolása.

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

Opcionális paraméterekkel:

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-paraméterek

Name	In	Kötelező	Típus	Description
resourceUri	path	True	string	Az erőforrás azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.
$filter	query		string	A $filter a visszaadott metrikaadatok halmazának csökkentésére szolgál. Példa: A, B és C metaadatokat tartalmaz a metrika. - A C összes idősorát adja vissza, ahol A = a1 és B = b1 vagy b2 *$filter=A eq 'a1' és B eq 'b1' vagy B eq 'b2' és C eq '' - Érvénytelen változat: $filter=A eq 'a1' és B eq 'b1' és C eq '' vagy B = 'b2'* Ez érvénytelen, mert a logikai vagy operátor nem tud két különböző metaadatnevet elkülöníteni. - Adja vissza az összes idősort, ahol A = a1, B = b1 és C = c1: $filter=A eq 'a1' és B eq 'b1' és C eq 'c1' - Minden olyan idősort ad vissza, ahol A = a1 *$filter=A eq 'a1' és B eq '' és C eq ''. Speciális eset: Ha a dimenzió neve vagy dimenzióértéke kerek zárójeleket használ. Például: Ha a dimenzió neve dim (teszt) 1* Ahelyett, hogy $filter= "dim (teszt) 1 eq '' " használja $filter= "dim %2528test%2529 1 eq '" " Ha a dimenzió neve dim (teszt) 3 és dimenzióérték dim3 (teszt) val Ahelyett, hogy $filter= "dim (teszt) 3 eq "dim3 (test) val" kifejezést használjuk $filter= "dim %2528test%2529 3 eq "dim3 %2528test%2529 val"**
aggregation	query		string	A lekérendő összesítési típusok listája (vesszővel elválasztva).
interval	query		string (duration)	A lekérdezés időköze (azaz időintervalluma).
metricnames	query		string	A lekérni kívánt metrikák neve (vesszővel elválasztva). Speciális eset: Ha egy metrikanév vesszővel rendelkezik, akkor a %2 használatával jelezheti. Például: "Metric,Name1" kell "Metric%2Name1"
metricnamespace	query		string	A kért metrikaneveket tartalmazó metrikanévtér.
resultType	query		ResultType	Csak az alapkonfiguráció metaadatainak lekérését teszi lehetővé. Adatkérés esetén a rendszer minden információt lekér.
sensitivities	query		string	A lekérni kívánt bizalmasságok listája (vesszővel elválasztva).
timespan	query		string	A lekérdezés időideje. Ez egy "startDateTime_ISO/endDateTime_ISO" formátumú sztring.

Válaszok

Name	Típus	Description
200 OK	MetricBaselinesResponse	Sikeres kérés a metrika alapértékeinek listájának lekéréséhez.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get metric baselines

Mintakérelem

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python metric_baselines.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.baselines.list(
        resource_uri="subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/examples/metricBaselines.json
if __name__ == "__main__":
    main()

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

Mintaválasz

Állapotkód:: 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
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

Definíciók

Name	Description
AdditionalInfo	Objektumtömb "type" és "info" tulajdonságokkal. Az "info" séma szolgáltatásspecifikus, és a típus sztringtől függ.
BaselineMetadata	Alapszintű metaadatértéket jelöl.
BaselineSensitivity	az alapkonfiguráció érzékenysége.
Error
ErrorDetail	A hibaválasz részleteit ismerteti.
ErrorResponse	A hibaválasz formátumát ismerteti.
MetricBaselinesResponse	A metrika alapkonfigurációinak listája.
MetricSingleDimension	A metrika dimenziójának neve és értéke.
ResultType	Csak az alapkonfiguráció metaadatainak lekérését teszi lehetővé. Adatkérés esetén a rendszer minden információt lekér.
SingleBaseline	Egyetlen bizalmassági érték alapértékei.
SingleMetricBaseline	Egyetlen metrika alapkonfigurációja.
TimeSeriesBaseline	Egyetlen idősor alapértékei.

AdditionalInfo

Tárgy

Objektumtömb "type" és "info" tulajdonságokkal. Az "info" séma szolgáltatásspecifikus, és a típus sztringtől függ.

Name	Típus	Description
info	object	A típusra vonatkozó további információk.
type	string	A további információk típusa.

BaselineMetadata

Tárgy

Alapszintű metaadatértéket jelöl.

Name	Típus	Description
name	string	Az alapszintű metaadatok neve.
value	string	Az alapszintű metaadatok értéke.

BaselineSensitivity

Felsorolás

az alapkonfiguráció érzékenysége.

Érték	Description
Low
Medium
High

Error

Tárgy

Name	Típus	Description
additionalInfo	AdditionalInfo[]	Objektumtömb "type" és "info" tulajdonságokkal. Az "info" séma szolgáltatásspecifikus, és a típus sztringtől függ.
code	string	Nem áthelyezett sztring, amely a hiba programozott azonosítására használható.
details	ErrorDetail[]	További beágyazott hibaválasz-információs objektumok tömbje, a jelen szerződés szerint.
message	string	Részletesen ismerteti a hibát, és hibakeresési információkat nyújt. Ha Accept-Language van beállítva a kérelemben, az adott nyelvre kell honosítva lennie.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

ErrorDetail

Tárgy

A hibaválasz részleteit ismerteti.

Name	Típus	Description
additionalInfo	AdditionalInfo[]	Objektumtömb "type" és "info" tulajdonságokkal. Az "info" séma szolgáltatásspecifikus, és a típus sztringtől függ.
code	string	Nem áthelyezett sztring, amely a hiba programozott azonosítására használható.
message	string	Részletesen ismerteti a hibát, és hibakeresési információkat nyújt.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

ErrorResponse

Tárgy

A hibaválasz formátumát ismerteti.

Name	Típus	Description
error	Error

MetricBaselinesResponse

Tárgy

A metrika alapkonfigurációinak listája.

Name	Típus	Description
value	SingleMetricBaseline[]	A metrika alapkonfigurációinak listája.

MetricSingleDimension

Tárgy

A metrika dimenziójának neve és értéke.

Name	Típus	Description
name	string	A dimenzió neve.
value	string	A dimenzió értéke.

ResultType

Felsorolás

Csak az alapkonfiguráció metaadatainak lekérését teszi lehetővé. Adatkérés esetén a rendszer minden információt lekér.

Érték	Description
Data
Metadata

SingleBaseline

Tárgy

Egyetlen bizalmassági érték alapértékei.

Name	Típus	Description
highThresholds	number[] (double)	Az alapterv magas küszöbértékei.
lowThresholds	number[] (double)	Az alapterv alacsony küszöbértékei.
sensitivity	BaselineSensitivity	az alapkonfiguráció érzékenysége.

SingleMetricBaseline

Tárgy

Egyetlen metrika alapkonfigurációja.

Name	Típus	Description
id	string	A metrika alapkonfiguráció-azonosítója.
name	string	Annak a metrikának a neve, amelyhez az alapterveket lekérte.
properties.baselines	TimeSeriesBaseline[]	A lekérdezett idősorok alapkonfigurációja.
properties.interval	string (duration)	Az az intervallum (ablakméret), amelyben a metrikaadatokat visszaadták. Ez a jövőben módosítható, és visszatérhet az eredetileg kérttől. Ez nem jelenik meg metaadat-kérés esetén.
properties.namespace	string	A rendszer lekérdezte a metrikák névterét.
properties.timespan	string	Az az időkeret, amelyre az adatokat lekérte. Értéke két összefűzött dátum/időből áll, "/" elválasztva. Ez a jövőben módosítható, és visszatérhet az eredetileg kérttől.
type	string	A metrika alapkonfigurációs erőforrásának erőforrástípusa.

TimeSeriesBaseline

Tárgy

Egyetlen idősor alapértékei.

Name	Típus	Description
aggregation	string	A metrika összesítési típusa.
data	SingleBaseline[]	Az egyes érzékenységek alapértékei.
dimensions	MetricSingleDimension[]	Az idősor méretei.
metadataValues	BaselineMetadata[]	Az alapszintű metaadatértékek.
timestamps	string[] (date-time)	Az alaptervek időbélyegeinek listája.

Megosztás a következőn keresztül:

Baselines - List

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Get metric baselines

Mintakérelem

Mintaválasz

Definíciók

AdditionalInfo

BaselineMetadata

BaselineSensitivity

Error

ErrorDetail

ErrorResponse

MetricBaselinesResponse

MetricSingleDimension

ResultType

SingleBaseline

SingleMetricBaseline

TimeSeriesBaseline