Alert Rules - Get

Service:

Monitor

API Version:

2016-03-01

Klasszikus metrikariasztási szabály beolvasása

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
ruleName	path	True	string	A szabály neve.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	AlertRuleResource	Sikeres kérés riasztási szabály lekéréséhez
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Get an alert rule

Sample Request

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 System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Monitor;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;

// 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 AlertRuleResource created on azure
// for more information of creating AlertRuleResource, please refer to the document of AlertRuleResource
string subscriptionId = "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
string resourceGroupName = "Rac46PostSwapRG";
string ruleName = "chiricutin";
ResourceIdentifier alertRuleResourceId = AlertRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ruleName);
AlertRuleResource alertRule = client.GetAlertRuleResource(alertRuleResourceId);

// invoke the operation
AlertRuleResource result = await alertRule.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
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

Sample Response

Status code:

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

Definíciók

Name	Description
AlertRuleResource	A riasztási szabály erőforrása.
ConditionOperator	A szabályfeltételben engedélyezett operátorok.
ErrorResponse	A hibaválasz formátumát ismerteti.
LocationThresholdRuleCondition	Egy szabályfeltétel, amely bizonyos számú sikertelen hely alapján meghiúsul.
ManagementEventAggregationCondition	Az összegyűjtött adatok időbeli összevonásának módját.
ManagementEventRuleCondition	Egy felügyeleti eseményszabály feltétele.
RuleEmailAction	Megadja azt a műveletet, amelyet e-mailben szeretne küldeni a szabályfeltétel kiértékelésekor. Ebben az esetben a diszkriminatív a RuleEmailAction.
RuleManagementEventClaimsDataSource	Szabálykezelési esemény adatforrásának jogcíme.
RuleManagementEventDataSource	Szabálykezelési esemény adatforrása. A diszkriminatív mezők mindig RuleManagementEventDataSource ebben az esetben.
RuleMetricDataSource	Szabálymetrika adatforrása. Ebben az esetben a diszkriminatív érték mindig RuleMetricDataSource.
RuleWebhookAction	Megadja a szolgáltatásba a szabályfeltétel kiértékelésekor közzéteendő műveletet. Ebben az esetben a diszkriminatív a RuleWebhookAction.
ThresholdRuleCondition	Egy küszöbértéket átlépő metrikán alapuló szabályfeltétel.
TimeAggregationOperator	A szabályban engedélyezett összesítési operátorok.

AlertRuleResource

A riasztási szabály erőforrása.

Name	Típus	Description
id	string	Azure-erőforrás azonosítója
location	string	Erőforrás helye
name	string	Azure-erőforrás neve
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	művelet, amelyet a riasztási szabály aktívvá válásakor és egy riasztási feltétel feloldásakor hajtanak végre.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	a riasztási szabály aktívvá válásakor és egy riasztási feltétel feloldásakor végrehajtott műveletek tömbje.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	az a feltétel, amely a riasztási szabály aktiválását eredményezi.
properties.description	string	a riasztási szabály leírása, amely szerepelni fog a riasztási e-mailben.
properties.isEnabled	boolean	a riasztási szabály engedélyezését jelző jelző.
properties.lastUpdatedTime	string	A szabály legutóbbi frissítése ISO8601 formátumban.
properties.name	string	a riasztási szabály neve.
properties.provisioningState	string	a kiépítési állapotot.
tags	object	Erőforráscímkék
type	string	Azure-erőforrástípus

ConditionOperator

A szabályfeltételben engedélyezett operátorok.

Name	Típus	Description
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

A hibaválasz formátumát ismerteti.

Name	Típus	Description
code	string	Hibakód
message	string	Hibaüzenet jelzi, hogy a művelet miért nem sikerült.

LocationThresholdRuleCondition

Egy szabályfeltétel, amely bizonyos számú sikertelen hely alapján meghiúsul.

Name	Típus	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	az erőforrás, amelyből a szabály gyűjti az adatait. Ehhez a típushoz a dataSource mindig RuleMetricDataSource típusú lesz.
failedLocationCount	integer	azon helyek száma, amelyeknek nem kell aktiválni a riasztást.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	a feltétel típusát határozza meg. Ez a következő három típus egyike lehet: ManagementEventRuleCondition (felügyeleti események előfordulásai), LocationThresholdRuleCondition (egy webes teszt hibáinak száma alapján) és ThresholdRuleCondition (egy metrika küszöbértéke alapján).
windowSize	string	a riasztási tevékenység küszöbértéken alapuló figyelésére használt időtartam (ISO 8601-es időtartamformátumban). Ha meg van adva, akkor 5 perc és 1 nap között kell lennie.

ManagementEventAggregationCondition

Az összegyűjtött adatok időbeli összevonásának módját.

Name	Típus	Description
operator	ConditionOperator	a feltétel operátor.
threshold	number	A riasztást aktiváló küszöbérték.
windowSize	string	a riasztási tevékenység küszöbértéken alapuló figyelésére használt időtartam (ISO 8601-es időtartamformátumban). Ha meg van adva, akkor 5 perc és 1 nap között kell lennie.

ManagementEventRuleCondition

Egy felügyeleti eseményszabály feltétele.

Name	Típus	Description
aggregation	ManagementEventAggregationCondition	Az összegyűjtött adatokat az idő múlásával és a riasztás aktiválásának időpontjával kell kombinálni. Vegye figyelembe, hogy a felügyeleti eseményriasztások összesítése nem kötelező – ha nincs megadva, akkor bármely esemény aktiválja a riasztást.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	az erőforrás, amelyből a szabály gyűjti az adatait. Ehhez a típushoz a dataSource mindig RuleMetricDataSource típusú lesz.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	a feltétel típusát határozza meg. Ez a következő három típus egyike lehet: ManagementEventRuleCondition (felügyeleti események előfordulásai), LocationThresholdRuleCondition (egy webes teszt hibáinak száma alapján) és ThresholdRuleCondition (egy metrika küszöbértéke alapján).

RuleEmailAction

Megadja azt a műveletet, amelyet e-mailben szeretne küldeni a szabályfeltétel kiértékelésekor. Ebben az esetben a diszkriminatív a RuleEmailAction.

Name	Típus	Description
customEmails	string[]	a rendszergazda egyéni e-mail-címeinek listája a riasztás aktiválásáról való értesítéshez.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	A művelet típusát adja meg. Kétféle művelet létezik: RuleEmailAction és RuleWebhookAction.
sendToServiceOwners	boolean	Arról, hogy a szolgáltatás rendszergazdáinak (szolgáltatásának és társadminisztrátorainak) értesítést kell-e kapniuk a riasztás aktiválásakor.

RuleManagementEventClaimsDataSource

Szabálykezelési esemény adatforrásának jogcíme.

Name	Típus	Description
emailAddress	string	az e-mail-cím.

RuleManagementEventDataSource

Szabálykezelési esemény adatforrása. A diszkriminatív mezők mindig RuleManagementEventDataSource ebben az esetben.

Name	Típus	Description
claims	RuleManagementEventClaimsDataSource	a jogcímeket.
eventName	string	az esemény neve.
eventSource	string	az eseményforrás.
legacyResourceId	string	a szabály által figyelt erőforrás örökölt erőforrás-azonosítója. MEGJEGYZÉS: ez a tulajdonság egy meglévő szabály esetében nem frissíthető.
level	string	a szint.
metricNamespace	string	a metrika névterét.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	az adatforrás típusát határozza meg. Kétféle szabályadatforrás létezik: RuleMetricDataSource és RuleManagementEventDataSource
operationName	string	Annak a műveletnek a neve, amelyet ellenőrizni kell. Ha nincs megadva név, a művelet megfelel.
resourceGroupName	string	az erőforráscsoport neve.
resourceLocation	string	az erőforrás helye.
resourceProviderName	string	az erőforrás-szolgáltató neve.
resourceUri	string	a szabály által figyelt erőforrás erőforrás-azonosítója. MEGJEGYZÉS: ez a tulajdonság egy meglévő szabály esetében nem frissíthető.
status	string	Annak a műveletnek az állapota, amelyet ellenőrizni kell. Ha nincs megadva állapot, az állapot megegyezik.
subStatus	string	az alállapot.

RuleMetricDataSource

Szabálymetrika adatforrása. Ebben az esetben a diszkriminatív érték mindig RuleMetricDataSource.

Name	Típus	Description
legacyResourceId	string	a szabály által figyelt erőforrás örökölt erőforrás-azonosítója. MEGJEGYZÉS: ez a tulajdonság egy meglévő szabály esetében nem frissíthető.
metricName	string	a szabály által figyelt metrika neve.
metricNamespace	string	a metrika névterét.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	az adatforrás típusát határozza meg. Kétféle szabályadatforrás létezik: RuleMetricDataSource és RuleManagementEventDataSource
resourceLocation	string	az erőforrás helye.
resourceUri	string	a szabály által figyelt erőforrás erőforrás-azonosítója. MEGJEGYZÉS: ez a tulajdonság egy meglévő szabály esetében nem frissíthető.

RuleWebhookAction

Megadja a szolgáltatásba a szabályfeltétel kiértékelésekor közzéteendő műveletet. Ebben az esetben a diszkriminatív a RuleWebhookAction.

Name	Típus	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	A művelet típusát adja meg. Kétféle művelet létezik: RuleEmailAction és RuleWebhookAction.
properties	object	a post művelethez felvenni kívánt egyéni tulajdonságok szótárát. Ezek az adatok hozzá vannak fűzve a webhook hasznos adataihoz.
serviceUri	string	a szolgáltatás URI-ja az Értesítés közzététele a riasztás aktiválásakor vagy feloldásakor.

ThresholdRuleCondition

Egy küszöbértéket átlépő metrikán alapuló szabályfeltétel.

Name	Típus	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	az erőforrás, amelyből a szabály gyűjti az adatait. Ehhez a típushoz a dataSource mindig RuleMetricDataSource típusú lesz.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	a feltétel típusát határozza meg. Ez a következő három típus egyike lehet: ManagementEventRuleCondition (felügyeleti események előfordulásai), LocationThresholdRuleCondition (egy webes teszt hibáinak száma alapján) és ThresholdRuleCondition (egy metrika küszöbértéke alapján).
operator	ConditionOperator	az operátor, amelyet az adatok és a küszöbérték összehasonlítására használtak.
threshold	number	a riasztást aktiváló küszöbérték.
timeAggregation	TimeAggregationOperator	az időösszesítési operátor. Az összegyűjtött adatok időbeli összevonásának módját. Az alapértelmezett érték a metrika PrimaryAggregationType értéke.
windowSize	string	a riasztási tevékenység küszöbértéken alapuló figyelésére használt időtartam (ISO 8601-es időtartamformátumban). Ha meg van adva, akkor 5 perc és 1 nap között kell lennie.

TimeAggregationOperator

A szabályban engedélyezett összesítési operátorok.

Name	Típus	Description
Average	string
Last	string
Maximum	string
Minimum	string
Total	string