Activity Log Alerts - List By Subscription Id

Referencia

Service:: Monitor

API Version:: 2020-10-01

Lekérheti az előfizetés összes tevékenységnapló-riasztási szabályának listáját.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	AlertRuleList	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Hiba történt, és a tevékenységnapló-riasztási szabályok listája nem olvasható be.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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."
      }
    }
  ]
}

Definíciók

Name	Description
ActionGroup	Egy Azure-műveletcsoportra mutató mutató.
ActionList	A tevékenységnapló-riasztási szabályműveletek listája.
ActivityLogAlertResource	Tevékenységnapló-riasztási szabály erőforrása.
AlertRuleAllOfCondition	Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha az összes tagfeltétel teljesül.
AlertRuleAnyOfOrLeafCondition	Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha az összes tagfeltétel teljesül. Minden feltétel a következő típusok egyikének felelhet meg: Fontos: Minden típus egyedi tulajdonsághalmazsal rendelkezik. A különböző típusú tulajdonságok nem létezhetnek egyetlen feltételben. Levélfeltétel – a "mező" és az "equals" vagy a "containsAny" értéket kell tartalmaznia. Vegye figyelembe, hogy az "anyOf" nem* adható meg levélfeltételben.* AnyOf feltétel –csak "anyOf" értéket tartalmazhat (ez a levélfeltételek tömbje). Vegye figyelembe, hogy a "mező", az "equals" és a "containsAny" nem* állítható be AnyOf feltételben.*
AlertRuleLeafCondition	Tevékenységnapló-riasztási szabályfeltétel, amely egy tevékenységnapló-esemény mezőjének és értékének összehasonlításával teljesül. Ennek a feltételnek tartalmaznia kell a "mező" és az "equals" vagy a "containsAny" értéket.
AlertRuleList	A tevékenységnapló-riasztási szabályok listája.
ErrorResponse	A hibaválasz.

ActionGroup

Egy Azure-műveletcsoportra mutató mutató.

Name	Típus	Description
actionGroupId	string	A műveletcsoport erőforrás-azonosítója. Ez nem lehet null értékű vagy üres.
webhookProperties	object	az utóműveletbe belefoglalandó egyéni tulajdonságok szótárát. Ezek az adatok hozzá lesznek fűzve a webhook hasznos adataihoz.

ActionList

A tevékenységnapló-riasztási szabályműveletek listája.

Name	Típus	Description
actionGroups	ActionGroup[]	A műveletcsoportok listája.

ActivityLogAlertResource

Tevékenységnapló-riasztási szabály erőforrása.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás-azonosító.
location	string	global	Az erőforrás helye. Az Azure-tevékenységnapló-riasztási szabályok a globális, nyugat-európai és észak-európai régiókban támogatottak.
name	string		Az erőforrás neve.
properties.actions	ActionList		Azok a műveletek, amelyek a feltétel teljesülésekor aktiválódnak.
properties.condition	AlertRuleAllOfCondition		A riasztás aktiválását okozó feltétel.
properties.description	string		A tevékenységnapló-riasztási szabály leírása.
properties.enabled	boolean	True	Azt jelzi, hogy engedélyezve van-e ez a tevékenységnapló-riasztási szabály. Ha egy tevékenységnapló-riasztási szabály nincs engedélyezve, akkor egyik művelet sem lesz aktiválva.
properties.scopes	string[]		Az előtagként használt erőforrás-azonosítók listája. A riasztás csak az olyan erőforrás-azonosítókkal rendelkező tevékenységnapló-eseményekre vonatkozik, amelyek ezen előtagok egyikébe tartoznak. Ennek a listának legalább egy elemet tartalmaznia kell.
tags	object		Az erőforrás címkéi.
type	string		Az erőforrás típusa.

AlertRuleAllOfCondition

Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha az összes tagfeltétel teljesül.

Name	Típus	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	A tevékenységnapló-riasztási szabály feltételeinek listája.

AlertRuleAnyOfOrLeafCondition

Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha az összes tagfeltétel teljesül. Minden feltétel a következő típusok egyikének felelhet meg: Fontos: Minden típus egyedi tulajdonsághalmazsal rendelkezik. A különböző típusú tulajdonságok nem létezhetnek egyetlen feltételben.

Levélfeltétel – a "mező" és az "equals" vagy a "containsAny" értéket kell tartalmaznia. Vegye figyelembe, hogy az "anyOf" nem adható meg levélfeltételben.
AnyOf feltétel –csak "anyOf" értéket tartalmazhat (ez a levélfeltételek tömbje). Vegye figyelembe, hogy a "mező", az "equals" és a "containsAny" nem állítható be AnyOf feltételben.

Name	Típus	Description
anyOf	AlertRuleLeafCondition[]	Tevékenységnapló-riasztási szabály "anyOf" feltétel. Tevékenységnapló-riasztási szabályfeltétel, amely akkor teljesül, ha legalább az egyik taglevélfeltétel teljesül.
containsAny	string[]	Az esemény mezőjének értékét a rendszer összehasonlítja a tömb értékeivel (a kis- és nagybetűk nem különböztetik meg) annak megállapításához, hogy a feltétel teljesül-e.
equals	string	Az esemény mezőjének értéke ezzel az értékkel lesz összehasonlítva (a kis- és nagybetűk nem megkülönböztethetők), hogy megállapítsa, teljesül-e a feltétel.
field	string	Annak a tevékenységnapló-eseménynek a neve, amelyet ez a feltétel megvizsgál. A mező lehetséges értékei a következők: (case-insensitive): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType", vagy bármi, ami a "properties" kezdetű.

AlertRuleLeafCondition

Tevékenységnapló-riasztási szabályfeltétel, amely egy tevékenységnapló-esemény mezőjének és értékének összehasonlításával teljesül. Ennek a feltételnek tartalmaznia kell a "mező" és az "equals" vagy a "containsAny" értéket.

Name	Típus	Description
containsAny	string[]	Az esemény mezőjének értékét a rendszer összehasonlítja a tömb értékeivel (a kis- és nagybetűk nem különböztetik meg) annak megállapításához, hogy a feltétel teljesül-e.
equals	string	Az esemény mezőjének értéke ezzel az értékkel lesz összehasonlítva (a kis- és nagybetűk nem megkülönböztethetők), hogy megállapítsa, teljesül-e a feltétel.
field	string	Annak a tevékenységnapló-eseménynek a neve, amelyet ez a feltétel megvizsgál. A mező lehetséges értékei a következők: (case-insensitive): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType", vagy bármi, ami a "properties" kezdetű.

AlertRuleList

A tevékenységnapló-riasztási szabályok listája.

Name	Típus	Description
nextLink	string	A következő elemkészlet lekérésére szolgáló hivatkozás.
value	ActivityLogAlertResource[]	A tevékenységnapló-riasztási szabályok listája.

ErrorResponse

A hibaválasz.

Name	Típus	Description
code	string	A hibakód.
message	string	A művelet sikertelen voltát jelző hibaüzenet.

Activity Log Alerts - List By Subscription Id

URI-paraméterek

Válaszok

Biztonság

azure_auth

Scopes

Példák

Get list of all Activity Log Alert rules under a subscription

Sample Request

Sample Response

Definíciók

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

AlertRuleList

ErrorResponse

További források