Activity Log Alerts - Get

참조

서비스:: Monitor

API 버전:: 2020-10-01

활동 로그 경고 규칙을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
activityLogAlertName	path	True	string	활동 로그 경고 규칙의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	ActivityLogAlertResource	요청이 성공했습니다.
Other Status Codes	ErrorResponse	오류가 발생하여 활동 로그 경고 규칙을 검색할 수 없습니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Get an Activity Log Alert rule

샘플 요청

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;

// 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 ActivityLogAlertResource created on azure
// for more information of creating ActivityLogAlertResource, please refer to the document of ActivityLogAlertResource
string subscriptionId = "187f412d-1758-44d9-b052-169e2564721d";
string resourceGroupName = "MyResourceGroup";
string activityLogAlertName = "SampleActivityLogAlertRule";
ResourceIdentifier activityLogAlertResourceId = ActivityLogAlertResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, activityLogAlertName);
ActivityLogAlertResource activityLogAlert = client.GetActivityLogAlertResource(activityLogAlertResourceId);

// invoke the operation
ActivityLogAlertResource result = await activityLogAlert.GetAsync();

// 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

샘플 응답

상태 코드:: 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."
  }
}

정의

Name	Description
ActionGroup	Azure 작업 그룹에 대한 포인터입니다.
ActionList	활동 로그 경고 규칙 작업 목록입니다.
ActivityLogAlertResource	활동 로그 경고 규칙 리소스입니다.
AlertRuleAllOfCondition	모든 멤버 조건이 충족될 때 충족되는 활동 로그 경고 규칙 조건입니다.
AlertRuleAnyOfOrLeafCondition	모든 멤버 조건이 충족될 때 충족되는 활동 로그 경고 규칙 조건입니다. 각 조건은 다음 형식 중 하나일 수 있습니다. 중요: 각 형식에는 고유한 속성 하위 집합이 있습니다. 다른 형식의 속성은 한 조건에 존재할 수 없습니다. 리프 조건 - 'field'와 'equals' 또는 'containsAny'를 포함해야 합니다. 'anyOf'는 리프 조건에서 설정 해서는* 안 됩니다.* AnyOf 조건 - 리프 조건의 배열인 'anyOf' 만 포함해야 합니다. 'field', 'equals' 및 'containsAny'는 AnyOf 조건에서 설정 해서는* 안 됩니다.*
AlertRuleLeafCondition	활동 로그 이벤트의 필드와 값을 비교하여 충족되는 활동 로그 경고 규칙 조건입니다. 이 조건에는 'field'와 'equals' 또는 'containsAny'가 포함되어야 합니다.
ErrorResponse	오류 응답입니다.

ActionGroup

Azure 작업 그룹에 대한 포인터입니다.

Name	형식	Description
actionGroupId	string	작업 그룹의 리소스 ID입니다. null이거나 비어 있을 수 없습니다.
webhookProperties	object	게시 작업에 포함할 사용자 지정 속성의 사전입니다. 이러한 데이터는 웹후크 페이로드에 추가됩니다.

ActionList

활동 로그 경고 규칙 작업 목록입니다.

Name	형식	Description
actionGroups	ActionGroup[]	작업 그룹의 목록입니다.

ActivityLogAlertResource

활동 로그 경고 규칙 리소스입니다.

Name	형식	Default value	Description
id	string		리소스 ID입니다.
location	string	global	리소스의 위치입니다. Azure 활동 로그 경고 규칙은 글로벌, 서유럽 및 북유럽 지역에서 지원됩니다.
name	string		리소스의 이름입니다.
properties.actions	ActionList		조건이 충족될 때 활성화되는 작업입니다.
properties.condition	AlertRuleAllOfCondition		이 경고가 활성화되는 조건입니다.
properties.description	string		이 활동 로그 경고 규칙에 대한 설명입니다.
properties.enabled	boolean	True	이 활동 로그 경고 규칙을 사용할 수 있는지 여부를 나타냅니다. 활동 로그 경고 규칙을 사용하도록 설정하지 않으면 해당 작업이 활성화되지 않습니다.
properties.scopes	string[]		접두사로 사용할 리소스 ID 목록입니다. 경고는 이러한 접두사 중 하나에 속하는 리소스 ID가 있는 활동 로그 이벤트에만 적용됩니다. 이 목록에는 하나 이상의 항목이 포함되어야 합니다.
tags	object		리소스의 태그입니다.
type	string		리소스 형식입니다.

AlertRuleAllOfCondition

모든 멤버 조건이 충족될 때 충족되는 활동 로그 경고 규칙 조건입니다.

Name	형식	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	활동 로그 경고 규칙 조건 목록입니다.

AlertRuleAnyOfOrLeafCondition

모든 멤버 조건이 충족될 때 충족되는 활동 로그 경고 규칙 조건입니다. 각 조건은 다음 형식 중 하나일 수 있습니다. 중요: 각 형식에는 고유한 속성 하위 집합이 있습니다. 다른 형식의 속성은 한 조건에 존재할 수 없습니다.

리프 조건 - 'field'와 'equals' 또는 'containsAny'를 포함해야 합니다. 'anyOf'는 리프 조건에서 설정 해서는 안 됩니다.
AnyOf 조건 - 리프 조건의 배열인 'anyOf' 만 포함해야 합니다. 'field', 'equals' 및 'containsAny'는 AnyOf 조건에서 설정 해서는 안 됩니다.

Name	형식	Description
anyOf	AlertRuleLeafCondition[]	활동 로그 경고 규칙 'anyOf' 조건입니다. 멤버 리프 조건 중 하나 이상이 충족될 때 충족되는 활동 로그 경고 규칙 조건입니다.
containsAny	string[]	이벤트의 필드 값은 이 배열의 값(대/소문자를 구분하지 않음)과 비교하여 조건이 충족되는지 확인합니다.
equals	string	이벤트 필드의 값을 이 값(대/소문자를 구분하지 않음)과 비교하여 조건이 충족되는지 확인합니다.
field	string	이 조건이 검사할 활동 로그 이벤트 필드의 이름입니다. 이 필드에 사용할 수 있는 값은 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', '상태', 'subStatus', 'resourceType' 또는 'properties'로 시작하는 모든 값입니다.

AlertRuleLeafCondition

활동 로그 이벤트의 필드와 값을 비교하여 충족되는 활동 로그 경고 규칙 조건입니다. 이 조건에는 'field'와 'equals' 또는 'containsAny'가 포함되어야 합니다.

Name	형식	Description
containsAny	string[]	이벤트의 필드 값은 이 배열의 값(대/소문자를 구분하지 않음)과 비교하여 조건이 충족되는지 확인합니다.
equals	string	이벤트 필드의 값을 이 값(대/소문자를 구분하지 않음)과 비교하여 조건이 충족되는지 확인합니다.
field	string	이 조건이 검사할 활동 로그 이벤트 필드의 이름입니다. 이 필드에 사용할 수 있는 값은 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', '상태', 'subStatus', 'resourceType' 또는 'properties'로 시작하는 모든 값입니다.

ErrorResponse

오류 응답입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

다음을 통해 공유

Activity Log Alerts - Get

URI 매개 변수

응답

보안

azure_auth

범위

예제

Get an Activity Log Alert rule

샘플 요청

샘플 응답

정의

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

ErrorResponse

추가 리소스