Delen via


Metric Alerts - List By Subscription

Waarschuwingsregeldefinities ophalen in een abonnement.

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

URI-parameters

Name In Vereist Type Description
subscriptionId
path True

string

De id van het doelabonnement.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

MetricAlertResourceCollection

Geslaagde aanvraag voor een lijst met metrische waarschuwingen

Other Status Codes

ErrorResponse

BadRequest

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

List metric alert rules

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AdditionalInfo

Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.

AggregationTypeEnum

de aggregatietypen voor criteriatijd.

DynamicMetricCriteria

Criterium voor dynamische drempelwaarde.

DynamicThresholdFailingPeriods

Het minimale aantal schendingen dat is vereist in het geselecteerde tijdvenster voor terugkijken dat is vereist om een waarschuwing te genereren.

DynamicThresholdOperator

De operator die wordt gebruikt om de metrische waarde te vergelijken met de drempelwaarde.

DynamicThresholdSensitivity

De mate van afwijking die is vereist voor het activeren van een waarschuwing. Dit is van invloed op hoe strak de drempelwaarde is voor het patroon van de metrische reeks.

Error
ErrorDetail

Beschrijft details van een foutreactie.

ErrorResponse

Beschrijft de indeling van foutreactie.

MetricAlertAction

Een waarschuwingsactie.

MetricAlertMultipleResourceMultipleMetricCriteria

Hiermee geeft u de metrische waarschuwingscriteria op voor meerdere resources met meerdere metrische criteria.

MetricAlertResource

De resource voor metrische waarschuwingen.

MetricAlertResourceCollection

Vertegenwoordigt een verzameling waarschuwingsregelbronnen.

MetricAlertSingleResourceMultipleMetricCriteria

Hiermee geeft u de metrische waarschuwingscriteria op voor één resource met meerdere metrische criteria.

MetricCriteria

Criterium voor het filteren van metrische gegevens.

MetricDimension

Hiermee geeft u een dimensie voor metrische gegevens op.

Operator

de criteriumoperator.

WebtestLocationAvailabilityCriteria

Hiermee geeft u de criteria voor de metrische waarschuwingsregel voor een webtestresource op.

AdditionalInfo

Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.

Name Type Description
info

object

De aanvullende informatie die specifiek is voor het type.

type

string

Het type aanvullende informatie.

AggregationTypeEnum

de aggregatietypen voor criteriatijd.

Name Type Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Criterium voor dynamische drempelwaarde.

Name Type Description
alertSensitivity

DynamicThresholdSensitivity

De mate van afwijking die is vereist voor het activeren van een waarschuwing. Dit is van invloed op hoe strak de drempelwaarde is voor het patroon van de metrische reeks.

criterionType string:

DynamicThresholdCriterion

Hiermee geeft u het type drempelwaarden op

dimensions

MetricDimension[]

Lijst met dimensievoorwaarden.

failingPeriods

DynamicThresholdFailingPeriods

Het minimale aantal schendingen dat is vereist in het geselecteerde tijdvenster voor terugkijken dat is vereist om een waarschuwing te genereren.

ignoreDataBefore

string

Gebruik deze optie om de datum in te stellen van waaruit u de historische metrische gegevens wilt leren en de dynamische drempelwaarden (in ISO8601 notatie) wilt berekenen

metricName

string

Naam van de metrische waarde.

metricNamespace

string

Naamruimte van de metrische waarde.

name

string

Naam van de criteria.

operator

DynamicThresholdOperator

De operator die wordt gebruikt om de metrische waarde te vergelijken met de drempelwaarde.

skipMetricValidation

boolean

Hiermee kunt u een waarschuwingsregel maken voor een aangepaste metrische waarde die nog niet is verzonden, door ervoor te zorgen dat de metrische validatie wordt overgeslagen.

timeAggregation

AggregationTypeEnum

de aggregatietypen voor criteriatijd.

DynamicThresholdFailingPeriods

Het minimale aantal schendingen dat is vereist in het geselecteerde tijdvenster voor terugkijken dat is vereist om een waarschuwing te genereren.

Name Type Description
minFailingPeriodsToAlert

number

Het aantal schendingen dat een waarschuwing activeert. Moet kleiner of gelijk zijn aan numberOfEvaluationPeriods.

numberOfEvaluationPeriods

number

Het aantal geaggregeerde lookbackpunten. Het tijdvenster voor lookback wordt berekend op basis van de aggregatiegranulariteit (windowSize) en het geselecteerde aantal geaggregeerde punten.

DynamicThresholdOperator

De operator die wordt gebruikt om de metrische waarde te vergelijken met de drempelwaarde.

Name Type Description
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

De mate van afwijking die is vereist voor het activeren van een waarschuwing. Dit is van invloed op hoe strak de drempelwaarde is voor het patroon van de metrische reeks.

Name Type Description
High

string

Low

string

Medium

string

Error

Name Type Description
additionalInfo

AdditionalInfo[]

Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.

code

string

Niet-gelokaliseerde tekenreeks die kan worden gebruikt om de fout programmatisch te identificeren.

details

ErrorDetail[]

Een matrix met aanvullende geneste informatieobjecten voor foutreacties, zoals beschreven in dit contract.

message

string

Hierin wordt de fout gedetailleerd beschreven en vindt u informatie over foutopsporing. Als Accept-Language is ingesteld in de aanvraag, moet deze worden gelokaliseerd naar die taal.

target

string

Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

ErrorDetail

Beschrijft details van een foutreactie.

Name Type Description
additionalInfo

AdditionalInfo[]

Een matrix met objecten met de eigenschappen 'type' en 'info'. Het schema van 'info' is servicespecifiek en is afhankelijk van de tekenreeks 'type'.

code

string

Niet-gelokaliseerde tekenreeks die kan worden gebruikt om de fout programmatisch te identificeren.

message

string

Hierin wordt de fout gedetailleerd beschreven en vindt u informatie over foutopsporing.

target

string

Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

ErrorResponse

Beschrijft de indeling van foutreactie.

Name Type Description
error

Error

MetricAlertAction

Een waarschuwingsactie.

Name Type Description
actionGroupId

string

de id van de actiegroep die moet worden gebruikt.

webHookProperties

object

Met dit veld kunt u aangepaste eigenschappen opgeven, die worden toegevoegd aan de nettolading van de waarschuwing die als invoer naar de webhook wordt verzonden.

MetricAlertMultipleResourceMultipleMetricCriteria

Hiermee geeft u de metrische waarschuwingscriteria op voor meerdere resources met meerdere metrische criteria.

Name Type Description
allOf MultiMetricCriteria[]:

de lijst met meerdere metrische criteria voor deze 'all'-bewerking.

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

geeft het type van de waarschuwingscriteria op.

MetricAlertResource

De resource voor metrische waarschuwingen.

Name Type Description
id

string

Azure-resource-id

location

string

Resourcelocatie

name

string

Azure-resourcenaam

properties.actions

MetricAlertAction[]

de matrix van acties die worden uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost.

properties.autoMitigate

boolean

de vlag die aangeeft of de waarschuwing automatisch moet worden opgelost of niet. De standaardwaarde is waar.

properties.criteria MetricAlertCriteria:

definieert de specifieke informatie over waarschuwingscriteria.

properties.description

string

de beschrijving van de metrische waarschuwing die wordt opgenomen in de waarschuwings-e-mail.

properties.enabled

boolean

de vlag die aangeeft of de waarschuwing voor metrische gegevens is ingeschakeld.

properties.evaluationFrequency

string

hoe vaak de waarschuwing voor metrische gegevens wordt geëvalueerd in iso 8601-duurnotatie.

properties.isMigrated

boolean

de waarde die aangeeft of deze waarschuwingsregel wordt gemigreerd.

properties.lastUpdatedTime

string

De laatste keer dat de regel is bijgewerkt in ISO8601 indeling.

properties.scopes

string[]

de lijst met resource-id's waarop deze metrische waarschuwing is gericht.

properties.severity

integer

Ernst van waarschuwing {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

de regio van de doelresource(s) waarop de waarschuwing wordt gemaakt/bijgewerkt. Verplicht als het bereik een abonnement, resourcegroep of meer dan één resource bevat.

properties.targetResourceType

string

het resourcetype van de doelresource(s) waarop de waarschuwing wordt gemaakt/bijgewerkt. Verplicht als het bereik een abonnement, resourcegroep of meer dan één resource bevat.

properties.windowSize

string

de periode (in ISO 8601-duurnotatie) die wordt gebruikt voor het bewaken van waarschuwingsactiviteiten op basis van de drempelwaarde.

tags

object

Resourcetags

type

string

Azure-resourcetype

MetricAlertResourceCollection

Vertegenwoordigt een verzameling waarschuwingsregelbronnen.

Name Type Description
value

MetricAlertResource[]

de waarden voor de resources van de waarschuwingsregel.

MetricAlertSingleResourceMultipleMetricCriteria

Hiermee geeft u de metrische waarschuwingscriteria op voor één resource met meerdere metrische criteria.

Name Type Description
allOf

MetricCriteria[]

De lijst met metrische criteria voor deze 'all'-bewerking.

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

geeft het type van de waarschuwingscriteria op.

MetricCriteria

Criterium voor het filteren van metrische gegevens.

Name Type Description
criterionType string:

StaticThresholdCriterion

Hiermee geeft u het type drempelwaarden op

dimensions

MetricDimension[]

Lijst met dimensievoorwaarden.

metricName

string

Naam van de metrische waarde.

metricNamespace

string

Naamruimte van de metrische waarde.

name

string

Naam van de criteria.

operator

Operator

de criteriumoperator.

skipMetricValidation

boolean

Hiermee kunt u een waarschuwingsregel maken voor een aangepaste metrische waarde die nog niet is verzonden, door ervoor te zorgen dat de metrische validatie wordt overgeslagen.

threshold

number

de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd.

timeAggregation

AggregationTypeEnum

de aggregatietypen voor criteriatijd.

MetricDimension

Hiermee geeft u een dimensie voor metrische gegevens op.

Name Type Description
name

string

Naam van de dimensie.

operator

string

de dimensieoperator. Alleen Opnemen en Uitsluiten worden ondersteund

values

string[]

lijst met dimensiewaarden.

Operator

de criteriumoperator.

Name Type Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

Hiermee geeft u de criteria voor de metrische waarschuwingsregel voor een webtestresource op.

Name Type Description
componentId

string

De Application Insights-resource-id.

failedLocationCount

number

Het aantal mislukte locaties.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

geeft het type van de waarschuwingscriteria op.

webTestId

string

De Application Insights-webtest-id.