Metric Alerts - List By Subscription

Service:

Monitor

API Version:

2018-03-01

Hämta aviseringsregeldefinitioner i en prenumeration.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	MetricAlertResourceCollection	Lyckad begäran om en lista över måttaviseringar
Other Status Codes	ErrorResponse	BadRequest

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

List metric alert rules

Sample Request

HTTP

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

Java

/**
 * Samples for MetricAlerts List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
     */
    /**
     * Sample code: List metric alert rules.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listMetricAlertRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getMetricAlerts().list(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/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/2018-03-01/examples/listMetricAlert.json
func ExampleMetricAlertsClient_NewListBySubscriptionPager() {
	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.NewMetricAlertsClient().NewListBySubscriptionPager(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.MetricAlertResourceCollection = armmonitor.MetricAlertResourceCollection{
		// 	Value: []*armmonitor.MetricAlertResource{
		// 		{
		// 			Type: to.Ptr("Microsoft.Insights/metricAlerts"),
		// 			ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu"),
		// 			Location: to.Ptr("global"),
		// 			Tags: map[string]*string{
		// 				"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
		// 			},
		// 			Properties: &armmonitor.MetricAlertProperties{
		// 				Description: to.Ptr("This is the description of the rule1"),
		// 				Actions: []*armmonitor.MetricAlertAction{
		// 					{
		// 						ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
		// 						WebHookProperties: map[string]*string{
		// 							"key11": to.Ptr("value11"),
		// 							"key12": to.Ptr("value12"),
		// 						},
		// 				}},
		// 				Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
		// 					ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
		// 					AllOf: []*armmonitor.MetricCriteria{
		// 						{
		// 							Name: to.Ptr("High_CPU_80"),
		// 							CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
		// 							Dimensions: []*armmonitor.MetricDimension{
		// 							},
		// 							MetricName: to.Ptr("CustomMetric_\\Processor(_Total)\\% Processor Time"),
		// 							TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
		// 							Operator: to.Ptr(armmonitor.OperatorGreaterThan),
		// 							Threshold: to.Ptr[float64](80.5),
		// 					}},
		// 				},
		// 				Enabled: to.Ptr(true),
		// 				EvaluationFrequency: to.Ptr("Pt1m"),
		// 				Scopes: []*string{
		// 					to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
		// 					Severity: to.Ptr[int32](3),
		// 					WindowSize: to.Ptr("Pt15m"),
		// 				},
		// 			},
		// 			{
		// 				Type: to.Ptr("Microsoft.Insights/metricAlerts"),
		// 				ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu"),
		// 				Location: to.Ptr("global"),
		// 				Tags: map[string]*string{
		// 					"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
		// 				},
		// 				Properties: &armmonitor.MetricAlertProperties{
		// 					Description: to.Ptr("Med cpu alert"),
		// 					Actions: []*armmonitor.MetricAlertAction{
		// 						{
		// 							ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
		// 							WebHookProperties: map[string]*string{
		// 								"key11": to.Ptr("value11"),
		// 								"key12": to.Ptr("value12"),
		// 							},
		// 					}},
		// 					Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
		// 						ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
		// 						AllOf: []*armmonitor.MetricCriteria{
		// 							{
		// 								Name: to.Ptr("Medium_CPU_50"),
		// 								CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
		// 								Dimensions: []*armmonitor.MetricDimension{
		// 								},
		// 								MetricName: to.Ptr("CustomMetric_\\Processor(_Total)\\% Processor Time"),
		// 								TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
		// 								Operator: to.Ptr(armmonitor.OperatorGreaterThan),
		// 								Threshold: to.Ptr[float64](50.5),
		// 						}},
		// 					},
		// 					Enabled: to.Ptr(true),
		// 					EvaluationFrequency: to.Ptr("Pt1m"),
		// 					Scopes: []*string{
		// 						to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
		// 						Severity: to.Ptr[int32](4),
		// 						WindowSize: to.Ptr("Pt15m"),
		// 					},
		// 			}},
		// 		}
	}
}

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 Retrieve alert rule definitions in a subscription.
 *
 * @summary Retrieve alert rule definitions in a subscription.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
 */
async function listMetricAlertRules() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.metricAlerts.listBySubscription()) {
    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

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Monitor;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
// this example is just showing the usage of "MetricAlerts_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
string resourceGroupName = "gigtest";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this MetricAlertResource
MetricAlertCollection collection = resourceGroupResource.GetMetricAlerts();

// invoke the operation and iterate over the result
await foreach (MetricAlertResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    MetricAlertData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
      "type": "Microsoft.Insights/metricAlerts",
      "location": "global",
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      },
      "properties": {
        "description": "This is the description of the rule1",
        "severity": 3,
        "enabled": true,
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "evaluationFrequency": "Pt1m",
        "windowSize": "Pt15m",
        "criteria": {
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
          "allOf": [
            {
              "criterionType": "StaticThresholdCriterion",
              "name": "High_CPU_80",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 80.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu",
      "type": "Microsoft.Insights/metricAlerts",
      "location": "global",
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      },
      "properties": {
        "description": "Med cpu alert",
        "severity": 4,
        "enabled": true,
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "evaluationFrequency": "Pt1m",
        "windowSize": "Pt15m",
        "criteria": {
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
          "allOf": [
            {
              "criterionType": "StaticThresholdCriterion",
              "name": "Medium_CPU_50",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 50.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    }
  ]
}

Definitioner

Name	Description
AggregationTypeEnum	villkorets tidsaggregeringstyper.
DynamicMetricCriteria	Kriterium för dynamiskt tröskelvärde.
DynamicThresholdFailingPeriods	Det minsta antal överträdelser som krävs inom den valda lookback-tidsperioden som krävs för att skapa en avisering.
DynamicThresholdOperator	Operatorn som används för att jämföra måttvärdet med tröskelvärdet.
DynamicThresholdSensitivity	Den omfattning av avvikelse som krävs för att utlösa en avisering. Detta påverkar hur nära tröskelvärdet är för mönstret för måttserier.
ErrorResponse	Beskriver formatet för felsvar.
MetricAlertAction	En aviseringsåtgärd.
MetricAlertMultipleResourceMultipleMetricCriteria	Anger måttaviseringskriterierna för flera resurser som har flera måttkriterier.
MetricAlertResource	Resursen för måttavisering.
MetricAlertResourceCollection	Representerar en samling aviseringsregelresurser.
MetricAlertSingleResourceMultipleMetricCriteria	Anger måttaviseringskriterierna för en enskild resurs som har flera måttkriterier.
MetricCriteria	Kriterium för att filtrera mått.
MetricDimension	Anger en måttdimension.
Operator	villkorsoperatören.
WebtestLocationAvailabilityCriteria	Anger villkor för måttaviseringsregler för en webbtestresurs.

AggregationTypeEnum

villkorets tidsaggregeringstyper.

Name	Typ	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

DynamicMetricCriteria

Kriterium för dynamiskt tröskelvärde.

Name	Typ	Description
alertSensitivity	DynamicThresholdSensitivity	Den omfattning av avvikelse som krävs för att utlösa en avisering. Detta påverkar hur nära tröskelvärdet är för mönstret för måttserier.
criterionType	string: DynamicThresholdCriterion	Anger typ av tröskelvärde
dimensions	MetricDimension[]	Lista över dimensionsvillkor.
failingPeriods	DynamicThresholdFailingPeriods	Det minsta antal överträdelser som krävs inom den valda lookback-tidsperioden som krävs för att skapa en avisering.
ignoreDataBefore	string	Använd det här alternativet om du vill ange från vilket datum du vill börja lära dig historiska måttdata och beräkna dynamiska tröskelvärden (i ISO8601 format)
metricName	string	Namnet på måttet.
metricNamespace	string	Måttets namnområde.
name	string	Namnet på kriterierna.
operator	DynamicThresholdOperator	Operatorn som används för att jämföra måttvärdet med tröskelvärdet.
skipMetricValidation	boolean	Tillåter att du skapar en aviseringsregel för ett anpassat mått som inte har genererats än, genom att göra så att måttverifieringen hoppas över.
timeAggregation	AggregationTypeEnum	villkorets tidsaggregeringstyper.

DynamicThresholdFailingPeriods

Det minsta antal överträdelser som krävs inom den valda lookback-tidsperioden som krävs för att skapa en avisering.

Name	Typ	Description
minFailingPeriodsToAlert	number	Antalet överträdelser för att utlösa en avisering. Bör vara mindre eller lika med numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	Antalet aggregerade återblickspunkter. Lookback-tidsperioden beräknas baserat på sammansättningskornigheten (windowSize) och det valda antalet aggregerade punkter.

DynamicThresholdOperator

Operatorn som används för att jämföra måttvärdet med tröskelvärdet.

Name	Typ	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

Den omfattning av avvikelse som krävs för att utlösa en avisering. Detta påverkar hur nära tröskelvärdet är för mönstret för måttserier.

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.

MetricAlertAction

En aviseringsåtgärd.

Name	Typ	Description
actionGroupId	string	ID:t för åtgärdsgruppen som ska användas.
webHookProperties	object	Med det här fältet kan du ange anpassade egenskaper som läggs till i aviseringsnyttolasten som skickas som indata till webhooken.

MetricAlertMultipleResourceMultipleMetricCriteria

Anger måttaviseringskriterierna för flera resurser som har flera måttkriterier.

Name	Typ	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	listan över flera måttkriterier för den här "hela" åtgärden.
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	anger typen av aviseringsvillkor.

MetricAlertResource

Resursen för måttavisering.

Name	Typ	Description
id	string	Resurs-ID för Azure
location	string	Resursplats
name	string	Azure-resursnamn
properties.actions	MetricAlertAction[]	matrisen med åtgärder som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor löses.
properties.autoMitigate	boolean	flaggan som anger om aviseringen ska lösas automatiskt eller inte. Standardvärdet är true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	definierar den specifika informationen om aviseringsvillkor.
properties.description	string	beskrivningen av måttaviseringen som ska ingå i aviseringsmeddelandet.
properties.enabled	boolean	flaggan som anger om måttaviseringen är aktiverad.
properties.evaluationFrequency	string	hur ofta måttaviseringen utvärderas representeras i ISO 8601-varaktighetsformat.
properties.isMigrated	boolean	värdet som anger om den här aviseringsregeln migreras.
properties.lastUpdatedTime	string	Senaste gången regeln uppdaterades i ISO8601 format.
properties.scopes	string[]	listan över resurs-ID:t som den här måttaviseringen är begränsad till.
properties.severity	integer	Allvarlighetsgrad {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	den region för målresursen/målresurserna där aviseringen skapas/uppdateras. Obligatoriskt om omfånget innehåller en prenumeration, resursgrupp eller mer än en resurs.
properties.targetResourceType	string	resurstypen för de målresurser där aviseringen skapas/uppdateras. Obligatoriskt om omfånget innehåller en prenumeration, resursgrupp eller mer än en resurs.
properties.windowSize	string	tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet.
tags	object	Resurstaggar
type	string	Azure-resurstyp

MetricAlertResourceCollection

Representerar en samling aviseringsregelresurser.

Name	Typ	Description
value	MetricAlertResource[]	värdena för aviseringsregelresurserna.

MetricAlertSingleResourceMultipleMetricCriteria

Anger måttaviseringskriterierna för en enskild resurs som har flera måttkriterier.

Name	Typ	Description
allOf	MetricCriteria[]	Listan över måttkriterier för den här åtgärden .
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	anger typen av aviseringsvillkor.

MetricCriteria

Kriterium för att filtrera mått.

Name	Typ	Description
criterionType	string: StaticThresholdCriterion	Anger typ av tröskelvärde
dimensions	MetricDimension[]	Lista över dimensionsvillkor.
metricName	string	Namnet på måttet.
metricNamespace	string	Måttets namnområde.
name	string	Namnet på kriterierna.
operator	Operator	villkorsoperatören.
skipMetricValidation	boolean	Tillåter att du skapar en aviseringsregel för ett anpassat mått som inte har genererats än, genom att göra så att måttverifieringen hoppas över.
threshold	number	villkorströskelvärdet som aktiverar aviseringen.
timeAggregation	AggregationTypeEnum	villkorets tidsaggregeringstyper.

MetricDimension

Anger en måttdimension.

Name	Typ	Description
name	string	Namnet på dimensionen.
operator	string	dimensionsoperatorn. Endast "Inkludera" och "Exkludera" stöds
values	string[]	lista över dimensionsvärden.

Operator

villkorsoperatören.

Name	Typ	Description
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

WebtestLocationAvailabilityCriteria

Anger villkor för måttaviseringsregler för en webbtestresurs.

Name	Typ	Description
componentId	string	Application Insights-resurs-ID: t.
failedLocationCount	number	Antalet misslyckade platser.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	anger typen av aviseringsvillkor.
webTestId	string	Application Insights webbtest-ID.