Alert Rules - Get

Service:

Monitor

API Version:

2016-03-01

Hämtar en klassisk måttaviseringsregel

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
ruleName	path	True	string	Namnet på regeln.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	AlertRuleResource	Lyckad begäran om att få en aviseringsregel
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
AlertRuleResource	Resursen för aviseringsregeln.
ConditionOperator	Operatorer tillåts i regelvillkoret.
ErrorResponse	Beskriver formatet för felsvar.
LocationThresholdRuleCondition	Ett regelvillkor baserat på ett visst antal platser som misslyckas.
ManagementEventAggregationCondition	Hur de data som samlas in ska kombineras över tid.
ManagementEventRuleCondition	Ett regelvillkor för hanteringshändelser.
RuleEmailAction	Anger åtgärden för att skicka e-post när regelvillkoret utvärderas. Diskriminatorn är alltid RuleEmailAction i det här fallet.
RuleManagementEventClaimsDataSource	Anspråk för en datakälla för regelhanteringshändelser.
RuleManagementEventDataSource	En datakälla för regelhanteringshändelser. De diskriminerande fälten är alltid RuleManagementEventDataSource i det här fallet.
RuleMetricDataSource	En regelmåttdatakälla. Diskriminatorvärdet är alltid RuleMetricDataSource i det här fallet.
RuleWebhookAction	Anger vilken åtgärd som ska skickas till tjänsten när regelvillkoret utvärderas. Diskriminatorn är alltid RuleWebhookAction i det här fallet.
ThresholdRuleCondition	Ett regelvillkor baserat på ett mått som överskrider ett tröskelvärde.
TimeAggregationOperator	Sammansättningsoperatorer tillåts i en regel.

AlertRuleResource

Resursen för aviseringsregeln.

Name	Typ	Description
id	string	Resurs-ID för Azure
location	string	Resursplats
name	string	Azure-resursnamn
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	åtgärd som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	matrisen med åtgärder som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor löses.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	villkoret som resulterar i att aviseringsregeln aktiveras.
properties.description	string	beskrivningen av aviseringsregeln som ska ingå i aviseringsmeddelandet.
properties.isEnabled	boolean	flaggan som anger om aviseringsregeln är aktiverad.
properties.lastUpdatedTime	string	Senaste gången regeln uppdaterades i ISO8601 format.
properties.name	string	namnet på aviseringsregeln.
properties.provisioningState	string	etableringstillståndet.
tags	object	Resurstaggar
type	string	Azure-resurstyp

ConditionOperator

Operatorer tillåts i regelvillkoret.

Name	Typ	Description
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Beskriver formatet för felsvar.

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

LocationThresholdRuleCondition

Ett regelvillkor baserat på ett visst antal platser som misslyckas.

Name	Typ	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource.
failedLocationCount	integer	antalet platser som inte kan aktivera aviseringen.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	anger typen av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått).
windowSize	string	tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag.

ManagementEventAggregationCondition

Hur de data som samlas in ska kombineras över tid.

Name	Typ	Description
operator	ConditionOperator	villkorsoperatorn.
threshold	number	Tröskelvärdet som aktiverar aviseringen.
windowSize	string	tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag.

ManagementEventRuleCondition

Ett regelvillkor för hanteringshändelser.

Name	Typ	Description
aggregation	ManagementEventAggregationCondition	Hur de data som samlas in ska kombineras över tid och när aviseringen aktiveras. Observera att aggregering för hanteringshändelseaviseringar är valfri – om den inte anges kommer alla händelser att göra så att aviseringen aktiveras.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	anger typen av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått).

RuleEmailAction

Anger åtgärden för att skicka e-post när regelvillkoret utvärderas. Diskriminatorn är alltid RuleEmailAction i det här fallet.

Name	Typ	Description
customEmails	string[]	listan över administratörens anpassade e-postadresser för att meddela om aktiveringen av aviseringen.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	anger typen av åtgärd. Det finns två typer av åtgärder: RuleEmailAction och RuleWebhookAction.
sendToServiceOwners	boolean	Om administratörerna (tjänsten och medadministratörerna) för tjänsten ska meddelas när aviseringen aktiveras.

RuleManagementEventClaimsDataSource

Anspråk för en datakälla för regelhanteringshändelser.

Name	Typ	Description
emailAddress	string	e-postadressen.

RuleManagementEventDataSource

En datakälla för regelhanteringshändelser. De diskriminerande fälten är alltid RuleManagementEventDataSource i det här fallet.

Name	Typ	Description
claims	RuleManagementEventClaimsDataSource	anspråken.
eventName	string	händelsenamnet.
eventSource	string	händelsekällan.
legacyResourceId	string	den äldre resursidentifieraren för resursen som regeln övervakar. Obs! Det går inte att uppdatera den här egenskapen för en befintlig regel.
level	string	nivån.
metricNamespace	string	måttets namnområde.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	anger typen av datakälla. Det finns två typer av regeldatakällor: RuleMetricDataSource och RuleManagementEventDataSource
operationName	string	Namnet på den åtgärd som ska kontrolleras. Om inget namn anges matchar alla åtgärder.
resourceGroupName	string	resursgruppens namn.
resourceLocation	string	resursens plats.
resourceProviderName	string	resursproviderns namn.
resourceUri	string	resursidentifieraren för resursen som regeln övervakar. Obs! Det går inte att uppdatera den här egenskapen för en befintlig regel.
status	string	Status för den åtgärd som ska kontrolleras. Om ingen status anges matchar statusen.
subStatus	string	understatusen.

RuleMetricDataSource

En regelmåttdatakälla. Diskriminatorvärdet är alltid RuleMetricDataSource i det här fallet.

Name	Typ	Description
legacyResourceId	string	den äldre resursidentifieraren för resursen som regeln övervakar. Obs! Det går inte att uppdatera den här egenskapen för en befintlig regel.
metricName	string	namnet på måttet som definierar vad regeln övervakar.
metricNamespace	string	måttets namnområde.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	anger typen av datakälla. Det finns två typer av regeldatakällor: RuleMetricDataSource och RuleManagementEventDataSource
resourceLocation	string	resursens plats.
resourceUri	string	resursidentifieraren för resursen som regeln övervakar. Obs! Det går inte att uppdatera den här egenskapen för en befintlig regel.

RuleWebhookAction

Anger vilken åtgärd som ska skickas till tjänsten när regelvillkoret utvärderas. Diskriminatorn är alltid RuleWebhookAction i det här fallet.

Name	Typ	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	anger typen av åtgärd. Det finns två typer av åtgärder: RuleEmailAction och RuleWebhookAction.
properties	object	ordlistan med anpassade egenskaper som ska inkluderas i poståtgärden. Dessa data läggs till i webhookens nyttolast.
serviceUri	string	tjänstens URI för att publicera meddelandet när aviseringen aktiveras eller löses.

ThresholdRuleCondition

Ett regelvillkor baserat på ett mått som överskrider ett tröskelvärde.

Name	Typ	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	anger typen av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått).
operator	ConditionOperator	operatorn som används för att jämföra data och tröskelvärdet.
threshold	number	tröskelvärdet som aktiverar aviseringen.
timeAggregation	TimeAggregationOperator	tidsaggregeringsoperatorn. Hur de data som samlas in ska kombineras över tid. Standardvärdet är PrimaryAggregationType för måttet.
windowSize	string	tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag.

TimeAggregationOperator

Sammansättningsoperatorer tillåts i en regel.

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