Smart Detector Alert Rules - Get

Referenz

Service:: 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

With optional parameters:

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	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Client-API-Version.
expandDetector	query		boolean	Gibt an, ob Smart Detector erweitert werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AlertRule	Erfolgreiche Anforderung zum Abrufen der Smart Detector-Warnungsregel.
Other Status Codes	SmartDetectorErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get a Smart Detector alert rule

Sample Request

HTTP

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

Sample Response

Status code:: 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 Informationen zu Aktionsgruppen, die von der Warnungsregel verwendet werden.
AlertRule	Informationen zur Warnungsregel
AlertRuleState	Der Status der Warnungsregel.
Detector	Die Detektorinformationen. Standardmäßig wird dies nicht aufgefüllt, es sei denn, es wird in expandDetector angegeben.
Severity	Der Schweregrad der Warnungsregel.
SmartDetectorErrorResponse	Beschreiben Sie das Format einer Fehlerantwort.
ThrottlingInformation	Optionale Einschränkungsinformationen für die Warnungsregel.

ActionGroupsInformation

Die Informationen zu Aktionsgruppen, die von der Warnungsregel verwendet werden.

Name	Typ	Beschreibung
customEmailSubject	string	Eine optionale benutzerdefinierte E-Mail, die in E-Mail-Benachrichtigungen verwendet werden kann.
customWebhookPayload	string	Eine optionale benutzerdefinierte Webhakennutzlast, die in Web-Hook-Benachrichtigungen verwendet werden kann.
groupIds	string[]	Die Ressourcen-IDs der Aktionsgruppe.

AlertRule

Informationen zur Warnungsregel

Name	Typ	Standardwert	Beschreibung
id	string		Die Ressourcen-ID.
location	string	global	Der Ressourcenspeicherort.
name	string		Der Name der Ressource.
properties.actionGroups	ActionGroupsInformation		Die Warnungsregelaktionen.
properties.description	string		Die Beschreibung der Warnungsregel.
properties.detector	Detector		Der Detektor der Warnungsregel.
properties.frequency	string		Die Warnungsregelhäufigkeit im ISO8601 Format. Die Zeitgranularität muss in Minuten sein, 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 Warnungsregel drosselt Informationen.
tags	object		Die Ressourcentags.
type	string		Der Ressourcentyp.

AlertRuleState

Der Status der Warnungsregel.

Name	Typ	Beschreibung
Disabled	string
Enabled	string

Detector

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

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

Severity

Der Schweregrad der Warnungsregel.

Name	Typ	Beschreibung
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SmartDetectorErrorResponse

Beschreiben Sie das Format einer Fehlerantwort.

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

ThrottlingInformation

Optionale Einschränkungsinformationen für die Warnungsregel.

Name	Typ	Beschreibung
duration	string	Die erforderliche Dauer (im ISO8601 Format), um zu warten, bevor die Warnungsregel erneut benachrichtigt wird. Die Zeitgranularität muss in Minuten sein, und der Mindestwert beträgt 0 Minuten.

Freigeben über