Smart Detector Alert Rules - Patch

Služba:

Monitor

Verze rozhraní API:

2019-06-01

Opravte konkrétní pravidlo upozornění inteligentního detektoru.

PATCH 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 minLength: 1	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
properties.actionGroups	ActionGroupsInformation	Akce pravidla upozornění.
properties.description	string	Popis pravidla upozornění.
properties.frequency	string (duration)	Frekvence pravidla upozornění ve formátu ISO8601. Časové intervaly musí být v minutách a minimální hodnota je 5 minut.
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ů.

Odpovědi

Name	Typ	Description
200 OK	AlertRule	Úspěšná žádost o opravu pravidla upozornění Inteligentního detektoru
Other Status Codes	SmartDetectorErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

Patch alert rules

Ukázkový požadavek

HTTP

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

{
  "tags": {
    "newKey": "newVal"
  },
  "properties": {
    "description": "New description for patching",
    "frequency": "PT1M"
  }
}

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": {
    "newKey": "newVal"
  },
  "properties": {
    "description": "New description for patching",
    "state": "Enabled",
    "severity": "Sev3",
    "frequency": "PT1M",
    "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í
AlertRulePatchObject	Informace o opravě pravidla upozornění
AlertRuleState	Stav pravidla upozornění.
Detector	Informace o detektoru. Ve výchozím nastavení se tento parametr nenaplní, pokud není zadaný v expandDetectoru.
Severity	Závažnost pravidla upozornění.
SmartDetectorErrorResponse	Popište formát odpovědi Chyba.
ThrottlingInformation	Volitelné informace o omezení pravidla upozornění

ActionGroupsInformation

Objekt

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

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

AlertRule

Objekt

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 (duration)		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[]		Rozsah 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.

AlertRulePatchObject

Objekt

Informace o opravě pravidla upozornění

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku.
properties.actionGroups	ActionGroupsInformation	Akce pravidla upozornění.
properties.description	string	Popis pravidla upozornění.
properties.frequency	string (duration)	Frekvence pravidla upozornění ve formátu ISO8601. Časové intervaly musí být v minutách a minimální hodnota je 5 minut.
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

Výčet

Stav pravidla upozornění.

Hodnota	Description
Disabled
Enabled

Detector

Objekt

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

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

Severity

Výčet

Závažnost pravidla upozornění.

Hodnota	Description
Sev0
Sev1
Sev2
Sev3
Sev4

SmartDetectorErrorResponse

Objekt

Popište formát odpovědi Chyba.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ThrottlingInformation

Objekt

Volitelné informace o omezení pravidla upozornění

Name	Typ	Description
duration	string (duration)	Požadovaná doba trvání (ve formátu ISO8601) k čekání před opětovnou výstrahou na pravidlo upozornění. Časové intervaly musí být v minutách a minimální hodnota je 0 minut.