Smart Detector Alert Rules - List

Reference

Služba:: Monitor

Verze rozhraní API:: 2019-06-01

Vypíše všechna existující pravidla upozornění Inteligentního detektoru v rámci předplatného.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API klienta.
expandDetector	query		boolean	Určuje, jestli má být inteligentní detektor rozbalený.

Odpovědi

Name	Typ	Description
200 OK	AlertRulesList	Úspěšný požadavek na výpis pravidel upozornění Inteligentního detektoru
Other Status Codes	SmartDetectorErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List Smart Detector alert rules

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "nextLink": null,
  "value": [
    {
      "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/vms/providers/Microsoft.Compute/virtualMachines/vm1"
        ],
        "actionGroups": [
          {
            "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/MyActionGroups/providers/microsoft.insights/actionGroups/MyActionGroup"
          }
        ],
        "throttling": {
          "duration": "PT20M"
        }
      }
    },
    {
      "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MySecondAlertRule",
      "type": "Microsoft.AlertsManagement/smartDetectorAlertRules",
      "name": "MySecondAlertRule",
      "location": "global",
      "tags": {},
      "properties": {
        "description": "Sample smart detector alert rule description",
        "state": "Disabled",
        "severity": "Sev2",
        "frequency": "PT15M",
        "detector": {
          "id": "VMMemoryLeak"
        },
        "scope": [
          "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm2"
        ],
        "actionGroups": [
          {
            "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/MyActionGroups/providers/microsoft.insights/actionGroups/MyActionGroup"
          }
        ]
      }
    }
  ]
}

Definice

Name	Description
ActionGroupsInformation	Informace o skupinách akcí, které používá pravidlo upozornění.
AlertRule	Informace o pravidle upozornění
AlertRulesList	Seznam pravidel upozornění Inteligentního detektoru
AlertRuleState	Stav pravidla upozornění.
Detector	Informace o detektoru. Ve výchozím nastavení se nevyplní, pokud není zadaný v expandDetectoru.
Severity	Závažnost pravidla upozornění
SmartDetectorErrorResponse	Popište formát chybové odpovědi.
ThrottlingInformation	Volitelné informace o omezení pro pravidlo upozornění.

ActionGroupsInformation

Informace o skupinách akcí, které používá pravidlo upozornění.

Name	Typ	Description
customEmailSubject	string	Volitelný vlastní předmět e-mailu, který se použije v e-mailových oznámeních.
customWebhookPayload	string	Volitelná vlastní datová část webhooku, která se použije v oznámeních webhooku.
groupIds	string[]	ID prostředků skupiny akcí

AlertRule

Informace o pravidle upozornění

Name	Typ	Default value	Description
id	string		ID prostředku.
location	string	global	Umístění prostředku.
name	string		Název prostředku.
properties.actionGroups	ActionGroupsInformation		Akce pravidla upozornění
properties.description	string		Popis pravidla upozornění
properties.detector	Detector		Detektor pravidla upozornění.
properties.frequency	string		Frekvence pravidla upozornění ve formátu ISO8601. Časové intervaly musí být v minutách a minimální hodnota je 5 minut.
properties.scope	string[]		Obor prostředků pravidla upozornění.
properties.severity	Severity		Závažnost pravidla upozornění
properties.state	AlertRuleState		Stav pravidla upozornění.
properties.throttling	ThrottlingInformation		Informace o omezení pravidla upozornění
tags	object		Značky prostředků.
type	string		Typ prostředku.

AlertRulesList

Seznam pravidel upozornění Inteligentního detektoru

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady výsledků
value	AlertRule[]	Seznam pravidel upozornění Inteligentního detektoru

AlertRuleState

Stav pravidla upozornění.

Name	Typ	Description
Disabled	string
Enabled	string

Detector

Informace o detektoru. Ve výchozím nastavení se nevyplní, pokud není zadaný v expandDetectoru.

Name	Typ	Description
description	string	Popis inteligentního detektoru. Ve výchozím nastavení se nevyplní, pokud není zadaný v expandDetectoru.
id	string	ID detektoru.
imagePaths	string[]	Cesta k obrázku Inteligentního detektoru Ve výchozím nastavení se nevyplní, pokud není zadaný v expandDetectoru.
name	string	Název inteligentního detektoru. Ve výchozím nastavení se nevyplní, pokud není zadaný v expandDetectoru.
parameters	object	Parametry detektoru."
supportedResourceTypes	string[]	Inteligentní detektor podporoval typy prostředků. Ve výchozím nastavení se nevyplní, pokud není zadaný v expandDetectoru.

Severity

Závažnost pravidla upozornění

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

SmartDetectorErrorResponse

Popište formát chybové odpovědi.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva s informacemi o tom, proč operace selhala.

ThrottlingInformation

Volitelné informace o omezení pro pravidlo upozornění.

Name	Typ	Description
duration	string	Požadovaná doba (ve formátu ISO8601), po které se má čekat před dalším upozorněním na pravidlo upozornění. Časové intervaly musí být v minutách a minimální hodnota je 0 minut.

Sdílet prostřednictvím