Smart Detector Alert Rules - Create Or Update

Reference

Služba:: Monitor

Verze rozhraní API:: 2019-06-01

Vytvořte nebo aktualizujte pravidlo upozornění inteligentního detektoru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
alertRuleName	path	True	string	Název pravidla upozornění.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

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

Odpovědi

Name	Typ	Description
200 OK	AlertRule	Žádost o aktualizaci pravidla upozornění inteligentního detektoru byla úspěšná.
201 Created	AlertRule	Úspěšná žádost o vytvoření pravidla 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

Create or update a Smart Detector alert rule

Ukázkový požadavek

HTTP

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

{
  "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": {
      "customEmailSubject": "My custom email subject",
      "customWebhookPayload": "{\"AlertRuleName\":\"#alertrulename\"}",
      "groupIds": [
        "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/actionGroups/providers/microsoft.insights/actiongroups/MyActionGroup"
      ]
    },
    "throttling": {
      "duration": "PT20M"
    }
  }
}

Ukázková odpověď

Stavový kód:: 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/actionGroups/providers/microsoft.insights/actiongroups/MyActionGroup"
      }
    ],
    "throttling": {
      "duration": "PT20M"
    }
  }
}

Stavový kód:: 201

{
  "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/actionGroups/providers/microsoft.insights/actiongroups/MyActionGroup"
      }
    ],
    "throttling": {
      "duration": "PT20M"
    }
  }
}

Definice

Name	Description
ActionGroupsInformation	Informace o skupinách akcí, které používá pravidlo upozornění.
AlertRule	Informace o pravidle upozornění
AlertRuleState	Stav pravidla upozornění.
Detector	Informace o detektoru. Ve výchozím nastavení se tato hodnota nevyplní, pokud není zadána v expandDetectoru.
Severity	Závažnost pravidla upozornění.
SmartDetectorErrorResponse	Popište formát chybové odpovědi.
ThrottlingInformation	Volitelné informace o omezování 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 web-hooku, která se použije v oznámeních web-hook.
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á členitost 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.

AlertRuleState

Stav pravidla upozornění.

Name	Typ	Description
Disabled	string
Enabled	string

Detector

Informace o detektoru. Ve výchozím nastavení se tato hodnota nevyplní, pokud není zadána v expandDetectoru.

Name	Typ	Description
description	string	Popis inteligentního detektoru. Ve výchozím nastavení se tato hodnota nevyplní, pokud není zadána v expandDetectoru.
id	string	ID detektoru.
imagePaths	string[]	Cesta k obrázku inteligentního detektoru Ve výchozím nastavení se tato hodnota nevyplní, pokud není zadána v expandDetectoru.
name	string	Název inteligentního detektoru. Ve výchozím nastavení se tato hodnota nevyplní, pokud není zadána v expandDetectoru.
parameters	object	Parametry detektoru."
supportedResourceTypes	string[]	Inteligentní detektor podporoval typy prostředků. Ve výchozím nastavení se tato hodnota nevyplní, pokud není zadána 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 označující, proč operace selhala.

ThrottlingInformation

Volitelné informace o omezování pro pravidlo upozornění.

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

Sdílet prostřednictvím