Alert Rules - Get

Service:

Monitor

Version d'API:

2016-03-01

Obtient une règle d’alerte de métrique classique

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
ruleName	path	True	string	nom de la règle.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	AlertRuleResource	Demande d’obtention d’une règle d’alerte réussie
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Get an alert rule

Exemple de requête

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

Exemple de réponse

Code d’état:

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": []
  }
}

Définitions

Nom	Description
AlertRuleResource	Ressource de règle d’alerte.
ConditionOperator	Opérateurs autorisés dans la condition de règle.
ErrorResponse	Décrit le format de la réponse d’erreur.
LocationThresholdRuleCondition	Condition de règle basée sur un certain nombre d’emplacements défaillants.
ManagementEventAggregationCondition	Détermine la façon dont les données collectées doivent être combinées au fil du temps.
ManagementEventRuleCondition	Condition de règle d’événement de gestion.
RuleEmailAction	Spécifie l’action à envoyer un e-mail lorsque la condition de règle est évaluée. Le discriminateur est toujours RuleEmailAction dans ce cas.
RuleManagementEventClaimsDataSource	Revendications d’une source de données d’événements de gestion de règles.
RuleManagementEventDataSource	Source de données d’événements de gestion des règles. Les champs du discriminateur sont toujours RuleManagementEventDataSource dans ce cas.
RuleMetricDataSource	Source de données de métrique de règle. La valeur du discriminateur est toujours RuleMetricDataSource dans ce cas.
RuleWebhookAction	Spécifie l’action à publier dans le service lorsque la condition de règle est évaluée. Le discriminateur est toujours RuleWebhookAction dans ce cas.
ThresholdRuleCondition	Condition de règle basée sur une métrique dépassant un seuil.
TimeAggregationOperator	Opérateurs d’agrégation autorisés dans une règle.

AlertRuleResource

Ressource de règle d’alerte.

Nom	Type	Description
id	string	ID de ressource Azure
location	string	Emplacement de la ressource
name	string	Nom de la ressource Azure
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	action effectuée lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	condition qui entraîne l’activation de la règle d’alerte.
properties.description	string	description de la règle d’alerte qui sera incluse dans l’e-mail d’alerte.
properties.isEnabled	boolean	Indicateur qui indique si la règle d’alerte est activée.
properties.lastUpdatedTime	string	La dernière fois que la règle a été mise à jour dans ISO8601 format.
properties.name	string	nom de la règle d’alerte.
properties.provisioningState	string	état d’approvisionnement.
tags	object	Balises de ressource
type	string	Type de ressource Azure

ConditionOperator

Opérateurs autorisés dans la condition de règle.

Nom	Type	Description
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Décrit le format de la réponse d’erreur.

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

LocationThresholdRuleCondition

Condition de règle basée sur un certain nombre d’emplacements défaillants.

Nom	Type	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource.
failedLocationCount	integer	nombre d’emplacements qui ne peuvent pas activer l’alerte.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	spécifie le type de condition. Il peut s’agir de l’un des trois types suivants : ManagementEventRuleCondition (occurrences d’événements de gestion), LocationThresholdRuleCondition (basé sur le nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique).
windowSize	string	la période (au format de durée ISO 8601) utilisée pour surveiller l’activité des alertes en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour.

ManagementEventAggregationCondition

Détermine la façon dont les données collectées doivent être combinées au fil du temps.

Nom	Type	Description
operator	ConditionOperator	opérateur de condition.
threshold	number	Valeur de seuil qui active l'alerte.
windowSize	string	la période (au format de durée ISO 8601) utilisée pour surveiller l’activité des alertes en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour.

ManagementEventRuleCondition

Condition de règle d’événement de gestion.

Nom	Type	Description
aggregation	ManagementEventAggregationCondition	Comment les données collectées doivent être combinées au fil du temps et quand l’alerte est activée. Notez que, pour les alertes d'événement de gestion, l'agrégation est facultative. Si elle n'est pas spécifiée, tout événement entraîne l'activation de l'alerte.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	spécifie le type de condition. Il peut s’agir de l’un des trois types suivants : ManagementEventRuleCondition (occurrences d’événements de gestion), LocationThresholdRuleCondition (basé sur le nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique).

RuleEmailAction

Spécifie l’action à envoyer un e-mail lorsque la condition de règle est évaluée. Le discriminateur est toujours RuleEmailAction dans ce cas.

Nom	Type	Description
customEmails	string[]	liste des adresses e-mail personnalisées de l’administrateur à notifier de l’activation de l’alerte.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction.
sendToServiceOwners	boolean	Indique si les administrateurs (et coadministrateurs) du service doivent être avertis lors de l'activation de l'alerte.

RuleManagementEventClaimsDataSource

Revendications d’une source de données d’événements de gestion de règles.

Nom	Type	Description
emailAddress	string	adresse e-mail.

RuleManagementEventDataSource

Source de données d’événements de gestion des règles. Les champs du discriminateur sont toujours RuleManagementEventDataSource dans ce cas.

Nom	Type	Description
claims	RuleManagementEventClaimsDataSource	les revendications.
eventName	string	nom de l’événement.
eventSource	string	source de l’événement.
legacyResourceId	string	identificateur de ressource hérité de la ressource surveillée par la règle. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante.
level	string	niveau.
metricNamespace	string	espace de noms de la métrique.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource
operationName	string	Nom de l'opération à véfifier. Si aucun nom n'est spécifié, toute opération est concernée.
resourceGroupName	string	nom du groupe de ressources.
resourceLocation	string	emplacement de la ressource.
resourceProviderName	string	nom du fournisseur de ressources.
resourceUri	string	identificateur de ressource de la ressource surveillée par la règle. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante.
status	string	État de l'opération à vérifier. Si aucun état n'est spécifié, toute état est concerné.
subStatus	string	sous-état.

RuleMetricDataSource

Source de données de métrique de règle. La valeur du discriminateur est toujours RuleMetricDataSource dans ce cas.

Nom	Type	Description
legacyResourceId	string	identificateur de ressource hérité de la ressource surveillée par la règle. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante.
metricName	string	nom de la métrique qui définit ce que la règle surveille.
metricNamespace	string	espace de noms de la métrique.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource
resourceLocation	string	emplacement de la ressource.
resourceUri	string	identificateur de ressource de la ressource surveillée par la règle. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante.

RuleWebhookAction

Spécifie l’action à publier dans le service lorsque la condition de règle est évaluée. Le discriminateur est toujours RuleWebhookAction dans ce cas.

Nom	Type	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction.
properties	object	dictionnaire de propriétés personnalisées à inclure dans l’opération de publication. Ces données sont ajoutées à la charge utile du webhook.
serviceUri	string	URI de service pour publier la notification lorsque l’alerte s’active ou se résout.

ThresholdRuleCondition

Condition de règle basée sur une métrique dépassant un seuil.

Nom	Type	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	spécifie le type de condition. Il peut s’agir de l’un des trois types suivants : ManagementEventRuleCondition (occurrences d’événements de gestion), LocationThresholdRuleCondition (basé sur le nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique).
operator	ConditionOperator	opérateur utilisé pour comparer les données et le seuil.
threshold	number	valeur de seuil qui active l’alerte.
timeAggregation	TimeAggregationOperator	opérateur d’agrégation de temps. Comment les données collectées doivent être combinées au fil du temps. La valeur par défaut est PrimaryAggregationType de la métrique.
windowSize	string	la période (au format de durée ISO 8601) utilisée pour surveiller l’activité des alertes en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour.

TimeAggregationOperator

Opérateurs d’agrégation autorisés dans une règle.

Nom	Type	Description
Average	string
Last	string
Maximum	string
Minimum	string
Total	string