Alert Rules - Get

Dienst:

Monitor

API-Version:

2016-03-01

Ruft eine klassische Metrikwarnungsregel ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
ruleName	path	True	string	Der Name der Regel.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	AlertRuleResource	Erfolgreiche Anforderung zum Abrufen einer Warnungsregel
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get an alert rule

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AlertRuleResource	Die Warnungsregelressource.
ConditionOperator	In der Regelbedingung zulässige Operatoren.
ErrorResponse	Beschreibt das Format der Fehlerantwort.
LocationThresholdRuleCondition	Eine Regelbedingung, die auf einer bestimmten Anzahl von Speicherorten basiert, die fehlschlägt.
ManagementEventAggregationCondition	Legt fest, wie die erfassten Daten im Zeitverlauf kombiniert werden sollen.
ManagementEventRuleCondition	Eine Regelbedingung für Verwaltungsereignisse.
RuleEmailAction	Gibt die Aktion zum Senden von E-Mails an, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleEmailAction.
RuleManagementEventClaimsDataSource	Die Ansprüche für eine Regelverwaltungsereignis-Datenquelle.
RuleManagementEventDataSource	Eine Ereignisdatenquelle für die Regelverwaltung. Die Diskriminatorfelder sind in diesem Fall immer RuleManagementEventDataSource.
RuleMetricDataSource	Eine Regelmetrik-Datenquelle. Der Diskriminatorwert ist in diesem Fall immer RuleMetricDataSource.
RuleWebhookAction	Gibt die Aktion an, die im Dienst bereitgestellt werden soll, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleWebhookAction.
ThresholdRuleCondition	Eine Regelbedingung, die auf einer Metrik basiert, die einen Schwellenwert überschreitet.
TimeAggregationOperator	In einer Regel zulässige Aggregationsoperatoren.

AlertRuleResource

Die Warnungsregelressource.

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID
location	string	Ressourcenspeicherort
name	string	Name der Azure-Ressource
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	Aktion, die ausgeführt wird, wenn die Warnungsregel aktiv wird und eine Warnungsbedingung aufgelöst wird.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	das Array von Aktionen, die ausgeführt werden, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	Die Bedingung, die dazu führt, dass die Warnungsregel aktiviert wird.
properties.description	string	Die Beschreibung der Warnungsregel, die in der Warnungs-E-Mail enthalten sein wird.
properties.isEnabled	boolean	das Flag, das angibt, ob die Warnungsregel aktiviert ist.
properties.lastUpdatedTime	string	Das letzte Mal wurde die Regel im ISO8601 Format aktualisiert.
properties.name	string	der Name der Warnungsregel.
properties.provisioningState	string	den Bereitstellungsstatus.
tags	object	Ressourcentags
type	string	Azure-Ressourcentyp

ConditionOperator

In der Regelbedingung zulässige Operatoren.

Name	Typ	Beschreibung
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

LocationThresholdRuleCondition

Eine Regelbedingung, die auf einer bestimmten Anzahl von Speicherorten basiert, die fehlschlägt.

Name	Typ	Beschreibung
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	die Ressource, aus der die Regel ihre Daten sammelt. Für diesen Typ ist dataSource immer vom Typ RuleMetricDataSource.
failedLocationCount	integer	Die Anzahl der Speicherorte, an denen die Warnung nicht aktiviert werden kann.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	gibt den Typ der Bedingung an. Dies kann einer von drei Typen sein: ManagementEventRuleCondition (Vorkommen von Verwaltungsereignissen), LocationThresholdRuleCondition (basierend auf der Anzahl der Fehler eines Webtests) und ThresholdRuleCondition (basierend auf dem Schwellenwert einer Metrik).
windowSize	string	der Zeitraum (im ISO 8601-Dauerformat), der zum Überwachen der Warnungsaktivität basierend auf dem Schwellenwert verwendet wird. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag sein.

ManagementEventAggregationCondition

Legt fest, wie die erfassten Daten im Zeitverlauf kombiniert werden sollen.

Name	Typ	Beschreibung
operator	ConditionOperator	der Bedingungsoperator.
threshold	number	Der Schwellenwert, der die Warnung aktiviert.
windowSize	string	der Zeitraum (im ISO 8601-Dauerformat), der zum Überwachen der Warnungsaktivität basierend auf dem Schwellenwert verwendet wird. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag sein.

ManagementEventRuleCondition

Eine Regelbedingung für Verwaltungsereignisse.

Name	Typ	Beschreibung
aggregation	ManagementEventAggregationCondition	Wie die gesammelten Daten im Laufe der Zeit kombiniert werden sollen und wann die Warnung aktiviert wird. Beachten Sie, dass die Aggregation von Warnungen für Verwaltungsereignisse optional ist. Wenn sie nicht bereitgestellt wird, führt jedes Ereignis zu einer Aktivierung der Warnung.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	die Ressource, aus der die Regel ihre Daten sammelt. Für diesen Typ ist dataSource immer vom Typ RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	gibt den Typ der Bedingung an. Dies kann einer von drei Typen sein: ManagementEventRuleCondition (Vorkommen von Verwaltungsereignissen), LocationThresholdRuleCondition (basierend auf der Anzahl der Fehler eines Webtests) und ThresholdRuleCondition (basierend auf dem Schwellenwert einer Metrik).

RuleEmailAction

Gibt die Aktion zum Senden von E-Mails an, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleEmailAction.

Name	Typ	Beschreibung
customEmails	string[]	die Liste der benutzerdefinierten E-Mail-Adressen des Administrators, um über die Aktivierung der Warnung zu informieren.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	gibt den Typ der Aktion an. Es gibt zwei Arten von Aktionen: RuleEmailAction und RuleWebhookAction.
sendToServiceOwners	boolean	Gibt an, ob die Administratoren (Dienst- und Co-Administratoren) des Diensts benachrichtigt werden sollen, wenn die Warnung aktiviert wurde.

RuleManagementEventClaimsDataSource

Die Ansprüche für eine Regelverwaltungsereignis-Datenquelle.

Name	Typ	Beschreibung
emailAddress	string	die E-Mail-Adresse.

RuleManagementEventDataSource

Eine Ereignisdatenquelle für die Regelverwaltung. Die Diskriminatorfelder sind in diesem Fall immer RuleManagementEventDataSource.

Name	Typ	Beschreibung
claims	RuleManagementEventClaimsDataSource	die Ansprüche.
eventName	string	der Ereignisname.
eventSource	string	die Ereignisquelle.
legacyResourceId	string	Der Legacyressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann für eine vorhandene Regel nicht aktualisiert werden.
level	string	die Ebene.
metricNamespace	string	der Namespace der Metrik.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	gibt den Typ der Datenquelle an. Es gibt zwei Arten von Regeldatenquellen: RuleMetricDataSource und RuleManagementEventDataSource
operationName	string	Der Name des zu prüfenden Vorgangs. Wenn kein Name angegeben ist, wird jeder Vorgang verglichen.
resourceGroupName	string	der Name der Ressourcengruppe.
resourceLocation	string	der Speicherort der Ressource.
resourceProviderName	string	der Name des Ressourcenanbieters.
resourceUri	string	Der Ressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann für eine vorhandene Regel nicht aktualisiert werden.
status	string	Der Status des zu prüfenden Vorgangs. Wenn kein Status angegeben ist, wird jeder Status verglichen.
subStatus	string	den Unterstatus.

RuleMetricDataSource

Eine Regelmetrik-Datenquelle. Der Diskriminatorwert ist in diesem Fall immer RuleMetricDataSource.

Name	Typ	Beschreibung
legacyResourceId	string	Der Legacyressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann für eine vorhandene Regel nicht aktualisiert werden.
metricName	string	der Name der Metrik, die definiert, was die Regel überwacht.
metricNamespace	string	der Namespace der Metrik.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	gibt den Typ der Datenquelle an. Es gibt zwei Arten von Regeldatenquellen: RuleMetricDataSource und RuleManagementEventDataSource
resourceLocation	string	der Speicherort der Ressource.
resourceUri	string	Der Ressourcenbezeichner der Ressource, die von der Regel überwacht wird. HINWEIS: Diese Eigenschaft kann für eine vorhandene Regel nicht aktualisiert werden.

RuleWebhookAction

Gibt die Aktion an, die im Dienst bereitgestellt werden soll, wenn die Regelbedingung ausgewertet wird. Der Diskriminator ist in diesem Fall immer RuleWebhookAction.

Name	Typ	Beschreibung
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	gibt den Typ der Aktion an. Es gibt zwei Arten von Aktionen: RuleEmailAction und RuleWebhookAction.
properties	object	das Wörterbuch der benutzerdefinierten Eigenschaften, die in den post-Vorgang eingeschlossen werden sollen. Diese Daten werden an die Webhooknutzlast angefügt.
serviceUri	string	der Dienst-URI, um die Benachrichtigung zu posten, wenn die Warnung aktiviert oder aufgelöst wird.

ThresholdRuleCondition

Eine Regelbedingung, die auf einer Metrik basiert, die einen Schwellenwert überschreitet.

Name	Typ	Beschreibung
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	die Ressource, aus der die Regel ihre Daten sammelt. Für diesen Typ ist dataSource immer vom Typ RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	gibt den Typ der Bedingung an. Dies kann einer von drei Typen sein: ManagementEventRuleCondition (Vorkommen von Verwaltungsereignissen), LocationThresholdRuleCondition (basierend auf der Anzahl der Fehler eines Webtests) und ThresholdRuleCondition (basierend auf dem Schwellenwert einer Metrik).
operator	ConditionOperator	der Operator, der zum Vergleichen der Daten und des Schwellenwerts verwendet wird.
threshold	number	der Schwellenwert, der die Warnung aktiviert.
timeAggregation	TimeAggregationOperator	der Zeitaggregationsoperator. Wie die gesammelten Daten im Laufe der Zeit kombiniert werden sollen. Der Standardwert ist der PrimaryAggregationType der Metrik.
windowSize	string	der Zeitraum (im ISO 8601-Dauerformat), der zum Überwachen der Warnungsaktivität basierend auf dem Schwellenwert verwendet wird. Wenn angegeben, muss es zwischen 5 Minuten und 1 Tag sein.

TimeAggregationOperator

In einer Regel zulässige Aggregationsoperatoren.

Name	Typ	Beschreibung
Average	string
Last	string
Maximum	string
Minimum	string
Total	string