Aracılığıyla paylaş


Metric Alerts - List By Subscription

Abonelikte uyarı kuralı tanımlarını alma.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

URI Parametreleri

Name İçinde Gerekli Tür Description
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

MetricAlertResourceCollection

Ölçüm uyarılarının listesi için başarılı istek

Other Status Codes

ErrorResponse

BadRequest

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

List metric alert rules

Örnek isteği

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

Örnek yanıt

{
  "value": [
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
      "type": "Microsoft.Insights/metricAlerts",
      "location": "global",
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      },
      "properties": {
        "description": "This is the description of the rule1",
        "severity": 3,
        "enabled": true,
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "evaluationFrequency": "Pt1m",
        "windowSize": "Pt15m",
        "criteria": {
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
          "allOf": [
            {
              "criterionType": "StaticThresholdCriterion",
              "name": "High_CPU_80",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 80.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu",
      "type": "Microsoft.Insights/metricAlerts",
      "location": "global",
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      },
      "properties": {
        "description": "Med cpu alert",
        "severity": 4,
        "enabled": true,
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "evaluationFrequency": "Pt1m",
        "windowSize": "Pt15m",
        "criteria": {
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
          "allOf": [
            {
              "criterionType": "StaticThresholdCriterion",
              "name": "Medium_CPU_50",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 50.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    }
  ]
}

Tanımlar

Name Description
AggregationTypeEnum

ölçüt zaman toplama türleri.

DynamicMetricCriteria

Dinamik eşik ölçütü.

DynamicThresholdFailingPeriods

Seçilen geri arama zamanı penceresinde uyarı vermek için gereken en düşük ihlal sayısı.

DynamicThresholdOperator

Ölçüm değerini eşikle karşılaştırmak için kullanılan işleç.

DynamicThresholdSensitivity

Bir uyarıyı tetikleyebilmek için gereken sapma kapsamı. Bu, eşiğin ölçüm serisi desenine ne kadar yakın olduğunu etkiler.

ErrorResponse

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

MetricAlertAction

Bir uyarı eylemi.

MetricAlertMultipleResourceMultipleMetricCriteria

Birden çok ölçüm ölçütüne sahip birden çok kaynak için ölçüm uyarısı ölçütlerini belirtir.

MetricAlertResource

Ölçüm uyarısı kaynağı.

MetricAlertResourceCollection

Uyarı kuralı kaynaklarından oluşan bir koleksiyonu temsil eder.

MetricAlertSingleResourceMultipleMetricCriteria

Birden çok ölçüm ölçütüne sahip tek bir kaynak için ölçüm uyarısı ölçütlerini belirtir.

MetricCriteria

Ölçümleri filtreleme ölçütü.

MetricDimension

Ölçüm boyutunu belirtir.

Operator

ölçüt işleci.

WebtestLocationAvailabilityCriteria

Web testi kaynağı için ölçüm uyarısı kuralı ölçütlerini belirtir.

AggregationTypeEnum

ölçüt zaman toplama türleri.

Name Tür Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Dinamik eşik ölçütü.

Name Tür Description
alertSensitivity

DynamicThresholdSensitivity

Bir uyarıyı tetikleyebilmek için gereken sapma kapsamı. Bu, eşiğin ölçüm serisi desenine ne kadar yakın olduğunu etkiler.

criterionType string:

DynamicThresholdCriterion

Eşik ölçütlerinin türünü belirtir

dimensions

MetricDimension[]

Boyut koşullarının listesi.

failingPeriods

DynamicThresholdFailingPeriods

Seçilen geri arama zamanı penceresinde uyarı vermek için gereken en düşük ihlal sayısı.

ignoreDataBefore

string

Ölçüm geçmiş verilerini öğrenmeye başlanacağı tarihi ayarlamak ve dinamik eşikleri hesaplamak için bu seçeneği kullanın (ISO8601 biçimde)

metricName

string

Ölçümün adı.

metricNamespace

string

Ölçümün ad alanı.

name

string

Ölçüt adı.

operator

DynamicThresholdOperator

Ölçüm değerini eşikle karşılaştırmak için kullanılan işleç.

skipMetricValidation

boolean

Ölçüm doğrulamasının atlanmasına neden olarak henüz yayılmamış özel bir ölçümle ilgili uyarı kuralı oluşturmaya olanak sağlar.

timeAggregation

AggregationTypeEnum

ölçüt zaman toplama türleri.

DynamicThresholdFailingPeriods

Seçilen geri arama zamanı penceresinde uyarı vermek için gereken en düşük ihlal sayısı.

Name Tür Description
minFailingPeriodsToAlert

number

Uyarı tetikleme ihlallerinin sayısı. NumberOfEvaluationPeriods değerinden küçük veya buna eşit olmalıdır.

numberOfEvaluationPeriods

number

Toplanan geri arama noktalarının sayısı. Geri arama zamanı penceresi, toplama ayrıntı düzeyi (windowSize) ve seçilen toplam nokta sayısına göre hesaplanır.

DynamicThresholdOperator

Ölçüm değerini eşikle karşılaştırmak için kullanılan işleç.

Name Tür Description
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

Bir uyarıyı tetikleyebilmek için gereken sapma kapsamı. Bu, eşiğin ölçüm serisi desenine ne kadar yakın olduğunu etkiler.

Name Tür Description
High

string

Low

string

Medium

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.

MetricAlertAction

Bir uyarı eylemi.

Name Tür Description
actionGroupId

string

kullanılacak eylem grubunun kimliği.

webHookProperties

object

Bu alan, web kancasına giriş olarak gönderilen uyarı yüküne eklenecek özel özelliklerin belirtilmesine olanak tanır.

MetricAlertMultipleResourceMultipleMetricCriteria

Birden çok ölçüm ölçütüne sahip birden çok kaynak için ölçüm uyarısı ölçütlerini belirtir.

Name Tür Description
allOf MultiMetricCriteria[]:

bu 'tümü' işlemi için birden çok ölçüm ölçütünün listesi.

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

uyarı ölçütlerinin türünü belirtir.

MetricAlertResource

Ölçüm uyarısı kaynağı.

Name Tür Description
id

string

Azure kaynak kimliği

location

string

Kaynak konumu

name

string

Azure kaynak adı

properties.actions

MetricAlertAction[]

uyarı kuralı etkin olduğunda ve bir uyarı koşulu çözümlendiğinde gerçekleştirilen eylemler dizisi.

properties.autoMitigate

boolean

uyarının otomatik olarak çözümlenip çözümlenmeyeceğini belirten bayrak. Varsayılan değer true'dur.

properties.criteria MetricAlertCriteria:

belirli uyarı ölçüt bilgilerini tanımlar.

properties.description

string

uyarı e-postasında yer alacak ölçüm uyarısının açıklaması.

properties.enabled

boolean

ölçüm uyarısının etkinleştirilip etkinleştirilmediğini gösteren bayrak.

properties.evaluationFrequency

string

ölçüm uyarısının ISO 8601 süre biçiminde temsil edilerek değerlendirilme sıklıkları.

properties.isMigrated

boolean

bu uyarı kuralının geçirilip geçirildiğini gösteren değer.

properties.lastUpdatedTime

string

Kural en son ISO8601 biçimde güncelleştirildi.

properties.scopes

string[]

bu ölçüm uyarısının kapsamına alınan kaynak kimliğinin listesi.

properties.severity

integer

Uyarı önem derecesi {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

uyarının oluşturulduğu/güncelleştirildiği hedef kaynakların bölgesi. Kapsam bir abonelik, kaynak grubu veya birden fazla kaynak içeriyorsa zorunlu.

properties.targetResourceType

string

uyarının oluşturulduğu/güncelleştirildiği hedef kaynakların kaynak türü. Kapsam bir abonelik, kaynak grubu veya birden fazla kaynak içeriyorsa zorunlu.

properties.windowSize

string

eşiğe göre uyarı etkinliğini izlemek için kullanılan süre (ISO 8601 süre biçiminde).

tags

object

Kaynak etiketleri

type

string

Azure kaynak türü

MetricAlertResourceCollection

Uyarı kuralı kaynaklarından oluşan bir koleksiyonu temsil eder.

Name Tür Description
value

MetricAlertResource[]

uyarı kuralı kaynaklarının değerleri.

MetricAlertSingleResourceMultipleMetricCriteria

Birden çok ölçüm ölçütüne sahip tek bir kaynak için ölçüm uyarısı ölçütlerini belirtir.

Name Tür Description
allOf

MetricCriteria[]

Bu 'tümü' işlemi için ölçüm ölçütlerinin listesi.

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

uyarı ölçütlerinin türünü belirtir.

MetricCriteria

Ölçümleri filtreleme ölçütü.

Name Tür Description
criterionType string:

StaticThresholdCriterion

Eşik ölçütlerinin türünü belirtir

dimensions

MetricDimension[]

Boyut koşullarının listesi.

metricName

string

Ölçümün adı.

metricNamespace

string

Ölçümün ad alanı.

name

string

Ölçüt adı.

operator

Operator

ölçüt işleci.

skipMetricValidation

boolean

Ölçüm doğrulamasının atlanmasına neden olarak henüz yayılmamış özel bir ölçümle ilgili uyarı kuralı oluşturmaya olanak sağlar.

threshold

number

uyarıyı etkinleştiren ölçüt eşiği değeri.

timeAggregation

AggregationTypeEnum

ölçüt zaman toplama türleri.

MetricDimension

Ölçüm boyutunu belirtir.

Name Tür Description
name

string

Boyutun adı.

operator

string

boyut işleci. Yalnızca 'Include' ve 'Exclude' desteklenir

values

string[]

boyut değerlerinin listesi.

Operator

ölçüt işleci.

Name Tür Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

Web testi kaynağı için ölçüm uyarısı kuralı ölçütlerini belirtir.

Name Tür Description
componentId

string

Application Insights kaynak kimliği.

failedLocationCount

number

Başarısız konumların sayısı.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

uyarı ölçütlerinin türünü belirtir.

webTestId

string

Application Insights web testi kimliği.