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

Имя	В	Обязательно	Тип	Описание
activityLogAlertName	path	True	string	Имя правила генерации оповещений журнала действий.
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	ActivityLogAlertResource	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Произошла ошибка, и не удалось получить правило генерации оповещений журнала действий.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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 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

Пример ответа

Код состояния:: 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."
  }
}

Определения

Имя	Описание
ActionGroup	Указатель на группу действий Azure.
ActionList	Список действий правила генерации оповещений журнала действий.
ActivityLogAlertResource	Ресурс правила генерации оповещений журнала действий.
AlertRuleAllOfCondition	Условие правила генерации оповещений журнала действий, которое выполняется при выполнении всех условий его членов.
AlertRuleAnyOfOrLeafCondition	Условие правила генерации оповещений журнала действий, которое выполняется при выполнении всех условий его членов. Каждое условие может иметь один из следующих типов. Важно! Каждый тип имеет свое уникальное подмножество свойств. Свойства разных типов не могут существовать в одном условии. Конечное условие — должно содержать "field" и "equals" или "containsAny". Обратите внимание, что значение anyOf не должно быть задано в конечном условии. AnyOf Condition — должен содержать только anyOf (массив конечных условий). Обратите внимание, что "field", "equals" и "containsAny" не должны быть заданы в условии AnyOf.
AlertRuleLeafCondition	Условие правила генерации оповещений журнала действий, которое выполняется путем сравнения поля и значения события журнала действий. Это условие должно содержать "field" и "equals" или "containsAny".
ErrorResponse	Ответ об ошибке.

ActionGroup

Указатель на группу действий Azure.

Имя	Тип	Описание
actionGroupId	string	Идентификатор ресурса группы действий. Этот параметр не может быть пустым или пустым.
webhookProperties	object	словарь настраиваемых свойств, включаемых в после операции. Эти данные добавляются в полезные данные веб-перехватчика.

ActionList

Список действий правила генерации оповещений журнала действий.

Имя	Тип	Описание
actionGroups	ActionGroup[]	Список групп действий.

ActivityLogAlertResource

Ресурс правила генерации оповещений журнала действий.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса.
location	string	global	Расположение ресурса. Правила генерации оповещений журнала действий Azure поддерживаются в регионах "Глобальная", "Западная Европа" и "Северная Европа".
name	string		Имя ресурса.
properties.actions	ActionList		Действия, которые будут активированы при выполнении условия.
properties.condition	AlertRuleAllOfCondition		Условие, которое приведет к активации этого оповещения.
properties.description	string		Описание этого правила генерации оповещений журнала действий.
properties.enabled	boolean	True	Указывает, включено ли это правило генерации оповещений журнала действий. Если правило генерации оповещений журнала действий не включено, ни одно из его действий не будет активировано.
properties.scopes	string[]		Список идентификаторов ресурсов, которые будут использоваться в качестве префиксов. Оповещение будет применяться только к событиям журнала действий с идентификаторами ресурсов, которые подпадают под один из этих префиксов. Этот список должен содержать по крайней мере один элемент.
tags	object		Теги ресурса.
type	string		Тип ресурса.

AlertRuleAllOfCondition

Условие правила генерации оповещений журнала действий, которое выполняется при выполнении всех условий его членов.

Имя	Тип	Описание
allOf	AlertRuleAnyOfOrLeafCondition[]	Список условий правила генерации оповещений журнала действий.

AlertRuleAnyOfOrLeafCondition

Условие правила генерации оповещений журнала действий, которое выполняется при выполнении всех условий его членов. Каждое условие может иметь один из следующих типов. Важно! Каждый тип имеет свое уникальное подмножество свойств. Свойства разных типов не могут существовать в одном условии.

Конечное условие — должно содержать "field" и "equals" или "containsAny". Обратите внимание, что значение anyOf не должно быть задано в конечном условии.
AnyOf Condition — должен содержать только anyOf (массив конечных условий). Обратите внимание, что "field", "equals" и "containsAny" не должны быть заданы в условии AnyOf.

Имя	Тип	Описание
anyOf	AlertRuleLeafCondition[]	Условие правила генерации оповещений журнала действий anyOf. Условие правила генерации оповещений журнала действий, которое выполняется при выполнении хотя бы одного из условий конечного элемента.
containsAny	string[]	Значение поля события будет сравниваться со значениями в этом массиве (без учета регистра), чтобы определить, выполняется ли условие.
equals	string	Значение поля события будет сравниваться с этим значением (без учета регистра), чтобы определить, выполняется ли условие.
field	string	Имя поля события журнала действий, которое будет проверяться этим условием. Возможные значения для этого поля (без учета регистра): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" или все, что начинается с "properties".

AlertRuleLeafCondition

Условие правила генерации оповещений журнала действий, которое выполняется путем сравнения поля и значения события журнала действий. Это условие должно содержать "field" и "equals" или "containsAny".

Имя	Тип	Описание
containsAny	string[]	Значение поля события будет сравниваться со значениями в этом массиве (без учета регистра), чтобы определить, выполняется ли условие.
equals	string	Значение поля события будет сравниваться с этим значением (без учета регистра), чтобы определить, выполняется ли условие.
field	string	Имя поля события журнала действий, которое будет проверяться этим условием. Возможные значения для этого поля (без учета регистра): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" или все, что начинается с "properties".

ErrorResponse

Ответ об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

Поделиться через

Activity Log Alerts - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Get an Activity Log Alert rule

Образец запроса

Пример ответа

Определения

ActionGroup

ActionList

ActivityLogAlertResource

AlertRuleAllOfCondition

AlertRuleAnyOfOrLeafCondition

AlertRuleLeafCondition

ErrorResponse

Дополнительные ресурсы