Alert Processing Rules - Get By Name

Service:

Monitor

API Version:

2021-08-08

Get an alert processing rule by name.

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

URI Parameters

Name	In	Required	Type	Description
alertProcessingRuleName	path	True	string	The name of the alert processing rule that needs to be fetched.
resourceGroupName	path	True	string	Resource group name where the resource is created.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	api-version	Client API version.

Responses

Name	Type	Description
200 OK	AlertProcessingRule	OK. Returns the specific alert processing rule. Headers x-ms-request-id: string
Other Status Codes	errorResponse	Error response describing why the operation failed.

Examples

GetAlertProcessingRuleById

Sample request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for AlertProcessingRules GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/examples/AlertProcessingRules_GetById.json
     */
    /**
     * Sample code: GetAlertProcessingRuleById.
     *
     * @param manager Entry point to AlertsManagementManager.
     */
    public static void getAlertProcessingRuleById(
        com.azure.resourcemanager.alertsmanagement.AlertsManagementManager manager) {
        manager
            .alertProcessingRules()
            .getByResourceGroupWithResponse("alertscorrelationrg", "DailySuppression", 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

Python

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_get_by_id.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.get_by_name(
        resource_group_name="alertscorrelationrg",
        alert_processing_rule_name="DailySuppression",
    )
    print(response)


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

Go

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_GetById.json
func ExampleAlertProcessingRulesClient_GetByName() {
	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)
	}
	res, err := clientFactory.NewAlertProcessingRulesClient().GetByName(ctx, "alertscorrelationrg", "DailySuppression", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AlertProcessingRule = 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 and weekly scheduling"),
	// 		Actions: []armalertsmanagement.ActionClassification{
	// 			&armalertsmanagement.AddActionGroups{
	// 				ActionType: to.Ptr(armalertsmanagement.ActionTypeAddActionGroups),
	// 				ActionGroupIDs: []*string{
	// 					to.Ptr("actiongGroup1"),
	// 					to.Ptr("actiongGroup2")},
	// 			}},
	// 			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.FieldMonitorCondition),
	// 							Operator: to.Ptr(armalertsmanagement.OperatorEquals),
	// 							Values: []*string{
	// 								to.Ptr("Fired")},
	// 							},
	// 							{
	// 								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"),
	// 									},
	// 									&armalertsmanagement.WeeklyRecurrence{
	// 										EndTime: to.Ptr("20:00:00"),
	// 										RecurrenceType: to.Ptr(armalertsmanagement.RecurrenceTypeWeekly),
	// 										StartTime: to.Ptr("10:00:00"),
	// 										DaysOfWeek: []*armalertsmanagement.DaysOfWeek{
	// 											to.Ptr(armalertsmanagement.DaysOfWeekSaturday),
	// 											to.Ptr(armalertsmanagement.DaysOfWeekSunday)},
	// 									}},
	// 									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),
	// 								},
	// 							}
}

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 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_GetById.json
// this example is just showing the usage of "AlertProcessingRules_GetByName" 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 = "1e3ff1c0-771a-4119-a03b-be82a51e232d";
string resourceGroupName = "alertscorrelationrg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AlertProcessingRuleResource
AlertProcessingRuleCollection collection = resourceGroupResource.GetAlertProcessingRules();

// invoke the operation
string alertProcessingRuleName = "DailySuppression";
NullableResponse<AlertProcessingRuleResource> response = await collection.GetIfExistsAsync(alertProcessingRuleName);
AlertProcessingRuleResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

{
  "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression",
  "type": "Microsoft.AlertsManagement/actionRules",
  "name": "DailySuppression",
  "location": "Global",
  "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": "MonitorCondition",
        "operator": "Equals",
        "values": [
          "Fired"
        ]
      },
      {
        "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"
        },
        {
          "recurrenceType": "Weekly",
          "startTime": "10:00:00",
          "endTime": "20:00:00",
          "daysOfWeek": [
            "Saturday",
            "Sunday"
          ]
        }
      ]
    },
    "actions": [
      {
        "actionType": "AddActionGroups",
        "actionGroupIds": [
          "actiongGroup1",
          "actiongGroup2"
        ]
      }
    ],
    "description": "Alert processing rule on resource group for daily and weekly scheduling",
    "enabled": true
  },
  "tags": {}
}

Definitions

Name	Description
AddActionGroups	Add action groups to alert processing rule.
AlertProcessingRule	Alert processing rule object containing target scopes, conditions and scheduling logic.
AlertProcessingRuleProperties	Alert processing rule properties defining scopes, conditions and scheduling logic for alert processing rule.
api-version	Client API version.
Condition	Condition to trigger an alert processing rule.
createdByType	The type of identity that created the resource.
DailyRecurrence	Daily recurrence object.
DaysOfWeek	Days of week.
errorResponse	An error response from the service.
errorResponseBody	Details of error response.
Field	Field for a given condition.
MonthlyRecurrence	Monthly recurrence object.
Operator	Operator for a given condition.
RemoveAllActionGroups	Indicates if all action groups should be removed.
Schedule	Scheduling configuration for a given alert processing rule.
systemData	Metadata pertaining to creation and last modification of the resource.
WeeklyRecurrence	Weekly recurrence object.

AddActionGroups

Add action groups to alert processing rule.

Name	Type	Description
actionGroupIds	string[]	List of action group Ids to add to alert processing rule.
actionType	string: AddActionGroups	Action that should be applied.

AlertProcessingRule

Alert processing rule object containing target scopes, conditions and scheduling logic.

Name	Type	Description
id	string	Azure resource Id
location	string	Resource location
name	string	Azure resource name
properties	AlertProcessingRuleProperties	Alert processing rule properties.
systemData	systemData	Alert processing rule system data.
tags	object	Resource tags
type	string	Azure resource type

AlertProcessingRuleProperties

Alert processing rule properties defining scopes, conditions and scheduling logic for alert processing rule.

Name	Type	Default value	Description
actions	Action[]: AddActionGroups[] RemoveAllActionGroups[]		Actions to be applied.
conditions	Condition[]		Conditions on which alerts will be filtered.
description	string		Description of alert processing rule.
enabled	boolean	True	Indicates if the given alert processing rule is enabled or disabled.
schedule	Schedule		Scheduling for alert processing rule.
scopes	string[]		Scopes on which alert processing rule will apply.

api-version

Client API version.

Name	Type	Description
2021-08-08	string

Condition

Condition to trigger an alert processing rule.

Name	Type	Description
field	Field	Field for a given condition.
operator	Operator	Operator for a given condition.
values	string[]	List of values to match for a given condition.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DailyRecurrence

Daily recurrence object.

Name	Type	Description
endTime	string	End time for recurrence.
recurrenceType	string: Daily	Specifies when the recurrence should be applied.
startTime	string	Start time for recurrence.

DaysOfWeek

Days of week.

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

errorResponse

An error response from the service.

Name	Type	Description
error	errorResponseBody	Details of error response.

errorResponseBody

Details of error response.

Name	Type	Description
code	string	Error code, intended to be consumed programmatically.
details	errorResponseBody[]	A list of additional details about the error.
message	string	Description of the error, intended for display in user interface.
target	string	Target of the particular error, for example name of the property.

Field

Field for a given condition.

Name	Type	Description
AlertContext	string
AlertRuleId	string
AlertRuleName	string
Description	string
MonitorCondition	string
MonitorService	string
Severity	string
SignalType	string
TargetResource	string
TargetResourceGroup	string
TargetResourceType	string

MonthlyRecurrence

Monthly recurrence object.

Name	Type	Description
daysOfMonth	integer[]	Specifies the values for monthly recurrence pattern.
endTime	string	End time for recurrence.
recurrenceType	string: Monthly	Specifies when the recurrence should be applied.
startTime	string	Start time for recurrence.

Operator

Operator for a given condition.

Name	Type	Description
Contains	string
DoesNotContain	string
Equals	string
NotEquals	string

RemoveAllActionGroups

Indicates if all action groups should be removed.

Name	Type	Description
actionType	string: RemoveAllActionGroups	Action that should be applied.

Schedule

Scheduling configuration for a given alert processing rule.

Name	Type	Description
effectiveFrom	string	Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.
effectiveUntil	string	Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.
recurrences	Recurrence[]: DailyRecurrence[] MonthlyRecurrence[] WeeklyRecurrence[]	List of recurrences.
timeZone	string	Scheduling time zone.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

WeeklyRecurrence

Weekly recurrence object.

Name	Type	Description
daysOfWeek	DaysOfWeek[]	Specifies the values for weekly recurrence pattern.
endTime	string	End time for recurrence.
recurrenceType	string: Weekly	Specifies when the recurrence should be applied.
startTime	string	Start time for recurrence.