Activity Log Alerts - Get

Reference

Service:: Monitor

API Version:: 2020-10-01

Získejte pravidlo upozornění protokolu aktivit.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
activityLogAlertName	path	True	string	Název pravidla upozornění protokolu aktivit.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ActivityLogAlertResource	Žádost byla úspěšná.
Other Status Codes	ErrorResponse	Došlo k chybě a pravidlo upozornění protokolu aktivit nebylo možné načíst.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get an Activity Log Alert rule

Sample Request

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

Sample Response

Status code:: 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."
  }
}

Definice

Name	Description
ActionGroup	Ukazatel na skupinu akcí Azure.
ActionList	Seznam akcí pravidla upozornění protokolu aktivit.
ActivityLogAlertResource	Prostředek pravidla upozornění protokolu aktivit.
AlertRuleAllOfCondition	Podmínka pravidla upozornění protokolu aktivit, která je splněna, když jsou splněny všechny jeho členské podmínky.
AlertRuleAnyOfOrLeafCondition	Podmínka pravidla upozornění protokolu aktivit, která je splněna, když jsou splněny všechny jeho členské podmínky. Každá podmínka může mít jeden z následujících typů: Důležité: Každý typ má svou jedinečnou podmnožinu vlastností. Vlastnosti různých typů NEMOHOU existovat v jedné podmínce. Podmínka listu – musí obsahovat pole a buď "rovná se", nebo "containsAny". Upozorňujeme, že parametr anyOf by neměl* být nastavený v podmínce listu.* Podmínka AnyOf – musí obsahovat pouze hodnotu anyOf (což je pole podmínek listu). Upozorňujeme, že pole, equals a containsAny by neměly* být nastaveny v podmínce AnyOf.*
AlertRuleLeafCondition	Podmínka pravidla upozornění protokolu aktivit, která je splněna porovnáním pole a hodnoty události protokolu aktivit. Tato podmínka musí obsahovat pole a buď se rovná, nebo containsAny.
ErrorResponse	Chybová odpověď.

ActionGroup

Ukazatel na skupinu akcí Azure.

Name	Typ	Description
actionGroupId	string	ID prostředku skupiny akcí. Nesmí být null ani prázdný.
webhookProperties	object	slovník vlastních vlastností, které se mají zahrnout do operace post. Tato data se připojí k datové části webhooku.

ActionList

Seznam akcí pravidla upozornění protokolu aktivit.

Name	Typ	Description
actionGroups	ActionGroup[]	Seznam skupin akcí.

ActivityLogAlertResource

Prostředek pravidla upozornění protokolu aktivit.

Name	Typ	Výchozí hodnota	Description
id	string		ID prostředku.
location	string	global	Umístění prostředku. Pravidla upozornění protokolu aktivit Azure se podporují v oblastech Globální, Západní Evropa a Severní Evropa.
name	string		Název prostředku.
properties.actions	ActionList		Akce, které se aktivují při splnění podmínky.
properties.condition	AlertRuleAllOfCondition		Podmínka, která způsobí aktivaci tohoto upozornění.
properties.description	string		Popis tohoto pravidla upozornění protokolu aktivit.
properties.enabled	boolean	True	Určuje, jestli je toto pravidlo upozornění protokolu aktivit povolené. Pokud pravidlo upozornění protokolu aktivit není povolené, žádná z jeho akcí se neaktivuje.
properties.scopes	string[]		Seznam ID prostředků, která se použijí jako předpony. Upozornění se bude vztahovat pouze na události protokolu aktivit s ID prostředků, které spadají pod jednu z těchto předpon. Tento seznam musí obsahovat alespoň jednu položku.
tags	object		Značky prostředku.
type	string		Typ prostředku.

AlertRuleAllOfCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna, když jsou splněny všechny jeho členské podmínky.

Name	Typ	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	Seznam podmínek pravidla upozornění protokolu aktivit.

AlertRuleAnyOfOrLeafCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna, když jsou splněny všechny jeho členské podmínky. Každá podmínka může mít jeden z následujících typů: Důležité: Každý typ má svou jedinečnou podmnožinu vlastností. Vlastnosti různých typů NEMOHOU existovat v jedné podmínce.

Podmínka listu – musí obsahovat pole a buď "rovná se", nebo "containsAny". Upozorňujeme, že parametr anyOf by neměl být nastavený v podmínce listu.
Podmínka AnyOf – musí obsahovat pouze hodnotu anyOf (což je pole podmínek listu). Upozorňujeme, že pole, equals a containsAny by neměly být nastaveny v podmínce AnyOf.

Name	Typ	Description
anyOf	AlertRuleLeafCondition[]	Podmínka pravidla upozornění protokolu aktivit anyOf Podmínka pravidla upozornění protokolu aktivit, která je splněna, pokud je splněna alespoň jedna z podmínek seznamu členů.
containsAny	string[]	Hodnota pole události se porovná s hodnotami v tomto poli (nerozlišují se malá a velká písmena), aby se zjistilo, jestli je podmínka splněná.
equals	string	Hodnota pole události se porovná s touto hodnotou (nerozlišují se malá a velká písmena), aby se zjistilo, jestli je podmínka splněná.
field	string	Název pole události protokolu aktivit, které tato podmínka prozkoumá. Možné hodnoty pro toto pole jsou (nerozlišují se malá a velká písmena): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' nebo cokoli jiného, co začíná 'properties'.

AlertRuleLeafCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna porovnáním pole a hodnoty události protokolu aktivit. Tato podmínka musí obsahovat pole a buď se rovná, nebo containsAny.

Name	Typ	Description
containsAny	string[]	Hodnota pole události se porovná s hodnotami v tomto poli (nerozlišují se malá a velká písmena), aby se zjistilo, jestli je podmínka splněná.
equals	string	Hodnota pole události se porovná s touto hodnotou (nerozlišují se malá a velká písmena), aby se zjistilo, jestli je podmínka splněná.
field	string	Název pole události protokolu aktivit, které tato podmínka prozkoumá. Možné hodnoty pro toto pole jsou (nerozlišují se malá a velká písmena): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' nebo cokoli jiného, co začíná 'properties'.

ErrorResponse

Chybová odpověď.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva s informacemi o tom, proč operace selhala.

Activity Log Alerts - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Get an Activity Log Alert rule

Sample Request

Sample Response

Definice

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

ErrorResponse

Další materiály