Alert Rules - Get

Service:

Monitor

API Version:

2016-03-01

Mendapatkan aturan pemberitahuan metrik klasik

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
ruleName	path	True	string	Nama aturan.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	AlertRuleResource	Permintaan berhasil untuk mendapatkan aturan pemberitahuan
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
AlertRuleResource	Sumber daya aturan pemberitahuan.
ConditionOperator	Operator diizinkan dalam kondisi aturan.
ErrorResponse	Menjelaskan format respons Kesalahan.
LocationThresholdRuleCondition	Kondisi aturan berdasarkan sejumlah lokasi tertentu gagal.
ManagementEventAggregationCondition	Bagaimana data yang dikumpulkan harus digabungkan dari waktu ke waktu.
ManagementEventRuleCondition	Kondisi aturan peristiwa manajemen.
RuleEmailAction	Menentukan tindakan untuk mengirim email saat kondisi aturan dievaluasi. Diskriminator selalu RuleEmailAction dalam kasus ini.
RuleManagementEventClaimsDataSource	Klaim untuk sumber data peristiwa manajemen aturan.
RuleManagementEventDataSource	Sumber data peristiwa manajemen aturan. Bidang diskriminator selalu RuleManagementEventDataSource dalam kasus ini.
RuleMetricDataSource	Sumber data metrik aturan. Nilai diskriminator selalu RuleMetricDataSource dalam hal ini.
RuleWebhookAction	Menentukan tindakan untuk memposting ke layanan saat kondisi aturan dievaluasi. Diskriminator selalu RuleWebhookAction dalam kasus ini.
ThresholdRuleCondition	Kondisi aturan berdasarkan metrik yang melewati ambang batas.
TimeAggregationOperator	Operator agregasi diizinkan dalam aturan.

AlertRuleResource

Sumber daya aturan pemberitahuan.

Nama	Jenis	Deskripsi
id	string	Id sumber daya Azure
location	string	Lokasi sumber daya
name	string	Nama sumber daya Azure
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	tindakan yang dilakukan saat aturan pemberitahuan menjadi aktif, dan ketika kondisi pemberitahuan diselesaikan.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	array tindakan yang dilakukan saat aturan pemberitahuan menjadi aktif, dan saat kondisi pemberitahuan diselesaikan.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	kondisi yang mengalihkan aturan pemberitahuan diaktifkan.
properties.description	string	deskripsi aturan pemberitahuan yang akan disertakan dalam email pemberitahuan.
properties.isEnabled	boolean	bendera yang menunjukkan apakah aturan pemberitahuan diaktifkan.
properties.lastUpdatedTime	string	Terakhir kali aturan diperbarui dalam format ISO8601.
properties.name	string	nama aturan pemberitahuan.
properties.provisioningState	string	status penyediaan.
tags	object	Tag sumber daya
type	string	Jenis sumber daya Azure

ConditionOperator

Operator diizinkan dalam kondisi aturan.

Nama	Jenis	Deskripsi
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

ErrorResponse

Menjelaskan format respons Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

LocationThresholdRuleCondition

Kondisi aturan berdasarkan sejumlah lokasi tertentu gagal.

Nama	Jenis	Deskripsi
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	sumber daya tempat aturan mengumpulkan datanya. Untuk jenis dataSource ini akan selalu berjenis RuleMetricDataSource.
failedLocationCount	integer	jumlah lokasi yang harus gagal mengaktifkan pemberitahuan.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	menentukan jenis kondisi. Ini bisa menjadi salah satu dari tiga jenis: ManagementEventRuleCondition (kemunculan peristiwa manajemen), LocationThresholdRuleCondition (berdasarkan jumlah kegagalan pengujian web), dan ThresholdRuleCondition (berdasarkan ambang batas metrik).
windowSize	string	periode waktu (dalam format durasi ISO 8601) yang digunakan untuk memantau aktivitas pemberitahuan berdasarkan ambang batas. Jika ditentukan maka harus antara 5 menit dan 1 hari.

ManagementEventAggregationCondition

Bagaimana data yang dikumpulkan harus digabungkan dari waktu ke waktu.

Nama	Jenis	Deskripsi
operator	ConditionOperator	operator kondisi.
threshold	number	Nilai ambang yang mengaktifkan pemberitahuan.
windowSize	string	periode waktu (dalam format durasi ISO 8601) yang digunakan untuk memantau aktivitas pemberitahuan berdasarkan ambang batas. Jika ditentukan maka harus antara 5 menit dan 1 hari.

ManagementEventRuleCondition

Kondisi aturan peristiwa manajemen.

Nama	Jenis	Deskripsi
aggregation	ManagementEventAggregationCondition	Bagaimana data yang dikumpulkan harus digabungkan dari waktu ke waktu dan kapan pemberitahuan diaktifkan. Perhatikan bahwa untuk agregasi pemberitahuan peristiwa manajemen bersifat opsional – jika tidak disediakan, peristiwa apa pun akan menyebabkan pemberitahuan diaktifkan.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	sumber daya tempat aturan mengumpulkan datanya. Untuk jenis dataSource ini akan selalu berjenis RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	menentukan jenis kondisi. Ini bisa menjadi salah satu dari tiga jenis: ManagementEventRuleCondition (kemunculan peristiwa manajemen), LocationThresholdRuleCondition (berdasarkan jumlah kegagalan pengujian web), dan ThresholdRuleCondition (berdasarkan ambang batas metrik).

RuleEmailAction

Menentukan tindakan untuk mengirim email saat kondisi aturan dievaluasi. Diskriminator selalu RuleEmailAction dalam kasus ini.

Nama	Jenis	Deskripsi
customEmails	string[]	daftar alamat email kustom administrator untuk memberi tahu tentang aktivasi pemberitahuan.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	menentukan jenis tindakan. Ada dua jenis tindakan: RuleEmailAction dan RuleWebhookAction.
sendToServiceOwners	boolean	Apakah administrator (layanan dan rekan administrator) layanan harus diberi tahu saat pemberitahuan diaktifkan.

RuleManagementEventClaimsDataSource

Klaim untuk sumber data peristiwa manajemen aturan.

Nama	Jenis	Deskripsi
emailAddress	string	alamat email.

RuleManagementEventDataSource

Sumber data peristiwa manajemen aturan. Bidang diskriminator selalu RuleManagementEventDataSource dalam kasus ini.

Nama	Jenis	Deskripsi
claims	RuleManagementEventClaimsDataSource	klaim.
eventName	string	nama peristiwa.
eventSource	string	sumber kejadian.
legacyResourceId	string	pengidentifikasi sumber daya warisan sumber daya yang dipantau aturan. CATATAN: properti ini tidak dapat diperbarui untuk aturan yang ada.
level	string	tingkat.
metricNamespace	string	namespace metrik.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	menentukan jenis sumber data. Ada dua jenis sumber data aturan: RuleMetricDataSource dan RuleManagementEventDataSource
operationName	string	Nama operasi yang harus diperiksa. Jika tidak ada nama yang disediakan, operasi apa pun akan cocok.
resourceGroupName	string	nama grup sumber daya.
resourceLocation	string	lokasi sumber daya.
resourceProviderName	string	nama penyedia sumber daya.
resourceUri	string	pengidentifikasi sumber daya sumber daya yang dipantau aturan. CATATAN: properti ini tidak dapat diperbarui untuk aturan yang ada.
status	string	Status operasi yang harus diperiksa. Jika tidak ada status yang disediakan, status apa pun akan cocok.
subStatus	string	substatus.

RuleMetricDataSource

Sumber data metrik aturan. Nilai diskriminator selalu RuleMetricDataSource dalam hal ini.

Nama	Jenis	Deskripsi
legacyResourceId	string	pengidentifikasi sumber daya warisan sumber daya yang dipantau aturan. CATATAN: properti ini tidak dapat diperbarui untuk aturan yang ada.
metricName	string	nama metrik yang menentukan apa yang dipantau aturan.
metricNamespace	string	namespace metrik.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	menentukan jenis sumber data. Ada dua jenis sumber data aturan: RuleMetricDataSource dan RuleManagementEventDataSource
resourceLocation	string	lokasi sumber daya.
resourceUri	string	pengidentifikasi sumber daya sumber daya yang dipantau aturan. CATATAN: properti ini tidak dapat diperbarui untuk aturan yang ada.

RuleWebhookAction

Menentukan tindakan untuk memposting ke layanan saat kondisi aturan dievaluasi. Diskriminator selalu RuleWebhookAction dalam kasus ini.

Nama	Jenis	Deskripsi
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	menentukan jenis tindakan. Ada dua jenis tindakan: RuleEmailAction dan RuleWebhookAction.
properties	object	kamus properti kustom untuk disertakan dengan operasi pasca. Data ini ditambahkan ke payload webhook.
serviceUri	string	uri layanan untuk Memposting pemberitahuan saat pemberitahuan diaktifkan atau diselesaikan.

ThresholdRuleCondition

Kondisi aturan berdasarkan metrik yang melewati ambang batas.

Nama	Jenis	Deskripsi
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	sumber daya tempat aturan mengumpulkan datanya. Untuk jenis dataSource ini akan selalu berjenis RuleMetricDataSource.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	menentukan jenis kondisi. Ini bisa menjadi salah satu dari tiga jenis: ManagementEventRuleCondition (kemunculan peristiwa manajemen), LocationThresholdRuleCondition (berdasarkan jumlah kegagalan pengujian web), dan ThresholdRuleCondition (berdasarkan ambang batas metrik).
operator	ConditionOperator	operator yang digunakan untuk membandingkan data dan ambang batas.
threshold	number	nilai ambang yang mengaktifkan pemberitahuan.
timeAggregation	TimeAggregationOperator	operator agregasi waktu. Bagaimana data yang dikumpulkan harus digabungkan dari waktu ke waktu. Nilai defaultnya adalah PrimaryAggregationType dari Metrik.
windowSize	string	periode waktu (dalam format durasi ISO 8601) yang digunakan untuk memantau aktivitas pemberitahuan berdasarkan ambang batas. Jika ditentukan maka harus antara 5 menit dan 1 hari.

TimeAggregationOperator

Operator agregasi diizinkan dalam aturan.

Nama	Jenis	Deskripsi
Average	string
Last	string
Maximum	string
Minimum	string
Total	string