Baselines - List

Service:

Monitor

API-versie:

2019-03-01

geeft een lijst weer van de metrische basislijnwaarden voor een resource.

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

Met optionele 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-parameters

Name	In	Vereist	Type	Description
resourceUri	path	True	string	De id van de resource.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	De $filter wordt gebruikt om de set metrische gegevens te verminderen die worden geretourneerd. Voorbeeld: Metrische gegevens bevatten metagegevens A, B en C. - Alle tijdreeksen van C retourneren waarbij A = a1 en B = b1 of b2 $filter=A eq 'a1' en B eq 'b1' of B eq 'b2' en C eq '*' - Ongeldige variant: $filter=A eq 'a1' en B eq 'b1' en C eq '*' of B = 'b2' Dit is ongeldig omdat de logische of operator twee verschillende metagegevensnamen niet kan scheiden. - Alle tijdreeksen retourneren waarbij A = a1, B = b1 en C = c1: $filter=A eq 'a1' en B eq 'b1' en C eq 'c1' - Alle tijdreeksen retourneren waarbij A = a1 $filter=A eq 'a1' en B eq '' en C eq ''. Speciaal geval: Wanneer de dimensienaam of dimensiewaarde ronde vierkante haken gebruikt. Bijvoorbeeld: Wanneer de dimensienaam is dim (test) 1 Gebruik in plaats van $filter= "dim (test) 1 eq "" gebruik **$filter= "dim %2528test%2529 1 eq "" "** Wanneer de dimensienaam is dim (test) 3 en dimensiewaarde is dim3 (test) val Gebruik in plaats van $filter= "dim (test) 3 eq "dim3 (test) val" gebruik $filter= "dim %2528test%2529 3 eq "dim3 %2528test%2529 val"
aggregation	query		string	De lijst met aggregatietypen (door komma's gescheiden) die moeten worden opgehaald.
interval	query		string (duration)	Het interval (bijvoorbeeld timegrain) van de query.
metricnames	query		string	De namen van de metrische gegevens (door komma's gescheiden) die moeten worden opgehaald. Speciaal geval: Als een metrische naam zelf een komma bevat, gebruikt u %2 om deze aan te geven. Bijvoorbeeld: 'Metriek,Naam1' moet worden 'Metrische%2Name1'
metricnamespace	query		string	Metrische naamruimte die de aangevraagde metrische namen bevat.
resultType	query		ResultType	Hiermee kunnen alleen metagegevens van de basislijn worden opgehaald. Op gegevensaanvraag worden alle gegevens opgehaald.
sensitivities	query		string	De lijst met vertrouwelijkheden (door komma's gescheiden) die moeten worden opgehaald.
timespan	query		string	De tijdsduur van de query. Het is een tekenreeks met de volgende notatie 'startDateTime_ISO/endDateTime_ISO'.

Antwoorden

Name	Type	Description
200 OK	MetricBaselinesResponse	Geslaagde aanvraag om de lijst met metrische basislijnwaarden op te halen.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get metric baselines

Voorbeeldaanvraag

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

Python

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

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
AdditionalInfo	Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.
BaselineMetadata	Vertegenwoordigt een basislijnmetagegevenswaarde.
BaselineSensitivity	de gevoeligheid van de basislijn.
Error
ErrorDetail	Beschrijft details van een foutreactie.
ErrorResponse	Beschrijft de indeling van foutreactie.
MetricBaselinesResponse	Een lijst met metrische basislijnen.
MetricSingleDimension	De naam en waarde van de metrische dimensie.
ResultType	Hiermee kunnen alleen metagegevens van de basislijn worden opgehaald. Op gegevensaanvraag worden alle gegevens opgehaald.
SingleBaseline	De basislijnwaarden voor één gevoeligheidswaarde.
SingleMetricBaseline	De basislijnresultaten van één metrische waarde.
TimeSeriesBaseline	De basislijnwaarden voor één tijdreeks.

AdditionalInfo

Object

Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.

Name	Type	Description
info	object	De aanvullende informatie die specifiek is voor het type.
type	string	Het type aanvullende informatie.

BaselineMetadata

Object

Vertegenwoordigt een basislijnmetagegevenswaarde.

Name	Type	Description
name	string	Naam van de metagegevens van de basislijn.
value	string	Waarde van de metagegevens van de basislijn.

BaselineSensitivity

Inventarisatie

de gevoeligheid van de basislijn.

Waarde	Description
High
Low
Medium

Error

Object

Name	Type	Description
additionalInfo	AdditionalInfo[]	Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.
code	string	Niet-gelokaliseerde tekenreeks die kan worden gebruikt om de fout programmatisch te identificeren.
details	ErrorDetail[]	Een matrix met aanvullende geneste informatieobjecten voor foutreacties, zoals beschreven in dit contract.
message	string	Hierin wordt de fout gedetailleerd beschreven en vindt u informatie over foutopsporing. Als Accept-Language is ingesteld in de aanvraag, moet deze worden gelokaliseerd naar die taal.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

ErrorDetail

Object

Beschrijft details van een foutreactie.

Name	Type	Description
additionalInfo	AdditionalInfo[]	Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.
code	string	Niet-gelokaliseerde tekenreeks die kan worden gebruikt om de fout programmatisch te identificeren.
message	string	Hierin wordt de fout gedetailleerd beschreven en vindt u informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

ErrorResponse

Object

Beschrijft de indeling van foutreactie.

Name	Type	Description
error	Error

MetricBaselinesResponse

Object

Een lijst met metrische basislijnen.

Name	Type	Description
value	SingleMetricBaseline[]	De lijst met metrische basislijnen.

MetricSingleDimension

Object

De naam en waarde van de metrische dimensie.

Name	Type	Description
name	string	Naam van de dimensie.
value	string	Waarde van de dimensie.

ResultType

Inventarisatie

Hiermee kunnen alleen metagegevens van de basislijn worden opgehaald. Op gegevensaanvraag worden alle gegevens opgehaald.

Waarde	Description
Data
Metadata

SingleBaseline

Object

De basislijnwaarden voor één gevoeligheidswaarde.

Name	Type	Description
highThresholds	number[] (double)	De hoge drempelwaarden van de basislijn.
lowThresholds	number[] (double)	De lage drempelwaarden van de basislijn.
sensitivity	BaselineSensitivity	de gevoeligheid van de basislijn.

SingleMetricBaseline

Object

De basislijnresultaten van één metrische waarde.

Name	Type	Description
id	string	De basislijn-id voor metrische gegevens.
name	string	De naam van de metrische waarde waarvoor de basislijnen zijn opgehaald.
properties.baselines	TimeSeriesBaseline[]	De basislijn voor elke tijdreeks waarop een query is uitgevoerd.
properties.interval	string (duration)	Het interval (venstergrootte) waarin de metrische gegevens zijn geretourneerd. Dit kan in de toekomst worden aangepast en geretourneerd van wat oorspronkelijk is aangevraagd. Dit is niet aanwezig als er een metagegevensaanvraag is ingediend.
properties.namespace	string	Er is een query uitgevoerd op de naamruimte van de metrische gegevens.
properties.timespan	string	De periode waarvoor de gegevens zijn opgehaald. De waarde bestaat uit twee datum/tijd-samenvoeging, gescheiden door '/'. Dit kan in de toekomst worden aangepast en geretourneerd van wat oorspronkelijk is aangevraagd.
type	string	Het resourcetype van de metrische basislijnresource.

TimeSeriesBaseline

Object

De basislijnwaarden voor één tijdreeks.

Name	Type	Description
aggregation	string	Het aggregatietype van de metrische waarde.
data	SingleBaseline[]	De basislijnwaarden voor elke gevoeligheid.
dimensions	MetricSingleDimension[]	De dimensies van deze tijdreeks.
metadataValues	BaselineMetadata[]	De metagegevenswaarden van de basislijn.
timestamps	string[] (date-time)	De lijst met tijdstempels van de basislijnen.