Alert Rules - Get

Service:

Monitor

API Version:

2016-03-01

Získá klasické pravidlo upozornění na metriku.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
ruleName	path	True	string	Název pravidla.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	AlertRuleResource	Úspěšná žádost o získání pravidla upozornění
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
AlertRuleResource	Prostředek pravidla upozornění.
ConditionOperator	Operátory povolené v podmínce pravidla
ErrorResponse	Popisuje formát chybové odpovědi.
LocationThresholdRuleCondition	Podmínka pravidla založená na určitém počtu umístění, která selhávají.
ManagementEventAggregationCondition	Způsob kombinování shromážděných dat v průběhu času
ManagementEventRuleCondition	Podmínka pravidla události správy.
RuleEmailAction	Určuje akci pro odeslání e-mailu při vyhodnocení podmínky pravidla. V tomto případě je diskriminátorem vždy RuleEmailAction.
RuleManagementEventClaimsDataSource	Deklarace identity zdroje dat událostí správy pravidel
RuleManagementEventDataSource	Zdroj dat událostí správy pravidel. V tomto případě jsou v tomto případě vždy diskriminovaná pole RuleManagementEventDataSource.
RuleMetricDataSource	Zdroj dat metriky pravidla. V tomto případě je vždy diskriminační hodnota RuleMetricDataSource.
RuleWebhookAction	Určuje akci, která se má odeslat do služby při vyhodnocení podmínky pravidla. V tomto případě je diskriminátorem vždy RuleWebhookAction.
ThresholdRuleCondition	Podmínka pravidla založená na metrikě překračující prahovou hodnotu.
TimeAggregationOperator	Operátory agregace povolené v pravidle

AlertRuleResource

Prostředek pravidla upozornění.

Name	Typ	Description
id	string	ID prostředku Azure
location	string	Umístění prostředku
name	string	Název prostředku Azure
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	akce, která se provede, když se pravidlo upozornění aktivuje a když se vyřeší podmínka upozornění.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	pole akcí, které se provádějí, když se pravidlo upozornění aktivuje a kdy se vyřeší podmínka upozornění.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	podmínka, která má za následek aktivaci pravidla upozornění.
properties.description	string	popis pravidla upozornění, které bude součástí e-mailu s upozorněním.
properties.isEnabled	boolean	příznak označující, jestli je pravidlo upozornění povolené.
properties.lastUpdatedTime	string	Čas poslední aktualizace pravidla ve formátu ISO8601
properties.name	string	název pravidla upozornění.
properties.provisioningState	string	stav zřizování.
tags	object	Značky prostředků
type	string	Typ prostředku Azure

ConditionOperator

Operátory povolené v podmínce pravidla

Name	Typ	Description
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Popisuje formát chybové odpovědi.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

LocationThresholdRuleCondition

Podmínka pravidla založená na určitém počtu umístění, která selhávají.

Name	Typ	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	prostředek, ze kterého pravidlo shromažďuje svá data. Pro tento typ bude dataSource vždy typu RuleMetricDataSource.
failedLocationCount	integer	počet umístění, u kterých se musí nezdařit aktivace výstrahy.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	určuje typ podmínky. Může to být jeden ze tří typů: ManagementEventRuleCondition (výskyty událostí správy), LocationThresholdRuleCondition (na základě počtu selhání webového testu) a ThresholdRuleCondition (na základě prahové hodnoty metriky).
windowSize	string	časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity upozornění na základě prahové hodnoty. Pokud je zadaný, musí to být 5 minut až 1 den.

ManagementEventAggregationCondition

Způsob kombinování shromážděných dat v průběhu času

Name	Typ	Description
operator	ConditionOperator	operátor podmínky.
threshold	number	Prahová hodnota, která aktivuje výstrahu.
windowSize	string	časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity upozornění na základě prahové hodnoty. Pokud je zadaný, musí to být 5 minut až 1 den.

ManagementEventRuleCondition

Podmínka pravidla události správy.

Name	Typ	Description
aggregation	ManagementEventAggregationCondition	Způsob kombinování shromážděných dat v průběhu času a při aktivaci výstrahy Všimněte si, že pro správu je agregace upozornění na události volitelná – pokud není k dispozici, jakákoli událost způsobí aktivaci výstrahy.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	prostředek, ze kterého pravidlo shromažďuje svá data. Pro tento typ bude dataSource vždy typu RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	určuje typ podmínky. Může to být jeden ze tří typů: ManagementEventRuleCondition (výskyty událostí správy), LocationThresholdRuleCondition (na základě počtu selhání webového testu) a ThresholdRuleCondition (na základě prahové hodnoty metriky).

RuleEmailAction

Určuje akci pro odeslání e-mailu při vyhodnocení podmínky pravidla. V tomto případě je diskriminátorem vždy RuleEmailAction.

Name	Typ	Description
customEmails	string[]	seznam vlastních e-mailových adres správce pro upozornění na aktivaci výstrahy.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	určuje typ akce. Existují dva typy akcí: RuleEmailAction a RuleWebhookAction.
sendToServiceOwners	boolean	Jestli mají být správci (služby a spolusprávci) služby při aktivaci výstrahy upozorněni.

RuleManagementEventClaimsDataSource

Deklarace identity zdroje dat událostí správy pravidel

Name	Typ	Description
emailAddress	string	e-mailovou adresu.

RuleManagementEventDataSource

Zdroj dat událostí správy pravidel. V tomto případě jsou v tomto případě vždy diskriminovaná pole RuleManagementEventDataSource.

Name	Typ	Description
claims	RuleManagementEventClaimsDataSource	nároky.
eventName	string	název události.
eventSource	string	zdroj události.
legacyResourceId	string	identifikátor starší verze prostředku, který pravidlo monitoruje. POZNÁMKA: Tuto vlastnost nelze aktualizovat pro existující pravidlo.
level	string	úroveň.
metricNamespace	string	obor názvů metriky.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	určuje typ zdroje dat. Existují dva typy zdrojů dat pravidel: RuleMetricDataSource a RuleManagementEventDataSource
operationName	string	Název operace, kterou je třeba zkontrolovat. Pokud není zadaný žádný název, budou se všechny operace shodovat.
resourceGroupName	string	název skupiny prostředků.
resourceLocation	string	umístění prostředku.
resourceProviderName	string	název poskytovatele prostředků.
resourceUri	string	identifikátor prostředku, který pravidlo monitoruje. POZNÁMKA: Tuto vlastnost nelze aktualizovat pro existující pravidlo.
status	string	Stav operace, kterou je třeba zkontrolovat. Pokud není zadaný žádný stav, jakýkoli stav se bude shodovat.
subStatus	string	dílčí stav.

RuleMetricDataSource

Zdroj dat metriky pravidla. V tomto případě je vždy diskriminační hodnota RuleMetricDataSource.

Name	Typ	Description
legacyResourceId	string	identifikátor starší verze prostředku, který pravidlo monitoruje. POZNÁMKA: Tuto vlastnost nelze aktualizovat pro existující pravidlo.
metricName	string	název metriky, která definuje, co pravidlo monitoruje.
metricNamespace	string	obor názvů metriky.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	určuje typ zdroje dat. Existují dva typy zdrojů dat pravidel: RuleMetricDataSource a RuleManagementEventDataSource
resourceLocation	string	umístění prostředku.
resourceUri	string	identifikátor prostředku, který pravidlo monitoruje. POZNÁMKA: Tuto vlastnost nelze aktualizovat pro existující pravidlo.

RuleWebhookAction

Určuje akci, která se má odeslat do služby při vyhodnocení podmínky pravidla. V tomto případě je diskriminátorem vždy RuleWebhookAction.

Name	Typ	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	určuje typ akce. Existují dva typy akcí: RuleEmailAction a RuleWebhookAction.
properties	object	slovník vlastních vlastností, které se mají zahrnout do operace post. Tato data jsou připojena k datové části webhooku.
serviceUri	string	identifikátor URI služby k odeslání oznámení, když se výstraha aktivuje nebo přeloží.

ThresholdRuleCondition

Podmínka pravidla založená na metrikě překračující prahovou hodnotu.

Name	Typ	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	prostředek, ze kterého pravidlo shromažďuje svá data. Pro tento typ bude dataSource vždy typu RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	určuje typ podmínky. Může to být jeden ze tří typů: ManagementEventRuleCondition (výskyty událostí správy), LocationThresholdRuleCondition (na základě počtu selhání webového testu) a ThresholdRuleCondition (na základě prahové hodnoty metriky).
operator	ConditionOperator	operátor použitý k porovnání dat a prahové hodnoty.
threshold	number	prahová hodnota, která aktivuje výstrahu.
timeAggregation	TimeAggregationOperator	operátor časové agregace. Způsob kombinování shromažďovaných dat v průběhu času Výchozí hodnota je PrimaryAggregationType metriky.
windowSize	string	časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity upozornění na základě prahové hodnoty. Pokud je zadaný, musí to být 5 minut až 1 den.

TimeAggregationOperator

Operátory agregace povolené v pravidle

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