Alert Rules - Get

Servizio:

Monitor

Versione API:

2016-03-01

Ottiene una regola di avviso delle metriche classica

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
ruleName	path	True	string	Nome della regola.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	AlertRuleResource	Richiesta riuscita per ottenere una regola di avviso
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get an alert rule

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
AlertRuleResource	Risorsa regola di avviso.
ConditionOperator	Operatori consentiti nella condizione della regola.
ErrorResponse	Descrive il formato della risposta all'errore.
LocationThresholdRuleCondition	Condizione di regola basata su un determinato numero di posizioni non riuscite.
ManagementEventAggregationCondition	Definisce come i dati raccolti devono essere combinati nel tempo.
ManagementEventRuleCondition	Condizione della regola dell'evento di gestione.
RuleEmailAction	Specifica l'azione da inviare tramite posta elettronica quando viene valutata la condizione della regola. La discriminazione è sempre RuleEmailAction in questo caso.
RuleManagementEventClaimsDataSource	Attestazioni per un'origine dati dell'evento di gestione delle regole.
RuleManagementEventDataSource	Origine dati dell'evento di gestione delle regole. I campi di discriminazione sono sempre RuleManagementEventDataSource in questo caso.
RuleMetricDataSource	Origine dati della metrica delle regole. Il valore di discriminazione è sempre RuleMetricDataSource in questo caso.
RuleWebhookAction	Specifica l'azione da inviare al servizio quando viene valutata la condizione della regola. La discriminazione è sempre RuleWebhookAction in questo caso.
ThresholdRuleCondition	Condizione di regola basata su una metrica che supera una soglia.
TimeAggregationOperator	Operatori di aggregazione consentiti in una regola.

AlertRuleResource

Risorsa regola di avviso.

Nome	Tipo	Descrizione
id	string	ID risorsa di Azure
location	string	Posizione risorsa
name	string	Nome risorsa di Azure
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	azione eseguita quando la regola di avviso diventa attiva e quando viene risolta una condizione di avviso.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	matrice di azioni eseguite quando la regola di avviso diventa attiva e quando viene risolta una condizione di avviso.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	condizione che determina l'attivazione della regola di avviso.
properties.description	string	la descrizione della regola di avviso che verrà inclusa nel messaggio di posta elettronica di avviso.
properties.isEnabled	boolean	flag che indica se la regola di avviso è abilitata.
properties.lastUpdatedTime	string	Ultima volta che la regola è stata aggiornata nel formato ISO8601.
properties.name	string	nome della regola di avviso.
properties.provisioningState	string	stato di provisioning.
tags	object	Tag delle risorse
type	string	Tipo di risorsa di Azure

ConditionOperator

Operatori consentiti nella condizione della regola.

Nome	Tipo	Descrizione
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Descrive il formato della risposta all'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.

LocationThresholdRuleCondition

Condizione di regola basata su un determinato numero di posizioni non riuscite.

Nome	Tipo	Descrizione
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	risorsa da cui la regola raccoglie i dati. Per questo tipo dataSource sarà sempre di tipo RuleMetricDataSource.
failedLocationCount	integer	numero di posizioni che devono non riuscire ad attivare l'avviso.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	specifica il tipo di condizione. Questo può essere uno dei tre tipi: ManagementEventRuleCondition (occorrenze degli eventi di gestione), LocationThresholdRuleCondition (in base al numero di errori di un test Web) e ThresholdRuleCondition (in base alla soglia di una metrica).
windowSize	string	periodo di tempo (in formato di durata ISO 8601) usato per monitorare l'attività di avviso in base alla soglia. Se specificato, deve essere compreso tra 5 minuti e 1 giorno.

ManagementEventAggregationCondition

Definisce come i dati raccolti devono essere combinati nel tempo.

Nome	Tipo	Descrizione
operator	ConditionOperator	operatore condizione.
threshold	number	Valore soglia che attiva l'avviso.
windowSize	string	periodo di tempo (in formato di durata ISO 8601) usato per monitorare l'attività di avviso in base alla soglia. Se specificato, deve essere compreso tra 5 minuti e 1 giorno.

ManagementEventRuleCondition

Condizione della regola dell'evento di gestione.

Nome	Tipo	Descrizione
aggregation	ManagementEventAggregationCondition	Il modo in cui i dati raccolti devono essere combinati nel tempo e quando viene attivato l'avviso. Si noti che per gli avvisi di eventi di gestione l'elemento aggregation è facoltativo; se non viene fornito, qualsiasi evento determinerà l'attivazione dell'avviso.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	risorsa da cui la regola raccoglie i dati. Per questo tipo dataSource sarà sempre di tipo RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	specifica il tipo di condizione. Questo può essere uno dei tre tipi: ManagementEventRuleCondition (occorrenze degli eventi di gestione), LocationThresholdRuleCondition (in base al numero di errori di un test Web) e ThresholdRuleCondition (in base alla soglia di una metrica).

RuleEmailAction

Specifica l'azione da inviare tramite posta elettronica quando viene valutata la condizione della regola. La discriminazione è sempre RuleEmailAction in questo caso.

Nome	Tipo	Descrizione
customEmails	string[]	elenco degli indirizzi di posta elettronica personalizzati dell'amministratore per notificare l'attivazione dell'avviso.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	specifica il tipo dell'azione. Esistono due tipi di azioni: RuleEmailAction e RuleWebhookAction.
sendToServiceOwners	boolean	Indica se gli amministratori del servizio (inclusi i coamministratori) devono ricevere una notifica quando l'avviso viene attivato.

RuleManagementEventClaimsDataSource

Attestazioni per un'origine dati dell'evento di gestione delle regole.

Nome	Tipo	Descrizione
emailAddress	string	indirizzo di posta elettronica.

RuleManagementEventDataSource

Origine dati dell'evento di gestione delle regole. I campi di discriminazione sono sempre RuleManagementEventDataSource in questo caso.

Nome	Tipo	Descrizione
claims	RuleManagementEventClaimsDataSource	attestazioni.
eventName	string	nome dell'evento.
eventSource	string	origine evento.
legacyResourceId	string	identificatore di risorsa legacy della risorsa monitorata dalla regola. NOTA: questa proprietà non può essere aggiornata per una regola esistente.
level	string	livello.
metricNamespace	string	spazio dei nomi della metrica.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	specifica il tipo di origine dati. Esistono due tipi di origini dati delle regole: RuleMetricDataSource e RuleManagementEventDataSource
operationName	string	Nome dell'operazione che deve essere verificata. Se non viene fornito alcun nome, verrà restituita una corrispondenza per qualsiasi operazione.
resourceGroupName	string	nome del gruppo di risorse.
resourceLocation	string	posizione della risorsa.
resourceProviderName	string	nome del provider di risorse.
resourceUri	string	identificatore di risorsa della risorsa monitorata dalla regola. NOTA: questa proprietà non può essere aggiornata per una regola esistente.
status	string	Lo stato dell'operazione che deve essere verificata. Se non viene fornito alcuno stato, verrà restituita una corrispondenza per qualsiasi stato.
subStatus	string	substatus.

RuleMetricDataSource

Origine dati della metrica delle regole. Il valore di discriminazione è sempre RuleMetricDataSource in questo caso.

Nome	Tipo	Descrizione
legacyResourceId	string	identificatore di risorsa legacy della risorsa monitorata dalla regola. NOTA: questa proprietà non può essere aggiornata per una regola esistente.
metricName	string	nome della metrica che definisce il monitoraggio delle regole.
metricNamespace	string	spazio dei nomi della metrica.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	specifica il tipo di origine dati. Esistono due tipi di origini dati delle regole: RuleMetricDataSource e RuleManagementEventDataSource
resourceLocation	string	posizione della risorsa.
resourceUri	string	identificatore di risorsa della risorsa monitorata dalla regola. NOTA: questa proprietà non può essere aggiornata per una regola esistente.

RuleWebhookAction

Specifica l'azione da inviare al servizio quando viene valutata la condizione della regola. La discriminazione è sempre RuleWebhookAction in questo caso.

Nome	Tipo	Descrizione
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	specifica il tipo dell'azione. Esistono due tipi di azioni: RuleEmailAction e RuleWebhookAction.
properties	object	dizionario delle proprietà personalizzate da includere con l'operazione post. Questi dati vengono aggiunti al payload del webhook.
serviceUri	string	l'uri del servizio per pubblicare la notifica quando l'avviso viene attivato o risolto.

ThresholdRuleCondition

Condizione di regola basata su una metrica che supera una soglia.

Nome	Tipo	Descrizione
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	risorsa da cui la regola raccoglie i dati. Per questo tipo dataSource sarà sempre di tipo RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	specifica il tipo di condizione. Questo può essere uno dei tre tipi: ManagementEventRuleCondition (occorrenze degli eventi di gestione), LocationThresholdRuleCondition (in base al numero di errori di un test Web) e ThresholdRuleCondition (in base alla soglia di una metrica).
operator	ConditionOperator	operatore usato per confrontare i dati e la soglia.
threshold	number	valore soglia che attiva l'avviso.
timeAggregation	TimeAggregationOperator	Operatore di aggregazione temporale. In che modo i dati raccolti devono essere combinati nel tempo. Il valore predefinito è PrimaryAggregationType della metrica.
windowSize	string	periodo di tempo (in formato di durata ISO 8601) usato per monitorare l'attività di avviso in base alla soglia. Se specificato, deve essere compreso tra 5 minuti e 1 giorno.

TimeAggregationOperator

Operatori di aggregazione consentiti in una regola.

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