Activity Log Alerts - Get

Referencia

Szolgáltatás:: Monitor

API-verzió:: 2020-10-01

Tevékenységnapló-riasztási szabály lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
activityLogAlertName	path	True	string	A tevékenységnapló-riasztási szabály neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
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	ActivityLogAlertResource	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Hiba történt, és a tevékenységnapló-riasztási szabályt nem sikerült beolvasni.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

Get an Activity Log Alert rule

Mintakérelem

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


/**
 * Samples for ActivityLogAlerts GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Get.
     * json
     */
    /**
     * Sample code: Get an Activity Log Alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnActivityLogAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getActivityLogAlerts().getByResourceGroupWithResponse(
            "MyResourceGroup", "SampleActivityLogAlertRule", com.azure.core.util.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_Get.json
func ExampleActivityLogAlertsClient_Get() {
	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)
	}
	res, err := clientFactory.NewActivityLogAlertsClient().Get(ctx, "MyResourceGroup", "SampleActivityLogAlertRule", 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.ActivityLogAlertResource = armmonitor.ActivityLogAlertResource{
	// 	Name: to.Ptr("SampleActivityLogAlertRule"),
	// 	Type: to.Ptr("Microsoft.Insights/ActivityLogAlerts"),
	// 	ID: to.Ptr("/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule"),
	// 	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/MyResourceGroup/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")},
	// 		},
	// 	}
}

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 an Activity Log Alert rule.
 *
 * @summary Get an Activity Log Alert rule.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/examples/ActivityLogAlertRule_Get.json
 */
async function getAnActivityLogAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "187f412d-1758-44d9-b052-169e2564721d";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "MyResourceGroup";
  const activityLogAlertName = "SampleActivityLogAlertRule";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.activityLogAlerts.get(resourceGroupName, activityLogAlertName);
  console.log(result);
}

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_Get.json
// this example is just showing the usage of "ActivityLogAlerts_Get" 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 = "187f412d-1758-44d9-b052-169e2564721d";
string resourceGroupName = "MyResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ActivityLogAlertResource
ActivityLogAlertCollection collection = resourceGroupResource.GetActivityLogAlerts();

// invoke the operation
string activityLogAlertName = "SampleActivityLogAlertRule";
NullableResponse<ActivityLogAlertResource> response = await collection.GetIfExistsAsync(activityLogAlertName);
ActivityLogAlertResource 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
    ActivityLogAlertData 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

Mintaválasz

Állapotkód:: 200

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "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/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "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.
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ű.

ErrorResponse

A hibaválasz.

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

Megosztás a következőn keresztül:

Activity Log Alerts - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Get an Activity Log Alert rule

Mintakérelem

Mintaválasz

Definíciók

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

ErrorResponse

További források