Alert Rules - Get

Serviço:

Monitor

Versão da API:

2016-03-01

Obtém uma regra de alerta de métrica clássica

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
ruleName	path	True	string	O nome da regra.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	AlertRuleResource	Solicitação bem-sucedida para obter uma regra de alerta
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get an alert rule

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01

Java

/**
 * Samples for AlertRules GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRule.json
     */
    /**
     * Sample code: Get an alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getAlertRules()
            .getByResourceGroupWithResponse("Rac46PostSwapRG", "chiricutin", 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/2016-03-01/examples/getAlertRule.json
func ExampleAlertRulesClient_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.NewAlertRulesClient().Get(ctx, "Rac46PostSwapRG", "chiricutin", 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.AlertRuleResource = armmonitor.AlertRuleResource{
	// 	Name: to.Ptr("chiricutin"),
	// 	Type: to.Ptr("Microsoft.Insights/alertRules"),
	// 	ID: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"$type": to.Ptr("Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage"),
	// 		"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
	// 	},
	// 	Properties: &armmonitor.AlertRule{
	// 		Name: to.Ptr("chiricutin"),
	// 		Description: to.Ptr("Pura Vida"),
	// 		Actions: []armmonitor.RuleActionClassification{
	// 		},
	// 		Condition: &armmonitor.ThresholdRuleCondition{
	// 			DataSource: &armmonitor.RuleMetricDataSource{
	// 				ODataType: to.Ptr("Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"),
	// 				ResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest"),
	// 				MetricName: to.Ptr("Requests"),
	// 			},
	// 			ODataType: to.Ptr("Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"),
	// 			Operator: to.Ptr(armmonitor.ConditionOperatorGreaterThan),
	// 			Threshold: to.Ptr[float64](3),
	// 			TimeAggregation: to.Ptr(armmonitor.TimeAggregationOperatorTotal),
	// 			WindowSize: to.Ptr("PT5M"),
	// 		},
	// 		IsEnabled: to.Ptr(true),
	// 		LastUpdatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-11-23T21:23:52.022Z"); return t}()),
	// 	},
	// }
}

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 Gets a classic metric alert rule
 *
 * @summary Gets a classic metric alert rule
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRule.json
 */
async function getAnAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "Rac46PostSwapRG";
  const ruleName = "chiricutin";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.alertRules.get(resourceGroupName, ruleName);
  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 System.Xml;
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/2016-03-01/examples/getAlertRule.json
// this example is just showing the usage of "AlertRules_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 = "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
string resourceGroupName = "Rac46PostSwapRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AlertRuleResource
AlertRuleCollection collection = resourceGroupResource.GetAlertRules();

// invoke the operation
string ruleName = "chiricutin";
NullableResponse<AlertRuleResource> response = await collection.GetIfExistsAsync(ruleName);
AlertRuleResource 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
    AlertRuleData 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 de exemplo

Código de status:

200

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
  "name": "chiricutin",
  "type": "Microsoft.Insights/alertRules",
  "location": "West US",
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
    "actions": []
  }
}

Definições

Nome	Description
AlertRuleResource	O recurso de regra de alerta.
ConditionOperator	Operadores permitidos na condição de regra.
ErrorResponse	Descreve o formato da resposta de erro.
LocationThresholdRuleCondition	Uma condição de regra com base em um determinado número de locais falhando.
ManagementEventAggregationCondition	Como os dados coletados devem ser combinados ao longo do tempo.
ManagementEventRuleCondition	Uma condição de regra de evento de gerenciamento.
RuleEmailAction	Especifica a ação para enviar email quando a condição da regra é avaliada. O discriminador é sempre RuleEmailAction neste caso.
RuleManagementEventClaimsDataSource	As declarações de uma fonte de dados de evento de gerenciamento de regras.
RuleManagementEventDataSource	Uma fonte de dados de evento de gerenciamento de regras. Os campos discriminatórios são sempre RuleManagementEventDataSource nesse caso.
RuleMetricDataSource	Uma fonte de dados de métrica de regra. O valor discriminatório é sempre RuleMetricDataSource nesse caso.
RuleWebhookAction	Especifica a ação a ser postada no serviço quando a condição da regra é avaliada. O discriminador é sempre RuleWebhookAction neste caso.
ThresholdRuleCondition	Uma condição de regra com base em uma métrica cruzando um limite.
TimeAggregationOperator	Operadores de agregação permitidos em uma regra.

AlertRuleResource

O recurso de regra de alerta.

Nome	Tipo	Description
id	string	ID do recurso do Azure
location	string	Localização do recurso
name	string	Nome do recurso do Azure
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	que é executada quando a regra de alerta se torna ativa e quando uma condição de alerta é resolvida.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	a matriz de ações executadas quando a regra de alerta se torna ativa e quando uma condição de alerta é resolvida.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	a condição que resulta na ativação da regra de alerta.
properties.description	string	a descrição da regra de alerta que será incluída no email de alerta.
properties.isEnabled	boolean	o sinalizador que indica se a regra de alerta está habilitada.
properties.lastUpdatedTime	string	Última vez em que a regra foi atualizada no formato ISO8601.
properties.name	string	o nome da regra de alerta.
properties.provisioningState	string	o estado de provisionamento.
tags	object	Marcações de recursos
type	string	Tipo de recurso do Azure

ConditionOperator

Operadores permitidos na condição de regra.

Nome	Tipo	Description
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

LocationThresholdRuleCondition

Uma condição de regra com base em um determinado número de locais falhando.

Nome	Tipo	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	o recurso do qual a regra coleta seus dados. Para esse tipo, dataSource sempre será do tipo RuleMetricDataSource.
failedLocationCount	integer	o número de locais que devem falhar ao ativar o alerta.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	especifica o tipo de condição. Esse pode ser um dos três tipos: ManagementEventRuleCondition (ocorrências de eventos de gerenciamento), LocationThresholdRuleCondition (com base no número de falhas de um teste na Web) e ThresholdRuleCondition (com base no limite de uma métrica).
windowSize	string	o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite. Se especificado, ele deverá estar entre 5 minutos e 1 dia.

ManagementEventAggregationCondition

Como os dados coletados devem ser combinados ao longo do tempo.

Nome	Tipo	Description
operator	ConditionOperator	o operador condition.
threshold	number	O valor de limite que ativa o alerta.
windowSize	string	o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite. Se especificado, ele deverá estar entre 5 minutos e 1 dia.

ManagementEventRuleCondition

Uma condição de regra de evento de gerenciamento.

Nome	Tipo	Description
aggregation	ManagementEventAggregationCondition	Como os dados coletados devem ser combinados ao longo do tempo e quando o alerta é ativado. Observe que a agregação é opcional para alertas de eventos de gerenciamento; se nenhuma agregação for fornecida, o evento fará com que o alerta seja ativado.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	o recurso do qual a regra coleta seus dados. Para esse tipo, dataSource sempre será do tipo RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	especifica o tipo de condição. Esse pode ser um dos três tipos: ManagementEventRuleCondition (ocorrências de eventos de gerenciamento), LocationThresholdRuleCondition (com base no número de falhas de um teste na Web) e ThresholdRuleCondition (com base no limite de uma métrica).

RuleEmailAction

Especifica a ação para enviar email quando a condição da regra é avaliada. O discriminador é sempre RuleEmailAction neste caso.

Nome	Tipo	Description
customEmails	string[]	a lista de endereços de email personalizados do administrador para notificar sobre a ativação do alerta.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	especifica o tipo da ação. Há dois tipos de ações: RuleEmailAction e RuleWebhookAction.
sendToServiceOwners	boolean	Se os administradores (serviço e co-administradores) do serviço devem ser notificados quando o alerta for ativado.

RuleManagementEventClaimsDataSource

As declarações de uma fonte de dados de evento de gerenciamento de regras.

Nome	Tipo	Description
emailAddress	string	o endereço de email.

RuleManagementEventDataSource

Uma fonte de dados de evento de gerenciamento de regras. Os campos discriminatórios são sempre RuleManagementEventDataSource nesse caso.

Nome	Tipo	Description
claims	RuleManagementEventClaimsDataSource	as declarações.
eventName	string	o nome do evento.
eventSource	string	a origem do evento.
legacyResourceId	string	o identificador de recurso herdado do recurso que a regra monitora. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra existente.
level	string	o nível.
metricNamespace	string	o namespace da métrica.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	especifica o tipo de fonte de dados. Há dois tipos de fontes de dados de regra: RuleMetricDataSource e RuleManagementEventDataSource
operationName	string	O nome da operação que deve ser verificada. Se nenhum nome for fornecido, qualquer operação será compatível.
resourceGroupName	string	o nome do grupo de recursos.
resourceLocation	string	o local do recurso.
resourceProviderName	string	o nome do provedor de recursos.
resourceUri	string	o identificador de recurso do recurso que a regra monitora. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra existente.
status	string	O status da operação que deve ser verificada. Se nenhum status for fornecido, qualquer status será compatível.
subStatus	string	o substatus.

RuleMetricDataSource

Uma fonte de dados de métrica de regra. O valor discriminatório é sempre RuleMetricDataSource nesse caso.

Nome	Tipo	Description
legacyResourceId	string	o identificador de recurso herdado do recurso que a regra monitora. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra existente.
metricName	string	o nome da métrica que define o que a regra monitora.
metricNamespace	string	o namespace da métrica.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	especifica o tipo de fonte de dados. Há dois tipos de fontes de dados de regra: RuleMetricDataSource e RuleManagementEventDataSource
resourceLocation	string	o local do recurso.
resourceUri	string	o identificador de recurso do recurso que a regra monitora. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra existente.

RuleWebhookAction

Especifica a ação a ser postada no serviço quando a condição da regra é avaliada. O discriminador é sempre RuleWebhookAction neste caso.

Nome	Tipo	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	especifica o tipo da ação. Há dois tipos de ações: RuleEmailAction e RuleWebhookAction.
properties	object	o dicionário de propriedades personalizadas a serem incluídas na pós-operação. Esses dados são acrescentados ao conteúdo do webhook.
serviceUri	string	o URI do serviço para Postar a notificação quando o alerta é ativado ou resolvido.

ThresholdRuleCondition

Uma condição de regra com base em uma métrica cruzando um limite.

Nome	Tipo	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	o recurso do qual a regra coleta seus dados. Para esse tipo, dataSource sempre será do tipo RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	especifica o tipo de condição. Esse pode ser um dos três tipos: ManagementEventRuleCondition (ocorrências de eventos de gerenciamento), LocationThresholdRuleCondition (com base no número de falhas de um teste na Web) e ThresholdRuleCondition (com base no limite de uma métrica).
operator	ConditionOperator	o operador usado para comparar os dados e o limite.
threshold	number	o valor limite que ativa o alerta.
timeAggregation	TimeAggregationOperator	o operador de agregação de tempo. Como os dados coletados devem ser combinados ao longo do tempo. O valor padrão é PrimaryAggregationType da Métrica.
windowSize	string	o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite. Se especificado, ele deverá estar entre 5 minutos e 1 dia.

TimeAggregationOperator

Operadores de agregação permitidos em uma regra.

Nome	Tipo	Description
Average	string
Last	string
Maximum	string
Minimum	string
Total	string