Dela via


Metric Alerts - List By Resource Group

Hämta aviseringsregeldefinitioner i en resursgrupp.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

DEN API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

MetricAlertResourceCollection

Lyckad begäran om en lista över måttaviseringar

Other Status Codes

ErrorResponse

BadRequest

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

List metric alert rules

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AdditionalInfo

En matris med objekt med egenskaperna "type" och "info". Schemat för "info" är tjänstspecifikt och beroende av strängen "typ".

AggregationTypeEnum

villkorets tidsaggregeringstyper.

DynamicMetricCriteria

Kriterium för dynamiskt tröskelvärde.

DynamicThresholdFailingPeriods

Det minsta antal överträdelser som krävs inom det valda återställningstidsfönstret som krävs för att skapa en avisering.

DynamicThresholdOperator

Operatorn som används för att jämföra måttvärdet med tröskelvärdet.

DynamicThresholdSensitivity

Omfattningen av den avvikelse som krävs för att utlösa en avisering. Detta påverkar hur nära tröskelvärdet är för mönstret för måttserier.

Error
ErrorDetail

Beskriver information om ett felsvar.

ErrorResponse

Beskriver formatet för Felsvar.

MetricAlertAction

En aviseringsåtgärd.

MetricAlertMultipleResourceMultipleMetricCriteria

Anger måttaviseringsvillkoren för flera resurser som har flera måttvillkor.

MetricAlertResource

Måttaviseringsresursen.

MetricAlertResourceCollection

Representerar en samling aviseringsregelresurser.

MetricAlertSingleResourceMultipleMetricCriteria

Anger måttaviseringsvillkoren för en enskild resurs som har flera måttvillkor.

MetricCriteria

Kriterium för att filtrera mått.

MetricDimension

Anger en måttdimension.

Operator

villkorsoperatorn.

WebtestLocationAvailabilityCriteria

Anger villkoret för måttaviseringsregeln för en webbtestresurs.

AdditionalInfo

En matris med objekt med egenskaperna "type" och "info". Schemat för "info" är tjänstspecifikt och beroende av strängen "typ".

Name Typ Description
info

object

Ytterligare information som är specifik för typen.

type

string

Typ av ytterligare information.

AggregationTypeEnum

villkorets tidsaggregeringstyper.

Name Typ Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Kriterium för dynamiskt tröskelvärde.

Name Typ Description
alertSensitivity

DynamicThresholdSensitivity

Omfattningen av den avvikelse som krävs för att utlösa en avisering. Detta påverkar hur nära tröskelvärdet är för mönstret för måttserier.

criterionType string:

DynamicThresholdCriterion

Anger typ av tröskelvärden

dimensions

MetricDimension[]

Lista över dimensionsvillkor.

failingPeriods

DynamicThresholdFailingPeriods

Det minsta antal överträdelser som krävs inom det valda återställningstidsfönstret som krävs för att skapa en avisering.

ignoreDataBefore

string

Använd det här alternativet om du vill ange det datum från vilket du vill börja lära dig historiska måttdata och beräkna dynamiska tröskelvärden (i ISO8601 format)

metricName

string

Måttets namn.

metricNamespace

string

Måttets namnområde.

name

string

Villkorets namn.

operator

DynamicThresholdOperator

Operatorn som används för att jämföra måttvärdet med tröskelvärdet.

skipMetricValidation

boolean

Tillåter att du skapar en aviseringsregel för ett anpassat mått som ännu inte har genererats, genom att göra så att måttverifieringen hoppas över.

timeAggregation

AggregationTypeEnum

villkorets tidsaggregeringstyper.

DynamicThresholdFailingPeriods

Det minsta antal överträdelser som krävs inom det valda återställningstidsfönstret som krävs för att skapa en avisering.

Name Typ Description
minFailingPeriodsToAlert

number

Antalet överträdelser för att utlösa en avisering. Bör vara mindre eller lika med numberOfEvaluationPeriods.

numberOfEvaluationPeriods

number

Antalet aggregerade återblickspunkter. Lookback-tidsfönstret beräknas baserat på sammansättningskornigheten (windowSize) och det valda antalet aggregerade punkter.

DynamicThresholdOperator

Operatorn som används för att jämföra måttvärdet med tröskelvärdet.

Name Typ Description
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

Omfattningen av den avvikelse som krävs för att utlösa en avisering. Detta påverkar hur nära tröskelvärdet är för mönstret för måttserier.

Name Typ Description
High

string

Low

string

Medium

string

Error

Name Typ Description
additionalInfo

AdditionalInfo[]

En matris med objekt med egenskaperna "type" och "info". Schemat för "info" är tjänstspecifikt och beroende av strängen "typ".

code

string

Oallokerad sträng som kan användas för att programmatiskt identifiera felet.

details

ErrorDetail[]

En matris med ytterligare kapslade felsvarsinformationsobjekt enligt beskrivningen i det här kontraktet.

message

string

Beskriver felet i detalj och tillhandahåller felsökningsinformation. Om Accept-Language anges i begäran måste det lokaliseras till det språket.

target

string

Målet för det specifika felet (till exempel namnet på egenskapen i fel).

ErrorDetail

Beskriver information om ett felsvar.

Name Typ Description
additionalInfo

AdditionalInfo[]

En matris med objekt med egenskaperna "type" och "info". Schemat för "info" är tjänstspecifikt och beroende av strängen "typ".

code

string

Oallokerad sträng som kan användas för att programmatiskt identifiera felet.

message

string

Beskriver felet i detalj och tillhandahåller felsökningsinformation.

target

string

Målet för det specifika felet (till exempel namnet på egenskapen i fel).

ErrorResponse

Beskriver formatet för Felsvar.

Name Typ Description
error

Error

MetricAlertAction

En aviseringsåtgärd.

Name Typ Description
actionGroupId

string

ID:t för åtgärdsgruppen som ska användas.

webHookProperties

object

Med det här fältet kan du ange anpassade egenskaper som läggs till i aviseringsnyttolasten som skickas som indata till webhooken.

MetricAlertMultipleResourceMultipleMetricCriteria

Anger måttaviseringsvillkoren för flera resurser som har flera måttvillkor.

Name Typ Description
allOf MultiMetricCriteria[]:

listan över flera måttkriterier för den här "all of"-åtgärden.

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

anger typen av aviseringsvillkor.

MetricAlertResource

Måttaviseringsresursen.

Name Typ Description
id

string

Azure-resurs-ID

location

string

Resursplats

name

string

Azure-resursnamn

properties.actions

MetricAlertAction[]

matrisen med åtgärder som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts.

properties.autoMitigate

boolean

flaggan som anger om aviseringen ska lösas automatiskt eller inte. Standardvärdet är sant.

properties.criteria MetricAlertCriteria:

definierar den specifika informationen om aviseringsvillkor.

properties.description

string

beskrivningen av måttaviseringen som ska ingå i aviseringsmeddelandet.

properties.enabled

boolean

flaggan som anger om måttaviseringen är aktiverad.

properties.evaluationFrequency

string

hur ofta måttaviseringen utvärderas representeras i ISO 8601-varaktighetsformat.

properties.isMigrated

boolean

värdet som anger om den här aviseringsregeln migreras.

properties.lastUpdatedTime

string

Senast regeln uppdaterades i ISO8601 format.

properties.scopes

string[]

listan över resurs-ID:er som den här måttaviseringen är begränsad till.

properties.severity

integer

Allvarlighetsgrad {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

regionen för de målresurser där aviseringen skapas/uppdateras. Obligatoriskt om omfånget innehåller en prenumeration, resursgrupp eller mer än en resurs.

properties.targetResourceType

string

resurstypen för de målresurser där aviseringen skapas/uppdateras. Obligatoriskt om omfånget innehåller en prenumeration, resursgrupp eller mer än en resurs.

properties.windowSize

string

tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet.

tags

object

Resurstaggar

type

string

Azure-resurstyp

MetricAlertResourceCollection

Representerar en samling aviseringsregelresurser.

Name Typ Description
value

MetricAlertResource[]

värdena för aviseringsregelresurserna.

MetricAlertSingleResourceMultipleMetricCriteria

Anger måttaviseringsvillkoren för en enskild resurs som har flera måttvillkor.

Name Typ Description
allOf

MetricCriteria[]

Listan över måttkriterier för den här åtgärden "alla".

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

anger typen av aviseringsvillkor.

MetricCriteria

Kriterium för att filtrera mått.

Name Typ Description
criterionType string:

StaticThresholdCriterion

Anger typ av tröskelvärden

dimensions

MetricDimension[]

Lista över dimensionsvillkor.

metricName

string

Måttets namn.

metricNamespace

string

Måttets namnområde.

name

string

Villkorets namn.

operator

Operator

villkorsoperatorn.

skipMetricValidation

boolean

Tillåter att du skapar en aviseringsregel för ett anpassat mått som ännu inte har genererats, genom att göra så att måttverifieringen hoppas över.

threshold

number

villkorströskelvärdet som aktiverar aviseringen.

timeAggregation

AggregationTypeEnum

villkorets tidsaggregeringstyper.

MetricDimension

Anger en måttdimension.

Name Typ Description
name

string

Namnet på dimensionen.

operator

string

dimensionsoperatorn. Endast "Inkludera" och "Exkludera" stöds

values

string[]

lista över dimensionsvärden.

Operator

villkorsoperatorn.

Name Typ Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

Anger villkoret för måttaviseringsregeln för en webbtestresurs.

Name Typ Description
componentId

string

Application Insights-resurs-ID:t.

failedLocationCount

number

Antalet misslyckade platser.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

anger typen av aviseringsvillkor.

webTestId

string

Application Insights webbtest-ID.