Baselines - List

Service:: Monitor

API Version:: 2019-03-01

Lists the metric baseline values for a resource.

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?api-version=2019-03-01&metricnames={metricnames}&metricnamespace={metricnamespace}&timespan={timespan}&interval={interval}&aggregation={aggregation}&sensitivities={sensitivities}&$filter={$filter}&resultType={resultType}

URI Parameters

Name	In	Required	Type	Description
resourceUri	path	True	string	The fully qualified Azure Resource manager identifier of the resource.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	The $filter is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 *$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '' - Invalid variant: $filter=A eq 'a1' and B eq 'b1' and C eq '' or B = 'b2'* This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: $filter=A eq 'a1' and B eq 'b1' and C eq 'c1' - Return all time series where A = a1 *$filter=A eq 'a1' and B eq '' and C eq ''. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is dim (test) 1* Instead of using $filter= "dim (test) 1 eq '' " use $filter= "dim %2528test%2529 1 eq '' " When dimension name is dim (test) 3 and dimension value is dim3 (test) val Instead of using $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "**
aggregation	query		string	The list of aggregation types (comma separated) to retrieve.
interval	query		string (duration)	The interval (i.e. timegrain) of the query.
metricnames	query		string	The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be 'Metric%2Name1'
metricnamespace	query		string	Metric namespace that contains the requested metric names.
resultType	query		ResultType	Allows retrieving only metadata of the baseline. On data request all information is retrieved.
sensitivities	query		string	The list of sensitivities (comma separated) to retrieve.
timespan	query		string	The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.

Responses

Name	Type	Description
200 OK	MetricBaselinesResponse	The request has succeeded.
Other Status Codes	MetricBaselinesErrorResponse	An unexpected error response.

Security

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	impersonate your user account

Examples

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?api-version=2019-03-01&timespan=2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z&interval=PT1H&aggregation=average&sensitivities=Low,Medium

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: 2019-03-01/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: 2019-03-01/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("<subscriptionID>", 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{
		Aggregation:   to.Ptr("average"),
		Interval:      to.Ptr("PT1H"),
		Sensitivities: to.Ptr("Low,Medium"),
		Timespan:      to.Ptr("2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z")})
	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 = armmonitor.BaselinesClientListResponse{
		// 	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: 2019-03-01/metricBaselines.json
 */
async function getMetricBaselines() {
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential);
  const resArray = new Array();
  for await (const item of client.baselines.list(
    "subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1",
    {
      timespan: "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z",
      interval: "PT1H",
      aggregation: "average",
      sensitivities: "Low,Medium",
    },
  )) {
    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": [
    {
      "name": "Percentage CPU",
      "type": "microsoft.insights/metricBaselines",
      "id": "/subscriptions/11aeb0ed-456b-4ca0-8df5-b9fbdc63d0d3/resourceGroups/SmartAnalytics-DEV-VM/providers/Microsoft.Compute/virtualMachines/DemoVM1/providers/microsoft.insights/metricBaselines/Percentage CPU",
      "properties": {
        "baselines": [
          {
            "aggregation": "average",
            "data": [
              {
                "highThresholds": [
                  90.3453,
                  91.3453
                ],
                "lowThresholds": [
                  30,
                  31.1
                ],
                "sensitivity": "Low"
              },
              {
                "highThresholds": [
                  70.3453,
                  71.3453
                ],
                "lowThresholds": [
                  50,
                  51.1
                ],
                "sensitivity": "Medium"
              }
            ],
            "dimensions": [],
            "metadataValues": [
              {
                "name": "ErrorType",
                "value": "TooManyAnomalies"
              },
              {
                "name": "SeasonalityFrequency",
                "value": "288"
              }
            ],
            "timestamps": [
              "2019-03-12T11:00:00.000Z",
              "2019-03-12T12:00:00.000Z"
            ]
          }
        ],
        "interval": "PT1H",
        "namespace": "microsoft.compute/virtualmachines",
        "timespan": "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z"
      }
    }
  ]
}

Definitions

Name	Description
BaselineMetadata	Represents a baseline metadata value.
BaselineSensitivity	the sensitivity of the baseline.
MetricBaselinesErrorResponse	Describes the format of Error response.
MetricBaselinesResponse	A list of metric baselines.
MetricSingleDimension	The metric dimension name and value.
Microsoft.Common.ErrorDetail	Describes details of an error response.
Microsoft.Common.ErrorDetailAdditionalInfoItem
Microsoft.Common.ErrorResponseError
Microsoft.Common.ErrorResponseErrorAdditionalInfoItem
ResultType	Allows retrieving only metadata of the baseline. On data request all information is retrieved.
SingleBaseline	The baseline values for a single sensitivity value.
SingleMetricBaseline	The baseline results of a single metric.
TimeSeriesBaseline	The baseline values for a single time series.

BaselineMetadata

Object

Represents a baseline metadata value.

Name	Type	Description
name	string	Name of the baseline metadata.
value	string	Value of the baseline metadata.

BaselineSensitivity

Enumeration

the sensitivity of the baseline.

Value	Description
Low	Low
Medium	Medium
High	High

MetricBaselinesErrorResponse

Object

Describes the format of Error response.

Name	Type	Description
error	Microsoft.Common.ErrorResponseError

MetricBaselinesResponse

Object

A list of metric baselines.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	SingleMetricBaseline[]	The list of metric baselines.

MetricSingleDimension

Object

The metric dimension name and value.

Name	Type	Description
name	string	Name of the dimension.
value	string	Value of the dimension.

Microsoft.Common.ErrorDetail

Object

Describes details of an error response.

Name	Type	Description
additionalInfo	Microsoft.Common.ErrorDetailAdditionalInfoItem[]	An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string.
code	string	Unlocalized string which can be used to programmatically identify the error.
message	string	Describes the error in detail and provides debugging information.
target	string	The target of the particular error (for example, the name of the property in error).

Microsoft.Common.ErrorDetailAdditionalInfoItem

Object

Name	Type	Description
info	management.azure.com.monitor.baselines.list	The additional information specific to the type.
type	string	The type of additional information.

Microsoft.Common.ErrorResponseError

Object

Name	Type	Description
additionalInfo	Microsoft.Common.ErrorResponseErrorAdditionalInfoItem[]	An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string.
code	string	Unlocalized string which can be used to programmatically identify the error.
details	Microsoft.Common.ErrorDetail[]	An array of additional nested error response info objects, as described by this contract.
message	string	Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language.
target	string	The target of the particular error (for example, the name of the property in error).

Microsoft.Common.ErrorResponseErrorAdditionalInfoItem

Object

Name	Type	Description
info	management.azure.com.monitor.baselines.list	The additional information specific to the type.
type	string	The type of additional information.

ResultType

Enumeration

Allows retrieving only metadata of the baseline. On data request all information is retrieved.

Value	Description
Data	Data
Metadata	Metadata

SingleBaseline

Object

The baseline values for a single sensitivity value.

Name	Type	Description
highThresholds	number[] (double)	The high thresholds of the baseline.
lowThresholds	number[] (double)	The low thresholds of the baseline.
sensitivity	BaselineSensitivity	the sensitivity of the baseline.

SingleMetricBaseline

Object

The baseline results of a single metric.

Name	Type	Description
id	string	The metric baseline Id.
name	string	The name of the metric for which the baselines were retrieved.
properties.baselines	TimeSeriesBaseline[]	The baseline for each time series that was queried.
properties.interval	string (duration)	The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made.
properties.namespace	string	The namespace of the metrics been queried.
properties.timespan	string	The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested.
type	string	The resource type of the metric baseline resource.

TimeSeriesBaseline

Object

The baseline values for a single time series.

Name	Type	Description
aggregation	string	The aggregation type of the metric.
data	SingleBaseline[]	The baseline values for each sensitivity.
dimensions	MetricSingleDimension[]	The dimensions of this time series.
metadataValues	BaselineMetadata[]	The baseline metadata values.
timestamps	string[] (date-time)	The list of timestamps of the baselines.