Alert Rules - Get

Service:

Monitor

API-versie:

2016-03-01

Hiermee haalt u een klassieke waarschuwingsregel voor metrische gegevens op

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
ruleName	path	True	string	De naam van de regel.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	AlertRuleResource	Geslaagde aanvraag voor het ophalen van een waarschuwingsregel
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Get an alert rule

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AlertRuleResource	De waarschuwingsregelresource.
ConditionOperator	Operators die zijn toegestaan in de regelvoorwaarde.
ErrorResponse	Beschrijft de indeling van foutantwoord.
LocationThresholdRuleCondition	Een regelvoorwaarde op basis van een bepaald aantal locaties mislukt.
ManagementEventAggregationCondition	Hoe de verzamelde gegevens in de loop van de tijd moeten worden gecombineerd.
ManagementEventRuleCondition	Een regelvoorwaarde voor beheerevenementen.
RuleEmailAction	Hiermee geeft u de actie voor het verzenden van e-mail wanneer de regelvoorwaarde wordt geëvalueerd. De discriminator is in dit geval altijd RuleEmailAction.
RuleManagementEventClaimsDataSource	De claims voor een gebeurtenisbron voor regelbeheer.
RuleManagementEventDataSource	Een gebeurtenisgegevensbron voor regelbeheer. De discriminatorvelden zijn in dit geval altijd RuleManagementEventDataSource.
RuleMetricDataSource	Een metrische gegevensbron van een regel. De discriminatorwaarde is in dit geval altijd RuleMetricDataSource.
RuleWebhookAction	Hiermee geeft u de actie op die naar de service moet worden geplaatst wanneer de regelvoorwaarde wordt geëvalueerd. De discriminator is in dit geval altijd RuleWebhookAction.
ThresholdRuleCondition	Een regelvoorwaarde op basis van een metrische waarde die een drempelwaarde overschrijdt.
TimeAggregationOperator	Aggregatieoperators die zijn toegestaan in een regel.

AlertRuleResource

De waarschuwingsregelresource.

Name	Type	Description
id	string	Azure-resource-id
location	string	Resourcelocatie
name	string	Azure-resourcenaam
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	actie die wordt uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	de matrix met acties die worden uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	de voorwaarde die tot gevolg heeft dat de waarschuwingsregel wordt geactiveerd.
properties.description	string	de beschrijving van de waarschuwingsregel die wordt opgenomen in de waarschuwings-e-mail.
properties.isEnabled	boolean	de vlag die aangeeft of de waarschuwingsregel is ingeschakeld.
properties.lastUpdatedTime	string	De laatste keer dat de regel is bijgewerkt in ISO8601 indeling.
properties.name	string	de naam van de waarschuwingsregel.
properties.provisioningState	string	de inrichtingsstatus.
tags	object	Resourcetags
type	string	Azure-resourcetype

ConditionOperator

Operators die zijn toegestaan in de regelvoorwaarde.

Name	Type	Description
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Beschrijft de indeling van foutantwoord.

Name	Type	Description
code	string	Foutcode
message	string	Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.

LocationThresholdRuleCondition

Een regelvoorwaarde op basis van een bepaald aantal locaties mislukt.

Name	Type	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	de resource waaruit de regel de gegevens verzamelt. Voor dit type is dataSource altijd van het type RuleMetricDataSource.
failedLocationCount	integer	het aantal locaties waarvoor de waarschuwing niet kan worden geactiveerd.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	hiermee geeft u het type voorwaarde op. Dit kan een van de volgende drie typen zijn: ManagementEventRuleCondition (gebeurtenissen van beheer gebeurtenissen), LocationThresholdRuleCondition (op basis van het aantal fouten van een webtest) en ThresholdRuleCondition (op basis van de drempelwaarde van een metrische waarde).
windowSize	string	de periode (in ISO 8601-duurnotatie) die wordt gebruikt voor het bewaken van waarschuwingsactiviteiten op basis van de drempelwaarde. Indien opgegeven, moet dit tussen 5 minuten en 1 dag zijn.

ManagementEventAggregationCondition

Hoe de verzamelde gegevens in de loop van de tijd moeten worden gecombineerd.

Name	Type	Description
operator	ConditionOperator	de operator voorwaarde.
threshold	number	De drempelwaarde die de waarschuwing activeert.
windowSize	string	de periode (in ISO 8601-duurnotatie) die wordt gebruikt voor het bewaken van waarschuwingsactiviteiten op basis van de drempelwaarde. Indien opgegeven, moet dit tussen 5 minuten en 1 dag zijn.

ManagementEventRuleCondition

Een regelvoorwaarde voor beheerevenementen.

Name	Type	Description
aggregation	ManagementEventAggregationCondition	Hoe de verzamelde gegevens in de loop van de tijd moeten worden gecombineerd en wanneer de waarschuwing wordt geactiveerd. Houd er rekening mee dat aggregatie voor waarschuwingen voor beheerevenementen optioneel is. Als deze niet is opgegeven, zorgt een gebeurtenis ervoor dat de waarschuwing wordt geactiveerd.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	de resource waaruit de regel de gegevens verzamelt. Voor dit type is dataSource altijd van het type RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	hiermee geeft u het type voorwaarde op. Dit kan een van de volgende drie typen zijn: ManagementEventRuleCondition (gebeurtenissen van beheer gebeurtenissen), LocationThresholdRuleCondition (op basis van het aantal fouten van een webtest) en ThresholdRuleCondition (op basis van de drempelwaarde van een metrische waarde).

RuleEmailAction

Hiermee geeft u de actie voor het verzenden van e-mail wanneer de regelvoorwaarde wordt geëvalueerd. De discriminator is in dit geval altijd RuleEmailAction.

Name	Type	Description
customEmails	string[]	de lijst met aangepaste e-mailadressen van de beheerder om de activering van de waarschuwing te melden.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	hiermee geeft u het type van de actie op. Er zijn twee soorten acties: RuleEmailAction en RuleWebhookAction.
sendToServiceOwners	boolean	Of de beheerders (service en medebeheerders) van de service op de hoogte moeten worden gesteld wanneer de waarschuwing wordt geactiveerd.

RuleManagementEventClaimsDataSource

De claims voor een gebeurtenisbron voor regelbeheer.

Name	Type	Description
emailAddress	string	het e-mailadres.

RuleManagementEventDataSource

Een gebeurtenisgegevensbron voor regelbeheer. De discriminatorvelden zijn in dit geval altijd RuleManagementEventDataSource.

Name	Type	Description
claims	RuleManagementEventClaimsDataSource	de claims.
eventName	string	de naam van de gebeurtenis.
eventSource	string	de gebeurtenisbron.
legacyResourceId	string	de verouderde resource-id van de resource die door de regel wordt bewaakt. OPMERKING: deze eigenschap kan niet worden bijgewerkt voor een bestaande regel.
level	string	het niveau.
metricNamespace	string	de naamruimte van de metrische waarde.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	hiermee geeft u het type gegevensbron op. Er zijn twee typen regelgegevensbronnen: RuleMetricDataSource en RuleManagementEventDataSource
operationName	string	De naam van de bewerking die moet worden gecontroleerd. Als er geen naam wordt opgegeven, komt elke bewerking overeen.
resourceGroupName	string	de naam van de resourcegroep.
resourceLocation	string	de locatie van de resource.
resourceProviderName	string	de naam van de resourceprovider.
resourceUri	string	de resource-id van de resource die door de regel wordt bewaakt. OPMERKING: deze eigenschap kan niet worden bijgewerkt voor een bestaande regel.
status	string	De status van de bewerking waarop moet worden gecontroleerd. Als er geen status wordt opgegeven, komt elke status overeen.
subStatus	string	de substatus.

RuleMetricDataSource

Een metrische gegevensbron van een regel. De discriminatorwaarde is in dit geval altijd RuleMetricDataSource.

Name	Type	Description
legacyResourceId	string	de verouderde resource-id van de resource die door de regel wordt bewaakt. OPMERKING: deze eigenschap kan niet worden bijgewerkt voor een bestaande regel.
metricName	string	de naam van de metrische waarde die definieert wat de regel bewaakt.
metricNamespace	string	de naamruimte van de metrische waarde.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	hiermee geeft u het type gegevensbron op. Er zijn twee typen regelgegevensbronnen: RuleMetricDataSource en RuleManagementEventDataSource
resourceLocation	string	de locatie van de resource.
resourceUri	string	de resource-id van de resource die door de regel wordt bewaakt. OPMERKING: deze eigenschap kan niet worden bijgewerkt voor een bestaande regel.

RuleWebhookAction

Hiermee geeft u de actie op die naar de service moet worden geplaatst wanneer de regelvoorwaarde wordt geëvalueerd. De discriminator is in dit geval altijd RuleWebhookAction.

Name	Type	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	hiermee geeft u het type van de actie op. Er zijn twee soorten acties: RuleEmailAction en RuleWebhookAction.
properties	object	de woordenlijst met aangepaste eigenschappen die moeten worden opgenomen bij de postbewerking. Deze gegevens worden toegevoegd aan de nettolading van de webhook.
serviceUri	string	de service-URI naar Post de melding wanneer de waarschuwing wordt geactiveerd of opgelost.

ThresholdRuleCondition

Een regelvoorwaarde op basis van een metrische waarde die een drempelwaarde overschrijdt.

Name	Type	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	de resource waaruit de regel de gegevens verzamelt. Voor dit type is dataSource altijd van het type RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	hiermee geeft u het type voorwaarde op. Dit kan een van de volgende drie typen zijn: ManagementEventRuleCondition (gebeurtenissen van beheer gebeurtenissen), LocationThresholdRuleCondition (op basis van het aantal fouten van een webtest) en ThresholdRuleCondition (op basis van de drempelwaarde van een metrische waarde).
operator	ConditionOperator	de operator die wordt gebruikt om de gegevens en de drempelwaarde te vergelijken.
threshold	number	de drempelwaarde die de waarschuwing activeert.
timeAggregation	TimeAggregationOperator	de tijdaggregatieoperator. Hoe de verzamelde gegevens in de loop van de tijd moeten worden gecombineerd. De standaardwaarde is het PrimaryAggregationType van de metrische waarde.
windowSize	string	de periode (in ISO 8601-duurnotatie) die wordt gebruikt voor het bewaken van waarschuwingsactiviteiten op basis van de drempelwaarde. Indien opgegeven, moet dit tussen 5 minuten en 1 dag zijn.

TimeAggregationOperator

Aggregatieoperators die zijn toegestaan in een regel.

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