Activity Log Alerts - Get

Serviço:

Monitor

Versão da API:

2020-10-01

Obter uma regra de Alerta do Registo de Atividades.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
activityLogAlertName	path	True	string	O nome da regra de Alerta do Registo de Atividades.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	ActivityLogAlertResource	O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	Ocorreu um erro e não foi possível obter a regra de Alerta do Registo de Atividades.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get an Activity Log Alert rule

Pedido de amostra

HTTP

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

Java

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

Go

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

JavaScript

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

dotnet

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
ActionGroup	Um ponteiro para um Grupo de Ações do Azure.
ActionList	Uma lista de ações de regras de Alerta do Registo de Atividades.
ActivityLogAlertResource	Um recurso de regra de Alerta do Registo de Atividades.
AlertRuleAllOfCondition	Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando todas as condições dos membros são cumpridas.
AlertRuleAnyOfOrLeafCondition	Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando todas as condições dos membros são cumpridas. Cada condição pode ser de um dos seguintes tipos: Importante: cada tipo tem o seu subconjunto exclusivo de propriedades. Não é possível existir propriedades de diferentes tipos numa condição. Condição de Folha - tem de conter "campo" e "igual" ou "containsAny". Tenha em atenção que "anyOf" não deve ser definido numa Condição de Folha. AnyOf Condition - tem de conter apenas "anyOf" (que é uma matriz de Condições de Folha). Tenha em atenção que "campo", "igual a" e "containsAny" não devem ser definidos numa Condição AnyOf.
AlertRuleLeafCondition	Uma condição de regra de Alerta do Registo de Atividades que é cumprida ao comparar o campo e o valor de um evento do Registo de Atividades. Esta condição tem de conter "campo" e "igual" ou "containsAny".
ErrorResponse	A resposta do erro.

ActionGroup

Um ponteiro para um Grupo de Ações do Azure.

Name	Tipo	Description
actionGroupId	string	O ID do recurso do Grupo de Ações. Não pode ser nulo ou estar vazio.
webhookProperties	object	o dicionário de propriedades personalizadas a incluir com a operação de publicação. Estes dados são anexados ao payload do webhook.

ActionList

Uma lista de ações de regras de Alerta do Registo de Atividades.

Name	Tipo	Description
actionGroups	ActionGroup[]	A lista dos Grupos de Ações.

ActivityLogAlertResource

Um recurso de regra de Alerta do Registo de Atividades.

Name	Tipo	Default value	Description
id	string		O ID do recurso.
location	string	global	A localização do recurso. As regras de Alerta do Registo de Atividades do Azure são suportadas nas regiões Global, Europa Ocidental e Europa do Norte.
name	string		O nome do recurso.
properties.actions	ActionList		As ações que serão ativadas quando a condição for cumprida.
properties.condition	AlertRuleAllOfCondition		A condição que fará com que este alerta seja ativado.
properties.description	string		Uma descrição desta regra de Alerta do Registo de Atividades.
properties.enabled	boolean	True	Indica se esta regra de Alerta do Registo de Atividades está ativada. Se uma regra de Alerta do Registo de Atividades não estiver ativada, nenhuma das ações será ativada.
properties.scopes	string[]		Uma lista de IDs de recursos que serão utilizados como prefixos. O alerta só se aplicará a eventos do Registo de Atividades com IDs de recursos que se enquadram num destes prefixos. Esta lista tem de incluir, pelo menos, um item.
tags	object		As etiquetas do recurso.
type	string		O tipo do recurso.

AlertRuleAllOfCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando todas as condições dos membros são cumpridas.

Name	Tipo	Description
allOf	AlertRuleAnyOfOrLeafCondition[]	A lista de condições da regra de Alerta do Registo de Atividades.

AlertRuleAnyOfOrLeafCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando todas as condições dos membros são cumpridas. Cada condição pode ser de um dos seguintes tipos: Importante: cada tipo tem o seu subconjunto exclusivo de propriedades. Não é possível existir propriedades de diferentes tipos numa condição.

• Condição de Folha - tem de conter "campo" e "igual" ou "containsAny". Tenha em atenção que "anyOf" não deve ser definido numa Condição de Folha.
• AnyOf Condition - tem de conter apenas "anyOf" (que é uma matriz de Condições de Folha). Tenha em atenção que "campo", "igual a" e "containsAny" não devem ser definidos numa Condição AnyOf.

Name	Tipo	Description
anyOf	AlertRuleLeafCondition[]	Uma condição "anyOf" da regra de Alerta do Registo de Atividades. Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando pelo menos uma das condições de folha membro é cumprida.
containsAny	string[]	O valor do campo do evento será comparado com os valores nesta matriz (não sensível a maiúsculas e minúsculas) para determinar se a condição é cumprida.
equals	string	O valor do campo do evento será comparado a este valor (não sensível a maiúsculas e minúsculas) para determinar se a condição é cumprida.
field	string	O nome do campo do evento do Registo de Atividades que esta condição irá examinar. Os valores possíveis para este campo são (não sensíveis a maiúsculas e minúsculas): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" ou qualquer coisa que comece com "propriedades".

AlertRuleLeafCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida ao comparar o campo e o valor de um evento do Registo de Atividades. Esta condição tem de conter "campo" e "igual" ou "containsAny".

Name	Tipo	Description
containsAny	string[]	O valor do campo do evento será comparado com os valores nesta matriz (não sensível a maiúsculas e minúsculas) para determinar se a condição é cumprida.
equals	string	O valor do campo do evento será comparado a este valor (não sensível a maiúsculas e minúsculas) para determinar se a condição é cumprida.
field	string	O nome do campo do evento do Registo de Atividades que esta condição irá examinar. Os valores possíveis para este campo são (não sensíveis a maiúsculas e minúsculas): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" ou qualquer coisa que comece com "propriedades".

ErrorResponse

A resposta do erro.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro que indica a razão pela qual a operação falhou.