Alert Rules - Get

Service:

Monitor

API Version:

2016-03-01

Klasik bir ölçüm uyarı kuralı alır

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
ruleName	path	True	string	Kuralın adı.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	AlertRuleResource	Uyarı kuralı alma isteği başarılı
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
AlertRuleResource	Uyarı kuralı kaynağı.
ConditionOperator	Kural koşulunda izin verilen işleçler.
ErrorResponse	Hata yanıtının biçimini açıklar.
LocationThresholdRuleCondition	Başarısız olan belirli sayıda konumu temel alan kural koşulu.
ManagementEventAggregationCondition	Toplanan verilerin zaman içinde nasıl birleştirileceği.
ManagementEventRuleCondition	Bir yönetim olayı kuralı koşulu.
RuleEmailAction	Kural koşulu değerlendirildiğinde e-posta gönderme eylemini belirtir. Bu durumda ayrımcı her zaman RuleEmailAction'dır.
RuleManagementEventClaimsDataSource	Kural yönetimi olay veri kaynağı için talepler.
RuleManagementEventDataSource	Kural yönetimi olay veri kaynağı. Bu durumda ayrımcı alanlar her zaman RuleManagementEventDataSource'tır.
RuleMetricDataSource	Kural ölçümü veri kaynağı. Bu durumda ayrımcı değer her zaman RuleMetricDataSource'tır.
RuleWebhookAction	Kural koşulu değerlendirildiğinde hizmete postalanan eylemi belirtir. Bu durumda ayrımcı her zaman RuleWebhookAction'dır.
ThresholdRuleCondition	Eşiği aşan bir ölçümü temel alan kural koşulu.
TimeAggregationOperator	Kuralda izin verilen toplama işleçleri.

AlertRuleResource

Uyarı kuralı kaynağı.

Name	Tür	Description
id	string	Azure kaynak kimliği
location	string	Kaynak konumu
name	string	Azure kaynak adı
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	eylemi, uyarı kuralı etkin hale geldiğinde ve bir uyarı koşulu çözümlendiğinde gerçekleştirilir.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	uyarı kuralı etkin olduğunda ve bir uyarı koşulu çözümlendiğinde gerçekleştirilen eylemler dizisi.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	uyarı kuralının etkinleştirilmesine neden olan koşul.
properties.description	string	uyarı e-postasında yer alacak uyarı kuralının açıklaması.
properties.isEnabled	boolean	uyarı kuralının etkinleştirilip etkinleştirilmediğini gösteren bayrak.
properties.lastUpdatedTime	string	Kuralın en son ISO8601 biçimde güncelleştirilişi.
properties.name	string	uyarı kuralının adı.
properties.provisioningState	string	sağlama durumu.
tags	object	Kaynak etiketleri
type	string	Azure kaynak türü

ConditionOperator

Kural koşulunda izin verilen işleçler.

Name	Tür	Description
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Hata yanıtının biçimini açıklar.

Name	Tür	Description
code	string	Hata kodu
message	string	İşlemin neden başarısız olduğunu belirten hata iletisi.

LocationThresholdRuleCondition

Başarısız olan belirli sayıda konumu temel alan kural koşulu.

Name	Tür	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	kuralın verilerini topladığı kaynak. Bu tür için dataSource her zaman RuleMetricDataSource türünde olacaktır.
failedLocationCount	integer	uyarıyı etkinleştirememesi gereken konum sayısı.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	koşul türünü belirtir. Bu üç türden biri olabilir: ManagementEventRuleCondition (yönetim olaylarının oluşumları), LocationThresholdRuleCondition (web testinin hata sayısına bağlı olarak) ve ThresholdRuleCondition (ölçümün eşiğine göre).
windowSize	string	eşiğe göre uyarı etkinliğini izlemek için kullanılan süre (ISO 8601 süre biçiminde). Belirtilirse 5 dakika ile 1 gün arasında olmalıdır.

ManagementEventAggregationCondition

Toplanan verilerin zaman içinde nasıl birleştirileceği.

Name	Tür	Description
operator	ConditionOperator	koşul işleci.
threshold	number	Uyarıyı etkinleştiren eşik değeri.
windowSize	string	eşiğe göre uyarı etkinliğini izlemek için kullanılan süre (ISO 8601 süre biçiminde). Belirtilirse 5 dakika ile 1 gün arasında olmalıdır.

ManagementEventRuleCondition

Bir yönetim olayı kuralı koşulu.

Name	Tür	Description
aggregation	ManagementEventAggregationCondition	Toplanan verilerin zaman içinde ve uyarı etkinleştirildiğinde nasıl birleştirileceği. Yönetim olayı uyarı toplama işleminin isteğe bağlı olduğunu unutmayın; sağlanmazsa herhangi bir olay uyarının etkinleştirilmesine neden olur.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	kuralın verilerini topladığı kaynak. Bu tür için dataSource her zaman RuleMetricDataSource türünde olacaktır.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	koşul türünü belirtir. Bu üç türden biri olabilir: ManagementEventRuleCondition (yönetim olaylarının oluşumları), LocationThresholdRuleCondition (web testinin hata sayısına bağlı olarak) ve ThresholdRuleCondition (ölçümün eşiğine göre).

RuleEmailAction

Kural koşulu değerlendirildiğinde e-posta gönderme eylemini belirtir. Bu durumda ayrımcı her zaman RuleEmailAction'dır.

Name	Tür	Description
customEmails	string[]	uyarının etkinleştirilmesini bildirmek için yöneticinin özel e-posta adreslerinin listesi.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	eylemin türünü belirtir. İki tür eylem vardır: RuleEmailAction ve RuleWebhookAction.
sendToServiceOwners	boolean	Uyarı etkinleştirildiğinde hizmet yöneticilerinin (hizmet ve ortak yöneticiler) bilgilendirilip bilgilendirilmeyeceği.

RuleManagementEventClaimsDataSource

Kural yönetimi olay veri kaynağı için talepler.

Name	Tür	Description
emailAddress	string	e-posta adresini seçin.

RuleManagementEventDataSource

Kural yönetimi olay veri kaynağı. Bu durumda ayrımcı alanlar her zaman RuleManagementEventDataSource'tır.

Name	Tür	Description
claims	RuleManagementEventClaimsDataSource	talepler.
eventName	string	olay adı.
eventSource	string	olay kaynağı.
legacyResourceId	string	kuralın izlediği kaynağın eski kaynak tanımlayıcısı. NOT: Bu özellik mevcut bir kural için güncelleştirilemez.
level	string	düzeyini seçin.
metricNamespace	string	ölçümün ad alanı.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	veri kaynağının türünü belirtir. İki tür kural veri kaynağı vardır: RuleMetricDataSource ve RuleManagementEventDataSource
operationName	string	Denetlenmesi gereken işlemin adı. Ad sağlanmazsa, herhangi bir işlem eşleşir.
resourceGroupName	string	kaynak grubu adı.
resourceLocation	string	kaynağın konumu.
resourceProviderName	string	kaynak sağlayıcısının adı.
resourceUri	string	kuralın izlediği kaynağın kaynak tanımlayıcısı. NOT: Bu özellik mevcut bir kural için güncelleştirilemez.
status	string	Denetlenmesi gereken işlemin durumu. Durum belirtilmemişse, herhangi bir durum eşleşir.
subStatus	string	alt durumu.

RuleMetricDataSource

Kural ölçümü veri kaynağı. Bu durumda ayrımcı değer her zaman RuleMetricDataSource'tır.

Name	Tür	Description
legacyResourceId	string	kuralın izlediği kaynağın eski kaynak tanımlayıcısı. NOT: Bu özellik mevcut bir kural için güncelleştirilemez.
metricName	string	kuralın neleri izlediğini tanımlayan ölçümün adı.
metricNamespace	string	ölçümün ad alanı.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	veri kaynağının türünü belirtir. İki tür kural veri kaynağı vardır: RuleMetricDataSource ve RuleManagementEventDataSource
resourceLocation	string	kaynağın konumu.
resourceUri	string	kuralın izlediği kaynağın kaynak tanımlayıcısı. NOT: Bu özellik mevcut bir kural için güncelleştirilemez.

RuleWebhookAction

Kural koşulu değerlendirildiğinde hizmete postalanan eylemi belirtir. Bu durumda ayrımcı her zaman RuleWebhookAction'dır.

Name	Tür	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	eylemin türünü belirtir. İki tür eylem vardır: RuleEmailAction ve RuleWebhookAction.
properties	object	post işlemine dahil etmek için özel özelliklerin sözlüğü. Bu veriler web kancası yüküne eklenir.
serviceUri	string	uyarı etkinleştirildiğinde veya çözümlendiğinde bildirimi göndermeye yönelik hizmet uri'sini seçin.

ThresholdRuleCondition

Eşiği aşan bir ölçümü temel alan kural koşulu.

Name	Tür	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	kuralın verilerini topladığı kaynak. Bu tür için dataSource her zaman RuleMetricDataSource türünde olacaktır.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	koşul türünü belirtir. Bu üç türden biri olabilir: ManagementEventRuleCondition (yönetim olaylarının oluşumları), LocationThresholdRuleCondition (web testinin hata sayısına bağlı olarak) ve ThresholdRuleCondition (ölçümün eşiğine göre).
operator	ConditionOperator	verileri ve eşiği karşılaştırmak için kullanılan işleç.
threshold	number	uyarıyı etkinleştiren eşik değeri.
timeAggregation	TimeAggregationOperator	zaman toplama işleci. Toplanan verilerin zaman içinde nasıl birleştirileceği. Varsayılan değer, Ölçümün PrimaryAggregationType değeridir.
windowSize	string	eşiğe göre uyarı etkinliğini izlemek için kullanılan süre (ISO 8601 süre biçiminde). Belirtilirse 5 dakika ile 1 gün arasında olmalıdır.

TimeAggregationOperator

Kuralda izin verilen toplama işleçleri.

Name	Tür	Description
Average	string
Last	string
Maximum	string
Minimum	string
Total	string