Condividi tramite


Metric Alerts - List By Subscription

Recuperare le definizioni delle regole di avviso in una sottoscrizione.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

MetricAlertResourceCollection

Richiesta riuscita per un elenco di avvisi delle metriche

Other Status Codes

ErrorResponse

BadRequest

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

List metric alert rules

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
AdditionalInfo

Matrice di oggetti con proprietà 'type' e 'info'. Lo schema di 'info' è specifico del servizio e dipende dalla stringa 'type'.

AggregationTypeEnum

tipi di aggregazione temporale dei criteri.

DynamicMetricCriteria

Criterio per la soglia dinamica.

DynamicThresholdFailingPeriods

Numero minimo di violazioni necessarie all'interno dell'intervallo di tempo di lookback selezionato necessario per generare un avviso.

DynamicThresholdOperator

Operatore usato per confrontare il valore della metrica con la soglia.

DynamicThresholdSensitivity

Misura della deviazione necessaria per attivare un avviso. Ciò influirà sul livello di larghezza della soglia per il modello di serie delle metriche.

Error
ErrorDetail

Descrive i dettagli di una risposta di errore.

ErrorResponse

Descrive il formato della risposta di errore.

MetricAlertAction

Azione di avviso.

MetricAlertMultipleResourceMultipleMetricCriteria

Specifica i criteri di avviso delle metriche per più risorse con più criteri di metrica.

MetricAlertResource

Risorsa di avviso della metrica.

MetricAlertResourceCollection

Rappresenta una raccolta di risorse delle regole di avviso.

MetricAlertSingleResourceMultipleMetricCriteria

Specifica i criteri di avviso delle metriche per una singola risorsa con più criteri di metrica.

MetricCriteria

Criterio per filtrare le metriche.

MetricDimension

Specifica una dimensione metrica.

Operator

l'operatore criteria.

WebtestLocationAvailabilityCriteria

Specifica i criteri delle regole di avviso delle metriche per una risorsa di test Web.

AdditionalInfo

Matrice di oggetti con proprietà 'type' e 'info'. Lo schema di 'info' è specifico del servizio e dipende dalla stringa 'type'.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive specifiche del tipo.

type

string

Tipo di informazioni aggiuntive.

AggregationTypeEnum

tipi di aggregazione temporale dei criteri.

Nome Tipo Descrizione
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Criterio per la soglia dinamica.

Nome Tipo Descrizione
alertSensitivity

DynamicThresholdSensitivity

Misura della deviazione necessaria per attivare un avviso. Ciò influirà sul livello di larghezza della soglia per il modello di serie delle metriche.

criterionType string:

DynamicThresholdCriterion

Specifica il tipo di criteri di soglia

dimensions

MetricDimension[]

Elenco delle condizioni della dimensione.

failingPeriods

DynamicThresholdFailingPeriods

Numero minimo di violazioni necessarie all'interno dell'intervallo di tempo di lookback selezionato necessario per generare un avviso.

ignoreDataBefore

string

Usare questa opzione per impostare la data da cui iniziare ad apprendere i dati cronologici delle metriche e calcolare le soglie dinamiche (in formato ISO8601)

metricName

string

Nome della metrica.

metricNamespace

string

Spazio dei nomi della metrica.

name

string

Nome dei criteri.

operator

DynamicThresholdOperator

Operatore usato per confrontare il valore della metrica con la soglia.

skipMetricValidation

boolean

Consente di creare una regola di avviso su una metrica personalizzata che non è ancora stata generata, causando la convalida della metrica ignorata.

timeAggregation

AggregationTypeEnum

tipi di aggregazione temporale dei criteri.

DynamicThresholdFailingPeriods

Numero minimo di violazioni necessarie all'interno dell'intervallo di tempo di lookback selezionato necessario per generare un avviso.

Nome Tipo Descrizione
minFailingPeriodsToAlert

number

Numero di violazioni da attivare un avviso. Deve essere minore o uguale a numberOfEvaluationPeriods.

numberOfEvaluationPeriods

number

Numero di punti di lookback aggregati. L'intervallo di tempo di lookback viene calcolato in base alla granularità delle aggregazioni (windowSize) e al numero selezionato di punti aggregati.

DynamicThresholdOperator

Operatore usato per confrontare il valore della metrica con la soglia.

Nome Tipo Descrizione
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

Misura della deviazione necessaria per attivare un avviso. Ciò influirà sul livello di larghezza della soglia per il modello di serie delle metriche.

Nome Tipo Descrizione
High

string

Low

string

Medium

string

Error

Nome Tipo Descrizione
additionalInfo

AdditionalInfo[]

Matrice di oggetti con proprietà 'type' e 'info'. Lo schema di 'info' è specifico del servizio e dipende dalla stringa 'type'.

code

string

Stringa non localizzata che può essere usata per identificare l'errore a livello di codice.

details

ErrorDetail[]

Matrice di altri oggetti informazioni di risposta agli errori annidati, come descritto da questo contratto.

message

string

Descrive l'errore in dettaglio e fornisce informazioni di debug. Se Accept-Language è impostato nella richiesta, deve essere localizzato in tale lingua.

target

string

Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

ErrorDetail

Descrive i dettagli di una risposta di errore.

Nome Tipo Descrizione
additionalInfo

AdditionalInfo[]

Matrice di oggetti con proprietà 'type' e 'info'. Lo schema di 'info' è specifico del servizio e dipende dalla stringa 'type'.

code

string

Stringa non localizzata che può essere usata per identificare l'errore a livello di codice.

message

string

Descrive l'errore in dettaglio e fornisce informazioni di debug.

target

string

Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

ErrorResponse

Descrive il formato della risposta di errore.

Nome Tipo Descrizione
error

Error

MetricAlertAction

Azione di avviso.

Nome Tipo Descrizione
actionGroupId

string

ID del gruppo di azioni da utilizzare.

webHookProperties

object

Questo campo consente di specificare proprietà personalizzate, che verrebbero aggiunte al payload dell'avviso inviato come input al webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

Specifica i criteri di avviso delle metriche per più risorse con più criteri di metrica.

Nome Tipo Descrizione
allOf MultiMetricCriteria[]:

elenco di più criteri di metrica per questa operazione "tutto".

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

specifica il tipo dei criteri di avviso.

MetricAlertResource

Risorsa di avviso della metrica.

Nome Tipo Descrizione
id

string

ID risorsa di Azure

location

string

Percorso risorsa

name

string

Nome risorsa di Azure

properties.actions

MetricAlertAction[]

matrice di azioni eseguite quando la regola di avviso diventa attiva e quando viene risolta una condizione di avviso.

properties.autoMitigate

boolean

flag che indica se l'avviso deve essere risolto automaticamente o meno. Il valore predefinito è true.

properties.criteria MetricAlertCriteria:

definisce le informazioni specifiche sui criteri di avviso.

properties.description

string

Descrizione dell'avviso della metrica che verrà incluso nel messaggio di posta elettronica dell'avviso.

properties.enabled

boolean

flag che indica se l'avviso della metrica è abilitato.

properties.evaluationFrequency

string

con quale frequenza viene valutato l'avviso metrica rappresentato nel formato di durata ISO 8601.

properties.isMigrated

boolean

valore che indica se viene eseguita la migrazione di questa regola di avviso.

properties.lastUpdatedTime

string

Ora dell'ultimo aggiornamento della regola nel formato ISO8601.

properties.scopes

string[]

l'elenco di ID risorsa a cui ha come ambito questo avviso della metrica.

properties.severity

integer

Gravità dell'avviso {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

l'area delle risorse di destinazione in cui viene creato/aggiornato l'avviso. Obbligatorio se l'ambito contiene una sottoscrizione, un gruppo di risorse o più di una risorsa.

properties.targetResourceType

string

tipo di risorsa delle risorse di destinazione in cui viene creato/aggiornato l'avviso. Obbligatorio se l'ambito contiene una sottoscrizione, un gruppo di risorse o più di una risorsa.

properties.windowSize

string

periodo di tempo (in formato durata ISO 8601) usato per monitorare l'attività di avviso in base alla soglia.

tags

object

Tag delle risorse

type

string

Tipo di risorsa di Azure

MetricAlertResourceCollection

Rappresenta una raccolta di risorse delle regole di avviso.

Nome Tipo Descrizione
value

MetricAlertResource[]

valori per le risorse della regola di avviso.

MetricAlertSingleResourceMultipleMetricCriteria

Specifica i criteri di avviso delle metriche per una singola risorsa con più criteri di metrica.

Nome Tipo Descrizione
allOf

MetricCriteria[]

Elenco dei criteri delle metriche per questa operazione "tutto".

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

specifica il tipo dei criteri di avviso.

MetricCriteria

Criterio per filtrare le metriche.

Nome Tipo Descrizione
criterionType string:

StaticThresholdCriterion

Specifica il tipo di criteri di soglia

dimensions

MetricDimension[]

Elenco delle condizioni della dimensione.

metricName

string

Nome della metrica.

metricNamespace

string

Spazio dei nomi della metrica.

name

string

Nome dei criteri.

operator

Operator

l'operatore criteria.

skipMetricValidation

boolean

Consente di creare una regola di avviso su una metrica personalizzata che non è ancora stata generata, causando la convalida della metrica ignorata.

threshold

number

valore soglia criteri che attiva l'avviso.

timeAggregation

AggregationTypeEnum

tipi di aggregazione temporale dei criteri.

MetricDimension

Specifica una dimensione metrica.

Nome Tipo Descrizione
name

string

Nome della dimensione.

operator

string

Operatore della dimensione. Sono supportati solo 'Include' e 'Exclude'

values

string[]

elenco di valori delle dimensioni.

Operator

l'operatore criteria.

Nome Tipo Descrizione
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

Specifica i criteri delle regole di avviso delle metriche per una risorsa di test Web.

Nome Tipo Descrizione
componentId

string

ID risorsa di Application Insights.

failedLocationCount

number

Numero di posizioni non riuscite.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

specifica il tipo dei criteri di avviso.

webTestId

string

ID test Web di Application Insights.