Metric Alerts - List By Resource Group

Ссылка

Служба:: Monitor

Версия API:: 2018-03-01

Получение определений правил генерации оповещений в группе ресурсов.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	MetricAlertResourceCollection	Успешный запрос списка оповещений метрик
Other Status Codes	ErrorResponse	BadRequest

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List metric alert rules

Образец запроса

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


/**
 * Samples for MetricAlerts ListByResourceGroup.
 */
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().listByResourceGroup("gigtest",
            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

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

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

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

// 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_ListBySubscription" 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://video2.skills-academy.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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (MetricAlertResource item in subscriptionResource.GetMetricAlertsAsync())
{
    // 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

Пример ответа

Код состояния:: 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"
            }
          }
        ]
      }
    }
  ]
}

Определения

Имя	Описание
AggregationTypeEnum	Типы агрегирования времени условий.
DynamicMetricCriteria	Критерий динамического порога.
DynamicThresholdFailingPeriods	Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения.
DynamicThresholdOperator	Оператор, используемый для сравнения значения метрики с пороговым значением.
DynamicThresholdSensitivity	Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жесткое пороговое значение для шаблона рядов метрик.
ErrorResponse	Описывает формат ответа об ошибке.
MetricAlertAction	Действие оповещения.
MetricAlertMultipleResourceMultipleMetricCriteria	Указывает критерии генерации оповещений метрик для нескольких ресурсов, которые имеют несколько критериев метрики.
MetricAlertResource	Ресурс оповещения метрики.
MetricAlertResourceCollection	Представляет коллекцию ресурсов правил генерации оповещений.
MetricAlertSingleResourceMultipleMetricCriteria	Задает критерии оповещения о метриках для одного ресурса с несколькими критериями метрики.
MetricCriteria	Критерий для фильтрации метрик.
MetricDimension	Задает измерение метрики.
Operator	оператор условия.
WebtestLocationAvailabilityCriteria	Задает критерии правила генерации оповещений метрик для ресурса веб-теста.

AggregationTypeEnum

Типы агрегирования времени условий.

Имя	Тип	Описание
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

DynamicMetricCriteria

Критерий динамического порога.

Имя	Тип	Описание
alertSensitivity	DynamicThresholdSensitivity	Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жесткое пороговое значение для шаблона рядов метрик.
criterionType	string: DynamicThresholdCriterion	Указывает тип пороговых условий.
dimensions	MetricDimension[]	Список условий измерения.
failingPeriods	DynamicThresholdFailingPeriods	Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения.
ignoreDataBefore	string	Используйте этот параметр, чтобы задать дату, с которой следует начать изучение исторических данных метрик, и вычислить динамические пороговые значения (в ISO8601 формате).
metricName	string	Имя метрики.
metricNamespace	string	Пространство имен метрики.
name	string	Имя условия.
operator	DynamicThresholdOperator	Оператор, используемый для сравнения значения метрики с пороговым значением.
skipMetricValidation	boolean	Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики.
timeAggregation	AggregationTypeEnum	Типы агрегирования времени условий.

DynamicThresholdFailingPeriods

Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения.

Имя	Тип	Описание
minFailingPeriodsToAlert	number	Количество нарушений, которые активируют оповещение. Значение должно быть меньше или равно numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	Количество агрегированных точек обратного просмотра. Период времени просмотра рассчитывается на основе степени детализации агрегирования (windowSize) и выбранного количества агрегированных точек.

DynamicThresholdOperator

Оператор, используемый для сравнения значения метрики с пороговым значением.

Имя	Тип	Описание
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жесткое пороговое значение для шаблона рядов метрик.

Имя	Тип	Описание
High	string
Low	string
Medium	string

ErrorResponse

Описывает формат ответа об ошибке.

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

MetricAlertAction

Действие оповещения.

Имя	Тип	Описание
actionGroupId	string	идентификатор используемой группы действий.
webHookProperties	object	Это поле позволяет указать пользовательские свойства, которые будут добавлены в полезные данные оповещения, отправленные в качестве входных данных в веб-перехватчик.

MetricAlertMultipleResourceMultipleMetricCriteria

Указывает критерии генерации оповещений метрик для нескольких ресурсов, которые имеют несколько критериев метрики.

Имя	Тип	Описание
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	список нескольких критериев метрик для этой операции "все".
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	указывает тип условия оповещения.

MetricAlertResource

Ресурс оповещения метрики.

Имя	Тип	Описание
id	string	Идентификатор ресурса Azure
location	string	Расположение ресурса
name	string	Имя ресурса Azure
properties.actions	MetricAlertAction[]	массив действий, выполняемых при активации правила генерации оповещений и при разрешении условия оповещения.
properties.autoMitigate	boolean	флаг, указывающий, должно ли оповещение разрешаться автоматически. Значение по умолчанию — true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	определяет сведения о конкретных критериях оповещения.
properties.description	string	описание оповещения метрики, которое будет включено в сообщение электронной почты с оповещением.
properties.enabled	boolean	флаг, указывающий, включено ли оповещение метрики.
properties.evaluationFrequency	string	как часто оповещение метрики оценивается в формате длительности ISO 8601.
properties.isMigrated	boolean	значение, указывающее, переносится ли это правило генерации оповещений.
properties.lastUpdatedTime	string	В последний раз правило обновлялось в формате ISO8601.
properties.scopes	string[]	список идентификаторов ресурсов, к которым относится это оповещение метрики.
properties.severity	integer	Серьезность оповещения {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	регион целевых ресурсов, в которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов.
properties.targetResourceType	string	тип ресурса целевых ресурсов, для которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов.
properties.windowSize	string	период времени (в формате длительности ISO 8601), который используется для мониторинга активности оповещений на основе порогового значения.
tags	object	Теги ресурсов
type	string	Тип ресурса Azure

MetricAlertResourceCollection

Представляет коллекцию ресурсов правил генерации оповещений.

Имя	Тип	Описание
value	MetricAlertResource[]	значения для ресурсов правила генерации оповещений.

MetricAlertSingleResourceMultipleMetricCriteria

Задает критерии оповещения о метриках для одного ресурса с несколькими критериями метрики.

Имя	Тип	Описание
allOf	MetricCriteria[]	Список критериев метрик для этой операции "все".
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	указывает тип условия оповещения.

MetricCriteria

Критерий для фильтрации метрик.

Имя	Тип	Описание
criterionType	string: StaticThresholdCriterion	Указывает тип пороговых условий.
dimensions	MetricDimension[]	Список условий измерения.
metricName	string	Имя метрики.
metricNamespace	string	Пространство имен метрики.
name	string	Имя условия.
operator	Operator	оператор условия.
skipMetricValidation	boolean	Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики.
threshold	number	пороговое значение условия, которое активирует оповещение.
timeAggregation	AggregationTypeEnum	Типы агрегирования времени условий.

MetricDimension

Задает измерение метрики.

Имя	Тип	Описание
name	string	Имя измерения.
operator	string	оператор измерения. Поддерживаются только "Include" и "Exclude"
values	string[]	список значений измерения.

Operator

оператор условия.

Имя	Тип	Описание
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

WebtestLocationAvailabilityCriteria

Задает критерии правила генерации оповещений метрик для ресурса веб-теста.

Имя	Тип	Описание
componentId	string	Идентификатор ресурса Application Insights.
failedLocationCount	number	Количество неудачных расположений.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	указывает тип условия оповещения.
webTestId	string	Идентификатор веб-теста Application Insights.

Поделиться через

Metric Alerts - List By Resource Group

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

List metric alert rules

Образец запроса

Пример ответа

Определения

AggregationTypeEnum

DynamicMetricCriteria

DynamicThresholdFailingPeriods

DynamicThresholdOperator

DynamicThresholdSensitivity

ErrorResponse

MetricAlertAction

MetricAlertMultipleResourceMultipleMetricCriteria

MetricAlertResource

MetricAlertResourceCollection

MetricAlertSingleResourceMultipleMetricCriteria

MetricCriteria

MetricDimension

Operator

WebtestLocationAvailabilityCriteria

Дополнительные ресурсы