Activity Log Alerts - List By Subscription Id

Odwołanie

Service:: Monitor

API Version:: 2020-10-01

Pobierz listę wszystkich reguł alertów dziennika aktywności w subskrypcji.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/activityLogAlerts?api-version=2020-10-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AlertRuleList	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Wystąpił błąd i nie można pobrać listy reguł alertów dziennika aktywności.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get list of all Activity Log Alert rules under a subscription

Sample Request

GET https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/providers/Microsoft.Insights/activityLogAlerts?api-version=2020-10-01


import com.azure.core.util.Context;

/** Samples for ActivityLogAlerts List. */
public final class Main {
    /*
     * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/
     * ActivityLogAlertRule_ListBySubscriptionId.json
     */
    /**
     * Sample code: Get list of all Activity Log Alert rules under a subscription.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getListOfAllActivityLogAlertRulesUnderASubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getActivityLogAlerts().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

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/2020-10-01/examples/ActivityLogAlertRule_ListBySubscriptionId.json
func ExampleActivityLogAlertsClient_NewListBySubscriptionIDPager() {
	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.NewActivityLogAlertsClient().NewListBySubscriptionIDPager(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.AlertRuleList = armmonitor.AlertRuleList{
		// 	Value: []*armmonitor.ActivityLogAlertResource{
		// 		{
		// 			Name: to.Ptr("SampleActivityLogAlertRule1"),
		// 			Type: to.Ptr("Microsoft.Insights/ActivityLogAlerts"),
		// 			ID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup1/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule1"),
		// 			Location: to.Ptr("Global"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armmonitor.AlertRuleProperties{
		// 				Description: to.Ptr("Description of sample Activity Log Alert rule."),
		// 				Actions: &armmonitor.ActionList{
		// 					ActionGroups: []*armmonitor.ActionGroupAutoGenerated{
		// 						{
		// 							ActionGroupID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup1/providers/microsoft.insights/actionGroups/SampleActionGroup"),
		// 							WebhookProperties: map[string]*string{
		// 								"sampleWebhookProperty": to.Ptr("SamplePropertyValue"),
		// 							},
		// 					}},
		// 				},
		// 				Condition: &armmonitor.AlertRuleAllOfCondition{
		// 					AllOf: []*armmonitor.AlertRuleAnyOfOrLeafCondition{
		// 						{
		// 							Equals: to.Ptr("Administrative"),
		// 							Field: to.Ptr("category"),
		// 						},
		// 						{
		// 							Equals: to.Ptr("Error"),
		// 							Field: to.Ptr("level"),
		// 					}},
		// 				},
		// 				Enabled: to.Ptr(true),
		// 				Scopes: []*string{
		// 					to.Ptr("subscriptions/187f412d-1758-44d9-b052-169e2564721d")},
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("SampleActivityLogAlertRule2"),
		// 				Type: to.Ptr("Microsoft.Insights/ActivityLogAlerts"),
		// 				ID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule2"),
		// 				Location: to.Ptr("Global"),
		// 				Tags: map[string]*string{
		// 				},
		// 				Properties: &armmonitor.AlertRuleProperties{
		// 					Description: to.Ptr("Description of sample Activity Log Alert rule."),
		// 					Actions: &armmonitor.ActionList{
		// 						ActionGroups: []*armmonitor.ActionGroupAutoGenerated{
		// 							{
		// 								ActionGroupID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2/providers/microsoft.insights/actionGroups/SampleActionGroup"),
		// 								WebhookProperties: map[string]*string{
		// 								},
		// 						}},
		// 					},
		// 					Condition: &armmonitor.AlertRuleAllOfCondition{
		// 						AllOf: []*armmonitor.AlertRuleAnyOfOrLeafCondition{
		// 							{
		// 								Equals: to.Ptr("Administrative"),
		// 								Field: to.Ptr("category"),
		// 							},
		// 							{
		// 								Equals: to.Ptr("Succeeded"),
		// 								Field: to.Ptr("status"),
		// 						}},
		// 					},
		// 					Enabled: to.Ptr(true),
		// 					Scopes: []*string{
		// 						to.Ptr("subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2")},
		// 					},
		// 			}},
		// 		}
	}
}

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 Get a list of all Activity Log Alert rules in a subscription.
 *
 * @summary Get a list of all Activity Log Alert rules in a subscription.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_ListBySubscriptionId.json
 */
async function getListOfAllActivityLogAlertRulesUnderASubscription() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "187f412d-1758-44d9-b052-169e2564721d";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.activityLogAlerts.listBySubscriptionId()) {
    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 System;
using System.Threading.Tasks;
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/2020-10-01/examples/ActivityLogAlertRule_ListBySubscriptionId.json
// this example is just showing the usage of "ActivityLogAlerts_ListBySubscriptionId" 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 = "187f412d-1758-44d9-b052-169e2564721d";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ActivityLogAlertResource item in subscriptionResource.GetActivityLogAlertsAsync())
{
    // 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
    ActivityLogAlertData 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/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup1/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule1",
      "type": "Microsoft.Insights/ActivityLogAlerts",
      "name": "SampleActivityLogAlertRule1",
      "location": "Global",
      "tags": {},
      "properties": {
        "scopes": [
          "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
        ],
        "condition": {
          "allOf": [
            {
              "field": "category",
              "equals": "Administrative"
            },
            {
              "field": "level",
              "equals": "Error"
            }
          ]
        },
        "actions": {
          "actionGroups": [
            {
              "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup1/providers/microsoft.insights/actionGroups/SampleActionGroup",
              "webhookProperties": {
                "sampleWebhookProperty": "SamplePropertyValue"
              }
            }
          ]
        },
        "enabled": true,
        "description": "Description of sample Activity Log Alert rule."
      }
    },
    {
      "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule2",
      "type": "Microsoft.Insights/ActivityLogAlerts",
      "name": "SampleActivityLogAlertRule2",
      "location": "Global",
      "tags": {},
      "properties": {
        "scopes": [
          "subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2"
        ],
        "condition": {
          "allOf": [
            {
              "field": "category",
              "equals": "Administrative"
            },
            {
              "field": "status",
              "equals": "Succeeded"
            }
          ]
        },
        "actions": {
          "actionGroups": [
            {
              "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2/providers/microsoft.insights/actionGroups/SampleActionGroup",
              "webhookProperties": {}
            }
          ]
        },
        "enabled": true,
        "description": "Description of sample Activity Log Alert rule."
      }
    }
  ]
}

Definicje

Nazwa	Opis
ActionGroup	Wskaźnik do grupy akcji platformy Azure.
ActionList	Lista akcji reguły alertu dziennika aktywności.
ActivityLogAlertResource	Zasób reguły alertu dziennika aktywności.
AlertRuleAllOfCondition	Warunek reguły alertu dziennika aktywności, który jest spełniony, gdy zostaną spełnione wszystkie warunki jego elementu członkowskiego.
AlertRuleAnyOfOrLeafCondition	Warunek reguły alertu dziennika aktywności, który jest spełniony, gdy zostaną spełnione wszystkie warunki jego elementu członkowskiego. Każdy warunek może być jednym z następujących typów: Ważne: Każdy typ ma swój unikatowy podzestaw właściwości. Właściwości z różnych typów NIE MOGĄ istnieć w jednym warunku. Warunek liścia — musi zawierać pole i wartość "equals" lub "containsAny". Należy pamiętać, że parametr "anyOf" nie* powinien być ustawiony w warunku liścia.* AnyOf Condition — musi zawierać tylko wartość "anyOf" (która jest tablicą warunków liścia). Należy pamiętać, że parametr "field", "equals" i "containsAny" nie* powinien być ustawiony w warunku AnyOf.*
AlertRuleLeafCondition	Warunek reguły alertu dziennika aktywności, który jest spełniony, porównując pole i wartość zdarzenia dziennika aktywności. Ten warunek musi zawierać pole i wartość "equals" lub "containsAny".
AlertRuleList	Lista reguł alertów dziennika aktywności.
ErrorResponse	Odpowiedź na błąd.

ActionGroup

Wskaźnik do grupy akcji platformy Azure.

Nazwa	Typ	Opis
actionGroupId	string	Identyfikator zasobu grupy akcji. Nie może to być wartość null ani być pusta.
webhookProperties	object	słownik właściwości niestandardowych do uwzględnienia w operacji post. Te dane są dołączane do ładunku elementu webhook.

ActionList

Lista akcji reguły alertu dziennika aktywności.

Nazwa	Typ	Opis
actionGroups	ActionGroup[]	Lista grup akcji.

ActivityLogAlertResource

Zasób reguły alertu dziennika aktywności.

Nazwa	Typ	Wartość domyślna	Opis
id	string		Identyfikator zasobu.
location	string	global	Lokalizacja zasobu. Reguły alertów dziennika aktywności platformy Azure są obsługiwane w regionach Global, Europa Zachodnia i Europa Północna.
name	string		Nazwa zasobu.
properties.actions	ActionList		Akcje, które zostaną aktywowane po spełnieniu warunku.
properties.condition	AlertRuleAllOfCondition		Warunek, który spowoduje aktywowanie tego alertu.
properties.description	string		Opis tej reguły alertu dziennika aktywności.
properties.enabled	boolean	True	Wskazuje, czy ta reguła alertu dziennika aktywności jest włączona. Jeśli reguła alertu dziennika aktywności nie jest włączona, żadna z jego akcji nie zostanie aktywowana.
properties.scopes	string[]		Lista identyfikatorów zasobów, które będą używane jako prefiksy. Alert będzie dotyczyć tylko zdarzeń dziennika aktywności z identyfikatorami zasobów, które należą do jednego z tych prefiksów. Ta lista musi zawierać co najmniej jeden element.
tags	object		Tagi zasobu.
type	string		Typ zasobu.

AlertRuleAllOfCondition

Warunek reguły alertu dziennika aktywności, który jest spełniony, gdy zostaną spełnione wszystkie warunki jego elementu członkowskiego.

Nazwa	Typ	Opis
allOf	AlertRuleAnyOfOrLeafCondition[]	Lista warunków reguły alertu dziennika aktywności.

AlertRuleAnyOfOrLeafCondition

Warunek reguły alertu dziennika aktywności, który jest spełniony, gdy zostaną spełnione wszystkie warunki jego elementu członkowskiego. Każdy warunek może być jednym z następujących typów: Ważne: Każdy typ ma swój unikatowy podzestaw właściwości. Właściwości z różnych typów NIE MOGĄ istnieć w jednym warunku.

Warunek liścia — musi zawierać pole i wartość "equals" lub "containsAny". Należy pamiętać, że parametr "anyOf" nie powinien być ustawiony w warunku liścia.
AnyOf Condition — musi zawierać tylko wartość "anyOf" (która jest tablicą warunków liścia). Należy pamiętać, że parametr "field", "equals" i "containsAny" nie powinien być ustawiony w warunku AnyOf.

Nazwa	Typ	Opis
anyOf	AlertRuleLeafCondition[]	Warunek alertu dziennika aktywności "anyOf". Warunek reguły alertu dziennika aktywności, który jest spełniony po spełnieniu co najmniej jednego z warunków liścia członkowskiego.
containsAny	string[]	Wartość pola zdarzenia zostanie porównana z wartościami w tej tablicy (bez uwzględniania wielkości liter), aby określić, czy warunek jest spełniony.
equals	string	Wartość pola zdarzenia zostanie porównana z tą wartością (bez uwzględniania wielkości liter), aby określić, czy warunek jest spełniony.
field	string	Nazwa pola zdarzenia dziennika aktywności, które zostanie przeanalizowane przez ten warunek. Możliwe wartości dla tego pola to (bez uwzględniania wielkości liter): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" lub dowolny element rozpoczynający się od właściwości.

AlertRuleLeafCondition

Warunek reguły alertu dziennika aktywności, który jest spełniony, porównując pole i wartość zdarzenia dziennika aktywności. Ten warunek musi zawierać pole i wartość "equals" lub "containsAny".

Nazwa	Typ	Opis
containsAny	string[]	Wartość pola zdarzenia zostanie porównana z wartościami w tej tablicy (bez uwzględniania wielkości liter), aby określić, czy warunek jest spełniony.
equals	string	Wartość pola zdarzenia zostanie porównana z tą wartością (bez uwzględniania wielkości liter), aby określić, czy warunek jest spełniony.
field	string	Nazwa pola zdarzenia dziennika aktywności, które zostanie przeanalizowane przez ten warunek. Możliwe wartości dla tego pola to (bez uwzględniania wielkości liter): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" lub dowolny element rozpoczynający się od właściwości.

AlertRuleList

Lista reguł alertów dziennika aktywności.

Nazwa	Typ	Opis
nextLink	string	Udostępnia link umożliwiający pobranie następnego zestawu elementów.
value	ActivityLogAlertResource[]	Lista reguł alertów dziennika aktywności.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

Activity Log Alerts - List By Subscription Id

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Get list of all Activity Log Alert rules under a subscription

Sample Request

Sample Response

Definicje

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRuleList

ErrorResponse

Dodatkowe zasoby