Metric Alerts - List By Resource Group

Service:

Monitor

API Version:

2018-03-01

Načtení definic pravidel upozornění ve skupině prostředků

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	MetricAlertResourceCollection	Úspěšná žádost o seznam upozornění na metriky
Other Status Codes	ErrorResponse	BadRequest

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List metric alert rules

Sample Request

HTTP

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/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"
            }
          }
        ]
      }
    }
  ]
}

Definice

Name	Description
AggregationTypeEnum	typy časové agregace kritérií.
DynamicMetricCriteria	Kritérium pro dynamickou prahovou hodnotu
DynamicThresholdFailingPeriods	Minimální počet porušení požadovaných ve vybraném časovém intervalu doby zpětného vyhledávání, který je nutný k vyvolání výstrahy.
DynamicThresholdOperator	Operátor použitý k porovnání hodnoty metriky s prahovou hodnotou.
DynamicThresholdSensitivity	Rozsah odchylky vyžadovaný k aktivaci výstrahy. To bude mít vliv na to, jak je prahová hodnota pro vzor řady metrik těsná.
ErrorResponse	Popisuje formát chybové odpovědi.
MetricAlertAction	Akce upozornění.
MetricAlertMultipleResourceMultipleMetricCriteria	Určuje kritéria upozornění na metriku pro více prostředků, které mají více kritérií metrik.
MetricAlertResource	Prostředek upozornění na metriku.
MetricAlertResourceCollection	Představuje kolekci prostředků pravidla upozornění.
MetricAlertSingleResourceMultipleMetricCriteria	Určuje kritéria upozornění na metriku pro jeden prostředek, který má více kritérií metrik.
MetricCriteria	Kritérium pro filtrování metrik
MetricDimension	Určuje dimenzi metriky.
Operator	operátor kritéria.
WebtestLocationAvailabilityCriteria	Určuje kritéria pravidla upozornění na metriku pro prostředek webového testu.

AggregationTypeEnum

typy časové agregace kritérií.

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

DynamicMetricCriteria

Kritérium pro dynamickou prahovou hodnotu

Name	Typ	Description
alertSensitivity	DynamicThresholdSensitivity	Rozsah odchylky vyžadovaný k aktivaci výstrahy. To bude mít vliv na to, jak je prahová hodnota pro vzor řady metrik těsná.
criterionType	string: DynamicThresholdCriterion	Určuje typ prahových kritérií.
dimensions	MetricDimension[]	Seznam podmínek dimenze
failingPeriods	DynamicThresholdFailingPeriods	Minimální počet porušení požadovaných ve vybraném časovém intervalu doby zpětného vyhledávání, který je nutný k vyvolání výstrahy.
ignoreDataBefore	string	Tato možnost slouží k nastavení data, od kterého se chcete začít učit historická data metrik a vypočítat dynamické prahové hodnoty (ve formátu ISO8601).
metricName	string	Název metriky
metricNamespace	string	Obor názvů metriky.
name	string	Název kritérií
operator	DynamicThresholdOperator	Operátor použitý k porovnání hodnoty metriky s prahovou hodnotou.
skipMetricValidation	boolean	Možnost vytvořit pravidlo výstrahy pro vlastní metriku, která ještě nebyla vygenerována, přeskočením ověření metriky
timeAggregation	AggregationTypeEnum	typy časové agregace kritérií.

DynamicThresholdFailingPeriods

Minimální počet porušení požadovaných ve vybraném časovém intervalu doby zpětného vyhledávání, který je nutný k vyvolání výstrahy.

Name	Typ	Description
minFailingPeriodsToAlert	number	Počet porušení pro aktivaci výstrahy Měl by být menší nebo roven hodnotě numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	Počet agregovaných bodů zpětného vyhledávání. Časové období zpětného vyhledávání se počítá na základě agregační členitosti (windowSize) a vybraného počtu agregovaných bodů.

DynamicThresholdOperator

Operátor použitý k porovnání hodnoty metriky s prahovou hodnotou.

Name	Typ	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

Rozsah odchylky vyžadovaný k aktivaci výstrahy. To bude mít vliv na to, jak je prahová hodnota pro vzor řady metrik těsná.

Name	Typ	Description
High	string
Low	string
Medium	string

ErrorResponse

Popisuje formát chybové odpovědi.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

MetricAlertAction

Akce upozornění.

Name	Typ	Description
actionGroupId	string	ID skupiny akcí, kterou chcete použít.
webHookProperties	object	Toto pole umožňuje zadat vlastní vlastnosti, které by se připojily k datové části upozornění odeslané jako vstup do webhooku.

MetricAlertMultipleResourceMultipleMetricCriteria

Určuje kritéria upozornění na metriku pro více prostředků, které mají více kritérií metrik.

Name	Typ	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	seznam více kritérií metrik pro tuto operaci "all of".
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	určuje typ kritérií upozornění.

MetricAlertResource

Prostředek upozornění na metriku.

Name	Typ	Description
id	string	ID prostředku Azure
location	string	Umístění prostředku
name	string	Název prostředku Azure
properties.actions	MetricAlertAction[]	pole akcí, které se provádějí, když se pravidlo upozornění aktivuje a kdy se vyřeší podmínka upozornění.
properties.autoMitigate	boolean	příznak, který označuje, jestli má být výstraha automaticky vyřešena, nebo ne. Výchozí hodnota je true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	definuje konkrétní informace o kritériích upozornění.
properties.description	string	popis upozornění na metriku, které bude součástí e-mailu s upozorněním.
properties.enabled	boolean	příznak označující, jestli je upozornění na metriku povolené.
properties.evaluationFrequency	string	jak často se upozornění na metriku vyhodnocuje ve formátu doby trvání ISO 8601.
properties.isMigrated	boolean	hodnota označující, jestli je toto pravidlo upozornění migrováno.
properties.lastUpdatedTime	string	Čas poslední aktualizace pravidla ve formátu ISO8601
properties.scopes	string[]	seznam ID prostředku, na který je toto upozornění na metriku vymezeno.
properties.severity	integer	Závažnost upozornění {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	oblast cílových prostředků, pro které je výstraha vytvořena nebo aktualizována. Povinné, pokud obor obsahuje předplatné, skupinu prostředků nebo více než jeden prostředek.
properties.targetResourceType	string	typ prostředku cílových prostředků, pro které je výstraha vytvořena nebo aktualizována. Povinné, pokud obor obsahuje předplatné, skupinu prostředků nebo více než jeden prostředek.
properties.windowSize	string	časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity upozornění na základě prahové hodnoty.
tags	object	Značky prostředků
type	string	Typ prostředku Azure

MetricAlertResourceCollection

Představuje kolekci prostředků pravidla upozornění.

Name	Typ	Description
value	MetricAlertResource[]	hodnoty pro prostředky pravidla upozornění.

MetricAlertSingleResourceMultipleMetricCriteria

Určuje kritéria upozornění na metriku pro jeden prostředek, který má více kritérií metrik.

Name	Typ	Description
allOf	MetricCriteria[]	Seznam kritérií metrik pro tuto operaci "all of".
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	určuje typ kritérií upozornění.

MetricCriteria

Kritérium pro filtrování metrik

Name	Typ	Description
criterionType	string: StaticThresholdCriterion	Určuje typ prahových kritérií.
dimensions	MetricDimension[]	Seznam podmínek dimenze
metricName	string	Název metriky
metricNamespace	string	Obor názvů metriky.
name	string	Název kritérií
operator	Operator	operátor kritéria.
skipMetricValidation	boolean	Možnost vytvořit pravidlo výstrahy pro vlastní metriku, která ještě nebyla vygenerována, přeskočením ověření metriky
threshold	number	prahová hodnota kritéria, která aktivuje výstrahu.
timeAggregation	AggregationTypeEnum	typy časové agregace kritérií.

MetricDimension

Určuje dimenzi metriky.

Name	Typ	Description
name	string	Název dimenze.
operator	string	operátor dimenze. Podporují se jenom možnosti Zahrnout a Vyloučit.
values	string[]	seznam hodnot dimenzí.

Operator

operátor kritéria.

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

WebtestLocationAvailabilityCriteria

Určuje kritéria pravidla upozornění na metriku pro prostředek webového testu.

Name	Typ	Description
componentId	string	ID prostředku Application Insights.
failedLocationCount	number	Počet neúspěšných umístění.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	určuje typ kritérií upozornění.
webTestId	string	ID testu webu Application Insights