Alert Processing Rules - List By Subscription

Referencia

Servicio:: Monitor

Versión de la API:: 2021-08-08

Enumera todas las reglas de procesamiento de alertas de una suscripción.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/actionRules?api-version=2021-08-08

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	api-version	Versión de API del cliente.

Respuestas

Nombre	Tipo	Description
200 OK	AlertProcessingRulesList	Aceptar. Devuelve la lista de reglas de procesamiento de alertas. Encabezados x-ms-request-id: string
Other Status Codes	errorResponse	Respuesta de error que describe el motivo del error de la operación.

Nombre

Tipo

Description

200 OK

AlertProcessingRulesList

Aceptar. Devuelve la lista de reglas de procesamiento de alertas.

Encabezados

x-ms-request-id: string

Other Status Codes

errorResponse

Respuesta de error que describe el motivo del error de la operación.

Ejemplos

GetAlertProcessingRulesSubscriptionWide

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/actionRules?api-version=2021-08-08

import com.azure.core.util.Context;

/** Samples for AlertProcessingRules List. */
public final class Main {
    /*
     * x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/AlertProcessingRules_List_Subscription.json
     */
    /**
     * Sample code: GetAlertProcessingRulesSubscriptionWide.
     *
     * @param manager Entry point to AlertsManagementManager.
     */
    public static void getAlertProcessingRulesSubscriptionWide(
        com.azure.resourcemanager.alertsmanagement.AlertsManagementManager manager) {
        manager.alertProcessingRules().list(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

from azure.identity import DefaultAzureCredential
from azure.mgmt.alertsmanagement import AlertsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-alertsmanagement
# USAGE
    python alert_processing_rules_list_subscription.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 = AlertsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="1e3ff1c0-771a-4119-a03b-be82a51e232d",
    )

    response = client.alert_processing_rules.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/AlertProcessingRules_List_Subscription.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 armalertsmanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/alertsmanagement/armalertsmanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/6d2438481021a94793b07b226df06d5f3c61d51d/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/AlertProcessingRules_List_Subscription.json
func ExampleAlertProcessingRulesClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armalertsmanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAlertProcessingRulesClient().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.AlertProcessingRulesList = armalertsmanagement.AlertProcessingRulesList{
		// 	Value: []*armalertsmanagement.AlertProcessingRule{
		// 		{
		// 			Name: to.Ptr("DailySuppression"),
		// 			Type: to.Ptr("Microsoft.AlertsManagement/actionRules"),
		// 			ID: to.Ptr("/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression"),
		// 			Location: to.Ptr("Global"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armalertsmanagement.AlertProcessingRuleProperties{
		// 				Description: to.Ptr("Alert processing rule on resource group for daily suppression"),
		// 				Actions: []armalertsmanagement.ActionClassification{
		// 					&armalertsmanagement.RemoveAllActionGroups{
		// 						ActionType: to.Ptr(armalertsmanagement.ActionTypeRemoveAllActionGroups),
		// 				}},
		// 				Conditions: []*armalertsmanagement.Condition{
		// 					{
		// 						Field: to.Ptr(armalertsmanagement.FieldSeverity),
		// 						Operator: to.Ptr(armalertsmanagement.OperatorEquals),
		// 						Values: []*string{
		// 							to.Ptr("Sev0"),
		// 							to.Ptr("Sev2")},
		// 						},
		// 						{
		// 							Field: to.Ptr(armalertsmanagement.FieldMonitorService),
		// 							Operator: to.Ptr(armalertsmanagement.OperatorEquals),
		// 							Values: []*string{
		// 								to.Ptr("Platform"),
		// 								to.Ptr("Application Insights")},
		// 							},
		// 							{
		// 								Field: to.Ptr(armalertsmanagement.FieldTargetResourceType),
		// 								Operator: to.Ptr(armalertsmanagement.OperatorNotEquals),
		// 								Values: []*string{
		// 									to.Ptr("Microsoft.Compute/VirtualMachines")},
		// 							}},
		// 							Enabled: to.Ptr(true),
		// 							Schedule: &armalertsmanagement.Schedule{
		// 								EffectiveFrom: to.Ptr("2018-01-10T22:05:09"),
		// 								EffectiveUntil: to.Ptr("2018-12-10T22:05:09"),
		// 								Recurrences: []armalertsmanagement.RecurrenceClassification{
		// 									&armalertsmanagement.DailyRecurrence{
		// 										EndTime: to.Ptr("14:00:00"),
		// 										RecurrenceType: to.Ptr(armalertsmanagement.RecurrenceTypeDaily),
		// 										StartTime: to.Ptr("06:00:00"),
		// 								}},
		// 								TimeZone: to.Ptr("Pacific Standard Time"),
		// 							},
		// 							Scopes: []*string{
		// 								to.Ptr("/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg")},
		// 							},
		// 							SystemData: &armalertsmanagement.SystemData{
		// 								CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T22:05:09.000Z"); return t}()),
		// 								CreatedBy: to.Ptr("abc@microsoft.com"),
		// 								CreatedByType: to.Ptr(armalertsmanagement.CreatedByTypeUser),
		// 								LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T22:05:09.000Z"); return t}()),
		// 								LastModifiedBy: to.Ptr("xyz@microsoft.com"),
		// 								LastModifiedByType: to.Ptr(armalertsmanagement.CreatedByTypeUser),
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("WeeklySuppression"),
		// 							Type: to.Ptr("Microsoft.AlertsManagement/actionRules"),
		// 							ID: to.Ptr("/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression"),
		// 							Location: to.Ptr("Global"),
		// 							Tags: map[string]*string{
		// 							},
		// 							Properties: &armalertsmanagement.AlertProcessingRuleProperties{
		// 								Description: to.Ptr("Alert processing rule on resource group for adding action group"),
		// 								Actions: []armalertsmanagement.ActionClassification{
		// 									&armalertsmanagement.AddActionGroups{
		// 										ActionType: to.Ptr(armalertsmanagement.ActionTypeAddActionGroups),
		// 										ActionGroupIDs: []*string{
		// 											to.Ptr("actiongGroup1")},
		// 									}},
		// 									Conditions: []*armalertsmanagement.Condition{
		// 										{
		// 											Field: to.Ptr(armalertsmanagement.FieldMonitorCondition),
		// 											Operator: to.Ptr(armalertsmanagement.OperatorEquals),
		// 											Values: []*string{
		// 												to.Ptr("Fired")},
		// 											},
		// 											{
		// 												Field: to.Ptr(armalertsmanagement.FieldDescription),
		// 												Operator: to.Ptr(armalertsmanagement.OperatorContains),
		// 												Values: []*string{
		// 													to.Ptr("Percentage CPU greater than 80%"),
		// 													to.Ptr("Metric alert on resource foo")},
		// 											}},
		// 											Enabled: to.Ptr(true),
		// 											Scopes: []*string{
		// 												to.Ptr("/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.Compute/VirtualMachines/testResource")},
		// 											},
		// 											SystemData: &armalertsmanagement.SystemData{
		// 												CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T22:05:09.000Z"); return t}()),
		// 												CreatedBy: to.Ptr("abc@microsoft.com"),
		// 												CreatedByType: to.Ptr(armalertsmanagement.CreatedByTypeUser),
		// 												LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-12T22:05:09.000Z"); return t}()),
		// 												LastModifiedBy: to.Ptr("xyz@microsoft.com"),
		// 												LastModifiedByType: to.Ptr(armalertsmanagement.CreatedByTypeUser),
		// 											},
		// 									}},
		// 								}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

// Generated from example definition: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/AlertProcessingRules_List_Subscription.json
// this example is just showing the usage of "AlertProcessingRules_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://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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "1e3ff1c0-771a-4119-a03b-be82a51e232d";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

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

Respuesta de muestra

status code:: 200

{
  "nextLink": "https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/actionRules?api-version=2021-08-08&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1",
  "value": [
    {
      "systemData": {
        "createdBy": "abc@microsoft.com",
        "createdByType": "User",
        "createdAt": "2018-06-12T22:05:09Z",
        "lastModifiedBy": "xyz@microsoft.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2018-06-12T22:05:09Z"
      },
      "properties": {
        "scopes": [
          "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg"
        ],
        "conditions": [
          {
            "field": "Severity",
            "operator": "Equals",
            "values": [
              "Sev0",
              "Sev2"
            ]
          },
          {
            "field": "MonitorService",
            "operator": "Equals",
            "values": [
              "Platform",
              "Application Insights"
            ]
          },
          {
            "field": "TargetResourceType",
            "operator": "NotEquals",
            "values": [
              "Microsoft.Compute/VirtualMachines"
            ]
          }
        ],
        "schedule": {
          "effectiveFrom": "2018-01-10T22:05:09",
          "effectiveUntil": "2018-12-10T22:05:09",
          "timeZone": "Pacific Standard Time",
          "recurrences": [
            {
              "recurrenceType": "Daily",
              "startTime": "06:00:00",
              "endTime": "14:00:00"
            }
          ]
        },
        "actions": [
          {
            "actionType": "RemoveAllActionGroups"
          }
        ],
        "description": "Alert processing rule on resource group for daily suppression",
        "enabled": true
      },
      "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression",
      "type": "Microsoft.AlertsManagement/actionRules",
      "name": "DailySuppression",
      "location": "Global",
      "tags": {}
    },
    {
      "systemData": {
        "createdBy": "abc@microsoft.com",
        "createdByType": "User",
        "createdAt": "2018-06-12T22:05:09Z",
        "lastModifiedBy": "xyz@microsoft.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2018-06-12T22:05:09Z"
      },
      "properties": {
        "scopes": [
          "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.Compute/VirtualMachines/testResource"
        ],
        "conditions": [
          {
            "field": "MonitorCondition",
            "operator": "Equals",
            "values": [
              "Fired"
            ]
          },
          {
            "field": "Description",
            "operator": "Contains",
            "values": [
              "Percentage CPU greater than 80%",
              "Metric alert on resource foo"
            ]
          }
        ],
        "description": "Alert processing rule on resource group for adding action group",
        "enabled": true,
        "actions": [
          {
            "actionType": "AddActionGroups",
            "actionGroupIds": [
              "actiongGroup1"
            ]
          }
        ]
      },
      "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression",
      "type": "Microsoft.AlertsManagement/actionRules",
      "name": "WeeklySuppression",
      "location": "Global",
      "tags": {}
    }
  ]
}

Definiciones

Nombre	Description
AddActionGroups	Agregue grupos de acciones a la regla de procesamiento de alertas.
AlertProcessingRule	Objeto de regla de procesamiento de alertas que contiene ámbitos de destino, condiciones y lógica de programación.
AlertProcessingRuleProperties	Propiedades de reglas de procesamiento de alertas que definen ámbitos, condiciones y lógica de programación para la regla de procesamiento de alertas.
AlertProcessingRulesList	Lista de reglas de procesamiento de alertas.
api-version	Versión de API del cliente.
Condition	Condición para desencadenar una regla de procesamiento de alertas.
createdByType	Tipo de identidad que creó el recurso.
DailyRecurrence	Objeto de periodicidad diaria.
DaysOfWeek	Días de la semana.
errorResponse	Respuesta de error del servicio.
errorResponseBody	Detalles de la respuesta de error.
Field	Campo para una condición determinada.
MonthlyRecurrence	Objeto de periodicidad mensual.
Operator	Operador para una condición determinada.
RemoveAllActionGroups	Indica si se deben quitar todos los grupos de acciones.
Schedule	Programación de la configuración de una regla de procesamiento de alertas determinada.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
WeeklyRecurrence	Objeto de periodicidad semanal.

AddActionGroups

Agregue grupos de acciones a la regla de procesamiento de alertas.

Nombre	Tipo	Description
actionGroupIds	string[]	Lista de identificadores de grupo de acciones que se van a agregar a la regla de procesamiento de alertas.
actionType	string: AddActionGroups	Acción que se debe aplicar.

AlertProcessingRule

Objeto de regla de procesamiento de alertas que contiene ámbitos de destino, condiciones y lógica de programación.

Nombre	Tipo	Description
id	string	Identificador de recurso de Azure
location	string	Ubicación de los recursos
name	string	Nombre de recurso de Azure
properties	AlertProcessingRuleProperties	Propiedades de la regla de procesamiento de alertas.
systemData	systemData	Datos del sistema de reglas de procesamiento de alertas.
tags	object	Etiquetas del recurso
type	string	Tipo de recurso de Azure

AlertProcessingRuleProperties

Propiedades de reglas de procesamiento de alertas que definen ámbitos, condiciones y lógica de programación para la regla de procesamiento de alertas.

Nombre	Tipo	Valor predeterminado	Description
actions	Action[]: AddActionGroups[] RemoveAllActionGroups[]		Acciones que se van a aplicar.
conditions	Condition[]		Condiciones en las que se filtrarán las alertas.
description	string		Descripción de la regla de procesamiento de alertas.
enabled	boolean	True	Indica si la regla de procesamiento de alertas especificada está habilitada o deshabilitada.
schedule	Schedule		Programación de la regla de procesamiento de alertas.
scopes	string[]		Ámbitos en los que se aplicará la regla de procesamiento de alertas.

AlertProcessingRulesList

Lista de reglas de procesamiento de alertas.

Nombre	Tipo	Description
nextLink	string	Dirección URL para capturar el siguiente conjunto de reglas de procesamiento de alertas.
value	AlertProcessingRule[]	Lista de reglas de procesamiento de alertas.

api-version

Versión de API del cliente.

Nombre	Tipo	Description
2021-08-08	string

Condition

Condición para desencadenar una regla de procesamiento de alertas.

Nombre	Tipo	Description
field	Field	Campo para una condición determinada.
operator	Operator	Operador para una condición determinada.
values	string[]	Lista de valores que deben coincidir con una condición determinada.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DailyRecurrence

Objeto de periodicidad diaria.

Nombre	Tipo	Description
endTime	string	Hora de finalización de la periodicidad.
recurrenceType	string: Daily	Especifica cuándo se debe aplicar la periodicidad.
startTime	string	Hora de inicio para la periodicidad.

DaysOfWeek

Días de la semana.

Nombre	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

errorResponse

Respuesta de error del servicio.

Nombre	Tipo	Description
error	errorResponseBody	Detalles de la respuesta de error.

errorResponseBody

Detalles de la respuesta de error.

Nombre	Tipo	Description
code	string	Código de error, diseñado para consumirse mediante programación.
details	errorResponseBody[]	Lista de detalles adicionales sobre el error.
message	string	Descripción del error, destinado a mostrarse en la interfaz de usuario.
target	string	Destino del error concreto, por ejemplo nombre de la propiedad.

Field

Campo para una condición determinada.

Nombre	Tipo	Description
AlertContext	string
AlertRuleId	string
AlertRuleName	string
Description	string
MonitorCondition	string
MonitorService	string
Severity	string
SignalType	string
TargetResource	string
TargetResourceGroup	string
TargetResourceType	string

MonthlyRecurrence

Objeto de periodicidad mensual.

Nombre	Tipo	Description
daysOfMonth	integer[]	Especifica los valores para el patrón de periodicidad mensual.
endTime	string	Hora de finalización de la periodicidad.
recurrenceType	string: Monthly	Especifica cuándo se debe aplicar la periodicidad.
startTime	string	Hora de inicio para la periodicidad.

Operator

Operador para una condición determinada.

Nombre	Tipo	Description
Contains	string
DoesNotContain	string
Equals	string
NotEquals	string

RemoveAllActionGroups

Indica si se deben quitar todos los grupos de acciones.

Nombre	Tipo	Description
actionType	string: RemoveAllActionGroups	Acción que se debe aplicar.

Schedule

Programación de la configuración de una regla de procesamiento de alertas determinada.

Nombre	Tipo	Description
effectiveFrom	string	La programación es efectiva desde el momento. Date-Time en formato ISO-8601 sin sufijo de zona horaria.
effectiveUntil	string	Programación efectiva hasta el momento. Date-Time en formato ISO-8601 sin sufijo de zona horaria.
recurrences	Recurrence[]: DailyRecurrence[] MonthlyRecurrence[] WeeklyRecurrence[]	Lista de periodicidades.
timeZone	string	Zona horaria de programación.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

WeeklyRecurrence

Objeto de periodicidad semanal.

Nombre	Tipo	Description
daysOfWeek	DaysOfWeek[]	Especifica los valores para el patrón de periodicidad semanal.
endTime	string	Hora de finalización de la periodicidad.
recurrenceType	string: Weekly	Especifica cuándo se debe aplicar la periodicidad.
startTime	string	Hora de inicio para la periodicidad.

Compartir a través de

Alert Processing Rules - List By Subscription

Parámetros de identificador URI

Respuestas

Ejemplos

GetAlertProcessingRulesSubscriptionWide

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AddActionGroups

AlertProcessingRule

AlertProcessingRuleProperties

AlertProcessingRulesList

api-version

Condition

createdByType

DailyRecurrence

DaysOfWeek

errorResponse

errorResponseBody

Field

MonthlyRecurrence

Operator

RemoveAllActionGroups

Schedule

systemData

WeeklyRecurrence

Recursos adicionales