Alert Processing Rules - Get By Name

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2021-08-08

Pobierz regułę przetwarzania alertów według nazwy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
alertProcessingRuleName	path	True	string	Nazwa reguły przetwarzania alertów, która musi zostać pobrana.
resourceGroupName	path	True	string	Nazwa grupy zasobów, w której jest tworzony zasób.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	api-version	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AlertProcessingRule	OK. Zwraca konkretną regułę przetwarzania alertów. Nagłówki x-ms-request-id: string
Other Status Codes	errorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

AlertProcessingRule

OK. Zwraca konkretną regułę przetwarzania alertów.

Nagłówki

x-ms-request-id: string

Other Status Codes

errorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

GetAlertProcessingRuleById

Przykładowe żądanie

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

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

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

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

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

Przykładowa odpowiedź

Kod stanu:: 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": {}
}

Definicje

Nazwa	Opis
AddActionGroups	Dodaj grupy akcji do reguły przetwarzania alertów.
AlertProcessingRule	Obiekt reguły przetwarzania alertów zawierający zakresy docelowe, warunki i logikę planowania.
AlertProcessingRuleProperties	Właściwości reguły przetwarzania alertów definiujące zakresy, warunki i logikę planowania dla reguły przetwarzania alertów.
api-version	Wersja interfejsu API klienta.
Condition	Warunek wyzwalania reguły przetwarzania alertów.
createdByType	Typ tożsamości, która utworzyła zasób.
DailyRecurrence	Obiekt cyklu dziennego.
DaysOfWeek	Dni tygodnia.
errorResponse	Odpowiedź na błąd z usługi.
errorResponseBody	Szczegóły odpowiedzi na błąd.
Field	Pole dla danego warunku.
MonthlyRecurrence	Miesięczny obiekt cyklu.
Operator	Operator dla danego warunku.
RemoveAllActionGroups	Wskazuje, czy wszystkie grupy akcji powinny zostać usunięte.
Schedule	Planowanie konfiguracji dla danej reguły przetwarzania alertów.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
WeeklyRecurrence	Cotygodniowy obiekt cyklu.

AddActionGroups

Dodaj grupy akcji do reguły przetwarzania alertów.

Nazwa	Typ	Opis
actionGroupIds	string[]	Lista identyfikatorów grupy akcji do dodania do reguły przetwarzania alertów.
actionType	string: AddActionGroups	Akcja, która powinna zostać zastosowana.

AlertProcessingRule

Obiekt reguły przetwarzania alertów zawierający zakresy docelowe, warunki i logikę planowania.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure
location	string	Lokalizacja zasobu
name	string	Nazwa zasobu platformy Azure
properties	AlertProcessingRuleProperties	Właściwości reguły przetwarzania alertów.
systemData	systemData	Dane systemowe reguł przetwarzania alertów.
tags	object	Tagi zasobów
type	string	Typ zasobu platformy Azure

AlertProcessingRuleProperties

Właściwości reguły przetwarzania alertów definiujące zakresy, warunki i logikę planowania dla reguły przetwarzania alertów.

Nazwa	Typ	Domyślna wartość	Opis
actions	Action[]: AddActionGroups[] RemoveAllActionGroups[]		Akcje do zastosowania.
conditions	Condition[]		Warunki, w których będą filtrowane alerty.
description	string		Opis reguły przetwarzania alertów.
enabled	boolean	True	Wskazuje, czy dana reguła przetwarzania alertów jest włączona lub wyłączona.
schedule	Schedule		Planowanie reguły przetwarzania alertów.
scopes	string[]		Zakresy, w których będzie stosowana reguła przetwarzania alertów.

api-version

Wersja interfejsu API klienta.

Nazwa	Typ	Opis
2021-08-08	string

Condition

Warunek wyzwalania reguły przetwarzania alertów.

Nazwa	Typ	Opis
field	Field	Pole dla danego warunku.
operator	Operator	Operator dla danego warunku.
values	string[]	Lista wartości, które mają być zgodne z danym warunkiem.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DailyRecurrence

Obiekt cyklu dziennego.

Nazwa	Typ	Opis
endTime	string	Godzina zakończenia cyklu.
recurrenceType	string: Daily	Określa, kiedy ma być stosowany cykl.
startTime	string	Godzina rozpoczęcia cyklu.

DaysOfWeek

Dni tygodnia.

Nazwa	Typ	Opis
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

errorResponse

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	errorResponseBody	Szczegóły odpowiedzi na błąd.

errorResponseBody

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu, który ma być używany programowo.
details	errorResponseBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Opis błędu, który jest przeznaczony do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu, na przykład nazwa właściwości.

Field

Pole dla danego warunku.

Nazwa	Typ	Opis
AlertContext	string
AlertRuleId	string
AlertRuleName	string
Description	string
MonitorCondition	string
MonitorService	string
Severity	string
SignalType	string
TargetResource	string
TargetResourceGroup	string
TargetResourceType	string

MonthlyRecurrence

Miesięczny obiekt cyklu.

Nazwa	Typ	Opis
daysOfMonth	integer[]	Określa wartości dla wzorca cyklu miesięcznego.
endTime	string	Godzina zakończenia cyklu.
recurrenceType	string: Monthly	Określa, kiedy ma być stosowany cykl.
startTime	string	Godzina rozpoczęcia cyklu.

Operator

Operator dla danego warunku.

Nazwa	Typ	Opis
Contains	string
DoesNotContain	string
Equals	string
NotEquals	string

RemoveAllActionGroups

Wskazuje, czy wszystkie grupy akcji powinny zostać usunięte.

Nazwa	Typ	Opis
actionType	string: RemoveAllActionGroups	Akcja, która powinna zostać zastosowana.

Schedule

Planowanie konfiguracji dla danej reguły przetwarzania alertów.

Nazwa	Typ	Opis
effectiveFrom	string	Planowanie efektywne od czasu. Date-Time w formacie ISO-8601 bez sufiksu strefy czasowej.
effectiveUntil	string	Planowanie skuteczne do czasu. Date-Time w formacie ISO-8601 bez sufiksu strefy czasowej.
recurrences	Recurrence[]: DailyRecurrence[] MonthlyRecurrence[] WeeklyRecurrence[]	Lista cykli.
timeZone	string	Planowanie strefy czasowej.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

WeeklyRecurrence

Cotygodniowy obiekt cyklu.

Nazwa	Typ	Opis
daysOfWeek	DaysOfWeek[]	Określa wartości wzorca cyklu tygodniowego.
endTime	string	Godzina zakończenia cyklu.
recurrenceType	string: Weekly	Określa, kiedy ma być stosowany cykl.
startTime	string	Godzina rozpoczęcia cyklu.

Udostępnij za pośrednictwem

Alert Processing Rules - Get By Name

Parametry identyfikatora URI

Odpowiedzi

Przykłady

GetAlertProcessingRuleById

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AddActionGroups

AlertProcessingRule

AlertProcessingRuleProperties

api-version

Condition

createdByType

DailyRecurrence

DaysOfWeek

errorResponse

errorResponseBody

Field

MonthlyRecurrence

Operator

RemoveAllActionGroups

Schedule

systemData

WeeklyRecurrence

Dodatkowe zasoby