Dela via


Metric Alerts - Update

Uppdatera en måttaviseringsdefinition.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

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

ruleName
path True

string

Namnet på regeln.

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.

Begärandetext

Name Typ Description
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.scopes

string[]

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

properties.severity

integer

Allvarlighetsgrad för aviseringar {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

regionen för de målresurser där aviseringen skapas/uppdateras. Obligatoriskt för MultipleResourceMultipleMetricCriteria.

properties.targetResourceType

string

resurstypen för de målresurser där aviseringen skapas/uppdateras. Obligatoriskt för MultipleResourceMultipleMetricCriteria.

properties.windowSize

string

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

tags

object

Resurstaggar

Svar

Name Typ Description
200 OK

MetricAlertResource

OK

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

Create or update an alert rule

Exempelbegäran

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

{
  "tags": {},
  "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": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Exempelsvar

{
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
  "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": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Definitioner

Name Description
AggregationTypeEnum

kriteriernas tidsaggregeringstyper.

DynamicMetricCriteria

Kriterium för dynamiskt tröskelvärde.

DynamicThresholdFailingPeriods

Det minsta antalet överträdelser som krävs inom det valda lookback-tidsfö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

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åttseriemönstret.

ErrorResponse

Beskriver formatet felsvar.

MetricAlertAction

En aviseringsåtgärd.

MetricAlertMultipleResourceMultipleMetricCriteria

Anger måttaviseringskriterierna för flera resurser som har flera måttkriterier.

MetricAlertResource

Måttaviseringsresursen.

MetricAlertResourcePatch

Måttaviseringsresursen för korrigeringsåtgärder.

MetricAlertSingleResourceMultipleMetricCriteria

Anger måttaviseringskriterierna för en enskild resurs som har flera måttkriterier.

MetricCriteria

Kriterium för att filtrera mått.

MetricDimension

Anger en måttdimension.

Operator

villkorsoperatorn.

WebtestLocationAvailabilityCriteria

Anger kriterierna för måttaviseringsregler för en webbtestresurs.

AggregationTypeEnum

kriteriernas 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

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åttseriemönstret.

criterionType string:

DynamicThresholdCriterion

Anger typ av tröskelvärden

dimensions

MetricDimension[]

Lista över dimensionsvillkor.

failingPeriods

DynamicThresholdFailingPeriods

Det minsta antalet överträdelser som krävs inom det valda lookback-tidsfönstret som krävs för att skapa en avisering.

ignoreDataBefore

string

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

metricName

string

Måttets namn.

metricNamespace

string

Måttets namnområde.

name

string

Namn på villkoret.

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 inte har genererats än, genom att göra så att måttverifieringen hoppas över.

timeAggregation

AggregationTypeEnum

kriteriernas tidsaggregeringstyper.

DynamicThresholdFailingPeriods

Det minsta antalet överträdelser som krävs inom det valda lookback-tidsfö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

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åttseriemönstret.

Name Typ Description
High

string

Low

string

Medium

string

ErrorResponse

Beskriver formatet felsvar.

Name Typ Description
code

string

Felkod

message

string

Felmeddelande som anger varför åtgärden misslyckades.

MetricAlertAction

En aviseringsåtgärd.

Name Typ Description
actionGroupId

string

ID:t för den åtgärdsgrupp 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åttaviseringskriterierna för flera resurser som har flera måttkriterier.

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 uppdaterades regeln i ISO8601 format.

properties.scopes

string[]

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

properties.severity

integer

Allvarlighetsgrad för aviseringar {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

MetricAlertResourcePatch

Måttaviseringsresursen för korrigeringsåtgärder.

Name Typ Description
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 uppdaterades regeln i ISO8601 format.

properties.scopes

string[]

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

properties.severity

integer

Allvarlighetsgrad för aviseringar {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

regionen för de målresurser där aviseringen skapas/uppdateras. Obligatoriskt för MultipleResourceMultipleMetricCriteria.

properties.targetResourceType

string

resurstypen för de målresurser där aviseringen skapas/uppdateras. Obligatoriskt för MultipleResourceMultipleMetricCriteria.

properties.windowSize

string

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

tags

object

Resurstaggar

MetricAlertSingleResourceMultipleMetricCriteria

Anger måttaviseringskriterierna för en enskild resurs som har flera måttkriterier.

Name Typ Description
allOf

MetricCriteria[]

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

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

Namn på villkoret.

operator

Operator

villkorsoperatorn.

skipMetricValidation

boolean

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

threshold

number

villkorströskelvärdet som aktiverar aviseringen.

timeAggregation

AggregationTypeEnum

kriteriernas 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 kriterierna för måttaviseringsregler för en webbtestresurs.

Name Typ Description
componentId

string

Application Insights-resurs-ID.

failedLocationCount

number

Antalet misslyckade platser.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

anger typen av aviseringsvillkor.

webTestId

string

Application Insights webbtest-ID.