Smart Detector Alert Rules - Get

Dienst:

Monitor

API-Version:

2019-06-01

Rufen Sie eine bestimmte Smart Detector-Warnungsregel ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}?api-version=2019-06-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}?api-version=2019-06-01&expandDetector={expandDetector}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
alertRuleName	path	True	string	Der Name der Warnungsregel.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string	Client-API-Version.
expandDetector	query		boolean	Gibt an, ob smarte Detektor erweitert werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AlertRule	Erfolgreiche Anforderung zum Abrufen der Smart Detector-Warnungsregel.
Other Status Codes	SmartDetectorErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a Smart Detector alert rule

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule?api-version=2019-06-01

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule",
  "type": "Microsoft.AlertsManagement/smartDetectorAlertRules",
  "name": "MyAlertRule",
  "location": "global",
  "tags": {},
  "properties": {
    "description": "Sample smart detector alert rule description",
    "state": "Enabled",
    "severity": "Sev3",
    "frequency": "PT5M",
    "detector": {
      "id": "VMMemoryLeak"
    },
    "scope": [
      "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyVms/providers/Microsoft.Compute/virtualMachines/vm1"
    ],
    "actionGroups": [
      {
        "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/MyActionGroups/providers/microsoft.insights/actionGroups/MyActionGroup"
      }
    ],
    "throttling": {
      "duration": "PT20M"
    }
  }
}

Definitionen

Name	Beschreibung
ActionGroupsInformation	Die Aktionsgruppeninformationen, die von der Warnungsregel verwendet werden.
AlertRule	Die Warnungsregelinformationen
AlertRuleState	Der Status der Warnungsregel.
Detector	Die Detektorinformationen. Standardmäßig wird dies nicht ausgefüllt, es sei denn, sie wird in expandDetector angegeben.
Severity	Der Schweregrad der Warnungsregel.
SmartDetectorErrorResponse	Beschreiben des Formats einer Fehlerantwort.
ThrottlingInformation	Optionale Einschränkungsinformationen für die Warnungsregel.

ActionGroupsInformation

Objekt

Die Aktionsgruppeninformationen, die von der Warnungsregel verwendet werden.

Name	Typ	Beschreibung
customEmailSubject	string	Ein optionaler benutzerdefinierter E-Mail-Betreff, der in E-Mail-Benachrichtigungen verwendet werden soll.
customWebhookPayload	string	Eine optionale benutzerdefinierte Web-Hook-Nutzlast, die in Web-Hook-Benachrichtigungen verwendet werden soll.
groupIds	string[]	Die Aktionsgruppenressourcen-IDs.

AlertRule

Objekt

Die Warnungsregelinformationen

Name	Typ	Standardwert	Beschreibung
id	string		Die Ressourcen-ID.
location	string	global	Der Ressourcenspeicherort.
name	string		Der Ressourcenname.
properties.actionGroups	ActionGroupsInformation		Die Warnungsregelaktionen.
properties.description	string		Die Beschreibung der Warnungsregel.
properties.detector	Detector		Der Detektor der Warnungsregel.
properties.frequency	string (duration)		Die Häufigkeit der Warnungsregel im ISO8601 Format. Die Zeit granularität muss in Minuten betragen, und der Mindestwert beträgt 5 Minuten.
properties.scope	string[]		Der Ressourcenbereich der Warnungsregel.
properties.severity	Severity		Der Schweregrad der Warnungsregel.
properties.state	AlertRuleState		Der Status der Warnungsregel.
properties.throttling	ThrottlingInformation		Die Warnungsregeleinschränkungsinformationen.
tags	object		Die Ressourcentags.
type	string		Der Ressourcentyp.

AlertRuleState

Enumeration

Der Status der Warnungsregel.

Wert	Beschreibung
Disabled
Enabled

Detector

Objekt

Die Detektorinformationen. Standardmäßig wird dies nicht ausgefüllt, es sei denn, sie wird in expandDetector angegeben.

Name	Typ	Beschreibung
description	string	Die Beschreibung des Intelligenten Detektors. Standardmäßig wird dies nicht ausgefüllt, es sei denn, sie wird in expandDetector angegeben.
id	string	Die Detektor-ID.
imagePaths	string[]	Der Smart Detector-Bildpfad. Standardmäßig wird dies nicht ausgefüllt, es sei denn, sie wird in expandDetector angegeben.
name	string	Der Name des smarten Detektors. Standardmäßig wird dies nicht ausgefüllt, es sei denn, sie wird in expandDetector angegeben.
parameters	object	Die Parameter des Detektors."
supportedResourceTypes	string[]	Der smarte Detektor unterstützte Ressourcentypen. Standardmäßig wird dies nicht ausgefüllt, es sei denn, sie wird in expandDetector angegeben.

Severity

Enumeration

Der Schweregrad der Warnungsregel.

Wert	Beschreibung
Sev0
Sev1
Sev2
Sev3
Sev4

SmartDetectorErrorResponse

Objekt

Beschreiben des Formats einer Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ThrottlingInformation

Objekt

Optionale Einschränkungsinformationen für die Warnungsregel.

Name	Typ	Beschreibung
duration	string (duration)	Die erforderliche Dauer (im ISO8601 Format), die gewartet werden soll, bevor die Warnungsregel erneut benachrichtigt wird. Die Zeit granularität muss in Minuten betragen, und der Mindestwert beträgt 0 Minuten.