Alert Rules - Get

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

Name In Required Type Description
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

Name Type Description
200 OK

Permintaan berhasil untuk mendapatkan aturan pemberitahuan

Other Status Codes

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

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

Get an alert rule

Sample Request

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01

Sample Response

{
  "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

AlertRuleResource

Sumber daya aturan pemberitahuan.

ConditionOperator

Operator yang 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 kasus 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.

Name Type Description
id
  • string

Id sumber daya Azure

location
  • string

Lokasi sumber daya

name
  • string

Nama sumber daya Azure

properties.action RuleAction:

tindakan yang dilakukan saat aturan pemberitahuan menjadi aktif, dan ketika kondisi pemberitahuan diselesaikan.

properties.actions RuleAction[]:

array tindakan yang dilakukan saat aturan pemberitahuan menjadi aktif, dan saat kondisi pemberitahuan diselesaikan.

properties.condition RuleCondition:

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 yang diizinkan dalam kondisi aturan.

Name Type Description
GreaterThan
  • string
GreaterThanOrEqual
  • string
LessThan
  • string
LessThanOrEqual
  • string

ErrorResponse

Menjelaskan format respons Kesalahan.

Name Type Description
code
  • string

Kode kesalahan

message
  • string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.

LocationThresholdRuleCondition

Kondisi aturan berdasarkan sejumlah lokasi tertentu gagal.

Name Type Description
dataSource RuleDataSource:

sumber daya tempat aturan mengumpulkan datanya. Untuk jenis ini, dataSource 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.

Name Type Description
operator

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.

Name Type Description
aggregation

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:

sumber daya tempat aturan mengumpulkan datanya. Untuk jenis ini, dataSource 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.

Name Type Description
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 co-administrator) layanan harus diberi tahu saat pemberitahuan diaktifkan.

RuleManagementEventClaimsDataSource

Klaim untuk sumber data peristiwa manajemen aturan.

Name Type Description
emailAddress
  • string

alamat email.

RuleManagementEventDataSource

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

Name Type Description
claims

klaim.

eventName
  • string

nama peristiwa.

eventSource
  • string

sumber kejadian.

legacyResourceId
  • string

pengidentifikasi sumber daya warisan dari 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 kasus ini.

Name Type Description
legacyResourceId
  • string

pengidentifikasi sumber daya warisan dari 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.

Name Type Description
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.

Name Type Description
dataSource RuleDataSource:

sumber daya tempat aturan mengumpulkan datanya. Untuk jenis ini, dataSource 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

operator yang digunakan untuk membandingkan data dan ambang batas.

threshold
  • number

nilai ambang yang mengaktifkan pemberitahuan.

timeAggregation

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.

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