Metric Alerts - List By Subscription
구독에서 경고 규칙 정의를 검색합니다.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
대상 구독의 ID입니다. |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
메트릭 경고 목록에 대한 성공적인 요청 |
|
Other Status Codes |
BadRequest |
보안
azure_auth
Azure Active Directory OAuth2 Flow
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
List metric alert rules
샘플 요청
GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
샘플 응답
{
"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"
}
}
]
}
}
]
}
정의
Name | Description |
---|---|
Additional |
'type' 및 'info' 속성이 있는 개체의 배열입니다. 'info'의 스키마는 서비스별 스키마이며 'type' 문자열에 따라 달라집니다. |
Aggregation |
조건 시간 집계 형식입니다. |
Dynamic |
동적 임계값에 대한 기준입니다. |
Dynamic |
경고를 발생 하는 데 필요한 선택한 조회 시간 범위 내에서 필요한 위반의 최소 수입니다. |
Dynamic |
메트릭 값을 임계값과 비교하는 데 사용되는 연산자입니다. |
Dynamic |
경고를 트리거하는 데 필요한 편차 범위입니다. 이는 임계값이 메트릭 계열 패턴에 얼마나 촉박한지에 영향을 줍니다. |
Error | |
Error |
오류 응답의 세부 정보를 설명합니다. |
Error |
오류 응답의 형식을 설명합니다. |
Metric |
경고 작업입니다. |
Metric |
여러 메트릭 조건이 있는 여러 리소스에 대한 메트릭 경고 조건을 지정합니다. |
Metric |
메트릭 경고 리소스입니다. |
Metric |
경고 규칙 리소스의 컬렉션을 나타냅니다. |
Metric |
여러 메트릭 조건이 있는 단일 리소스에 대한 메트릭 경고 조건을 지정합니다. |
Metric |
메트릭을 필터링하는 기준입니다. |
Metric |
메트릭 차원을 지정합니다. |
Operator |
조건 연산자입니다. |
Webtest |
웹 테스트 리소스에 대한 메트릭 경고 규칙 조건을 지정합니다. |
AdditionalInfo
'type' 및 'info' 속성이 있는 개체의 배열입니다. 'info'의 스키마는 서비스별 스키마이며 'type' 문자열에 따라 달라집니다.
Name | 형식 | Description |
---|---|---|
info |
object |
형식과 관련된 추가 정보입니다. |
type |
string |
추가 정보의 유형입니다. |
AggregationTypeEnum
조건 시간 집계 형식입니다.
Name | 형식 | Description |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
동적 임계값에 대한 기준입니다.
Name | 형식 | Description |
---|---|---|
alertSensitivity |
경고를 트리거하는 데 필요한 편차 범위입니다. 이는 임계값이 메트릭 계열 패턴에 얼마나 촉박한지에 영향을 줍니다. |
|
criterionType |
string:
Dynamic |
임계값 조건의 유형을 지정합니다. |
dimensions |
차원 조건 목록입니다. |
|
failingPeriods |
경고를 발생 하는 데 필요한 선택한 조회 시간 범위 내에서 필요한 위반의 최소 수입니다. |
|
ignoreDataBefore |
string |
이 옵션을 사용하여 메트릭 기록 데이터 학습을 시작하고 동적 임계값(ISO8601 형식)을 계산할 날짜를 설정합니다. |
metricName |
string |
메트릭의 이름입니다. |
metricNamespace |
string |
메트릭의 네임스페이스입니다. |
name |
string |
조건의 이름입니다. |
operator |
메트릭 값을 임계값과 비교하는 데 사용되는 연산자입니다. |
|
skipMetricValidation |
boolean |
메트릭 유효성 검사를 건너뛰게 하여 아직 내보내지 않은 사용자 지정 메트릭에 대한 경고 규칙을 만들 수 있습니다. |
timeAggregation |
조건 시간 집계 형식입니다. |
DynamicThresholdFailingPeriods
경고를 발생 하는 데 필요한 선택한 조회 시간 범위 내에서 필요한 위반의 최소 수입니다.
Name | 형식 | Description |
---|---|---|
minFailingPeriodsToAlert |
number |
경고를 트리거하는 위반 횟수입니다. numberOfEvaluationPeriods와 작거나 같아야 합니다. |
numberOfEvaluationPeriods |
number |
집계된 조회 지점의 수입니다. 조회 기간은 집계 세분성(windowSize) 및 선택한 집계 지점 수를 기준으로 계산됩니다. |
DynamicThresholdOperator
메트릭 값을 임계값과 비교하는 데 사용되는 연산자입니다.
Name | 형식 | Description |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
경고를 트리거하는 데 필요한 편차 범위입니다. 이는 임계값이 메트릭 계열 패턴에 얼마나 촉박한지에 영향을 줍니다.
Name | 형식 | Description |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
Error
Name | 형식 | Description |
---|---|---|
additionalInfo |
'type' 및 'info' 속성이 있는 개체의 배열입니다. 'info'의 스키마는 서비스별 스키마이며 'type' 문자열에 따라 달라집니다. |
|
code |
string |
오류를 프로그래밍 방식으로 식별하는 데 사용할 수 있는 지역화되지 않은 문자열입니다. |
details |
이 계약에 설명된 대로 중첩된 추가 오류 응답 정보 개체의 배열입니다. |
|
message |
string |
오류를 자세히 설명하고 디버깅 정보를 제공합니다. 요청에 Accept-Language 설정된 경우 해당 언어로 지역화되어야 합니다. |
target |
string |
특정 오류의 대상입니다(예: 오류에 있는 속성의 이름). |
ErrorDetail
오류 응답의 세부 정보를 설명합니다.
Name | 형식 | Description |
---|---|---|
additionalInfo |
'type' 및 'info' 속성이 있는 개체의 배열입니다. 'info'의 스키마는 서비스별 스키마이며 'type' 문자열에 따라 달라집니다. |
|
code |
string |
오류를 프로그래밍 방식으로 식별하는 데 사용할 수 있는 지역화되지 않은 문자열입니다. |
message |
string |
오류를 자세히 설명하고 디버깅 정보를 제공합니다. |
target |
string |
특정 오류의 대상입니다(예: 오류에 있는 속성의 이름). |
ErrorResponse
오류 응답의 형식을 설명합니다.
Name | 형식 | Description |
---|---|---|
error |
MetricAlertAction
경고 작업입니다.
Name | 형식 | Description |
---|---|---|
actionGroupId |
string |
사용할 작업 그룹의 ID입니다. |
webHookProperties |
object |
이 필드를 사용하면 웹후크에 대한 입력으로 전송되는 경고 페이로드에 추가되는 사용자 지정 속성을 지정할 수 있습니다. |
MetricAlertMultipleResourceMultipleMetricCriteria
여러 메트릭 조건이 있는 여러 리소스에 대한 메트릭 경고 조건을 지정합니다.
Name | 형식 | Description |
---|---|---|
allOf | MultiMetricCriteria[]: |
이 'all of' 작업에 대한 여러 메트릭 조건 목록입니다. |
odata.type |
string:
Microsoft. |
는 경고 조건의 유형을 지정합니다. |
MetricAlertResource
메트릭 경고 리소스입니다.
Name | 형식 | Description |
---|---|---|
id |
string |
Azure 리소스 ID |
location |
string |
리소스 위치 |
name |
string |
Azure 리소스 이름 |
properties.actions |
경고 규칙이 활성화되고 경고 조건이 해결될 때 수행되는 작업의 배열입니다. |
|
properties.autoMitigate |
boolean |
경고를 자동으로 해결해야 하는지 여부를 나타내는 플래그입니다. 기본값은 true입니다. |
properties.criteria | MetricAlertCriteria: |
는 특정 경고 조건 정보를 정의합니다. |
properties.description |
string |
경고 이메일에 포함될 메트릭 경고에 대한 설명입니다. |
properties.enabled |
boolean |
메트릭 경고가 사용되는지 여부를 나타내는 플래그입니다. |
properties.evaluationFrequency |
string |
메트릭 경고가 ISO 8601 기간 형식으로 표시되는 빈도입니다. |
properties.isMigrated |
boolean |
이 경고 규칙이 마이그레이션되는지 여부를 나타내는 값입니다. |
properties.lastUpdatedTime |
string |
마지막으로 규칙이 ISO8601 형식으로 업데이트되었습니다. |
properties.scopes |
string[] |
이 메트릭 경고의 범위가 지정된 리소스 ID 목록입니다. |
properties.severity |
integer |
경고 심각도 {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
경고가 생성/업데이트되는 대상 리소스의 지역입니다. 범위에 구독, 리소스 그룹 또는 둘 이상의 리소스가 포함된 경우 필수입니다. |
properties.targetResourceType |
string |
경고가 생성/업데이트되는 대상 리소스의 리소스 종류입니다. 범위에 구독, 리소스 그룹 또는 둘 이상의 리소스가 포함된 경우 필수입니다. |
properties.windowSize |
string |
임계값에 따라 경고 활동을 모니터링하는 데 사용되는 기간(ISO 8601 기간 형식)입니다. |
tags |
object |
리소스 태그 |
type |
string |
Azure 리소스 종류 |
MetricAlertResourceCollection
경고 규칙 리소스의 컬렉션을 나타냅니다.
Name | 형식 | Description |
---|---|---|
value |
경고 규칙 리소스의 값입니다. |
MetricAlertSingleResourceMultipleMetricCriteria
여러 메트릭 조건이 있는 단일 리소스에 대한 메트릭 경고 조건을 지정합니다.
Name | 형식 | Description |
---|---|---|
allOf |
이 '모두' 작업에 대한 메트릭 조건 목록입니다. |
|
odata.type |
string:
Microsoft. |
는 경고 조건의 유형을 지정합니다. |
MetricCriteria
메트릭을 필터링하는 기준입니다.
Name | 형식 | Description |
---|---|---|
criterionType |
string:
Static |
임계값 조건의 유형을 지정합니다. |
dimensions |
차원 조건 목록입니다. |
|
metricName |
string |
메트릭의 이름입니다. |
metricNamespace |
string |
메트릭의 네임스페이스입니다. |
name |
string |
조건의 이름입니다. |
operator |
조건 연산자입니다. |
|
skipMetricValidation |
boolean |
메트릭 유효성 검사를 건너뛰게 하여 아직 내보내지 않은 사용자 지정 메트릭에 대한 경고 규칙을 만들 수 있습니다. |
threshold |
number |
경고를 활성화하는 조건 임계값입니다. |
timeAggregation |
조건 시간 집계 형식입니다. |
MetricDimension
메트릭 차원을 지정합니다.
Name | 형식 | Description |
---|---|---|
name |
string |
차원의 이름입니다. |
operator |
string |
차원 연산자입니다. 'Include' 및 'Exclude'만 지원됩니다. |
values |
string[] |
차원 값 목록입니다. |
Operator
조건 연산자입니다.
Name | 형식 | Description |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
웹 테스트 리소스에 대한 메트릭 경고 규칙 조건을 지정합니다.
Name | 형식 | Description |
---|---|---|
componentId |
string |
Application Insights 리소스 ID입니다. |
failedLocationCount |
number |
실패한 위치의 수입니다. |
odata.type |
string:
Microsoft. |
는 경고 조건의 유형을 지정합니다. |
webTestId |
string |
Application Insights 웹 테스트 ID입니다. |