Smart Detector Alert Rules - Patch

Referentie

Service:: Monitor

API-versie:: 2019-06-01

Patch een specifieke waarschuwingsregel voor Smart Detector.

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

URI-parameters

Name	In	Vereist	Type	Description
alertRuleName	path	True	string	De naam van de waarschuwingsregel.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
properties.actionGroups	ActionGroupsInformation	De acties van de waarschuwingsregel.
properties.description	string	De beschrijving van de waarschuwingsregel.
properties.frequency	string	De frequentie van de waarschuwingsregel in ISO8601 indeling. De tijdgranulariteit moet in minuten zijn en de minimumwaarde is 5 minuten.
properties.severity	Severity	De ernst van de waarschuwingsregel.
properties.state	AlertRuleState	De status van de waarschuwingsregel.
properties.throttling	ThrottlingInformation	De informatie over de beperking van de waarschuwingsregel.
tags	object	De resourcetags.

Antwoorden

Name	Type	Description
200 OK	AlertRule	Geslaagde aanvraag voor het patchen van de waarschuwingsregel voor Smart Detector.
Other Status Codes	SmartDetectorErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Patch alert rules

Voorbeeldaanvraag

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"
  }
}

Voorbeeldrespons

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": {
    "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"
    }
  }
}

Definities

Name	Description
ActionGroupsInformation	De informatie over actiegroepen, die door de waarschuwingsregel wordt gebruikt.
AlertRule	De informatie over de waarschuwingsregel
AlertRulePatchObject	Patch-informatie over de waarschuwingsregel
AlertRuleState	De status van de waarschuwingsregel.
Detector	De detectorinformatie. Dit wordt standaard niet ingevuld, tenzij dit is opgegeven in expandDetector
Severity	De ernst van de waarschuwingsregel.
SmartDetectorErrorResponse	Beschrijf de indeling van een foutantwoord.
ThrottlingInformation	Optionele beperkingsinformatie voor de waarschuwingsregel.

ActionGroupsInformation

De informatie over actiegroepen, die door de waarschuwingsregel wordt gebruikt.

Name	Type	Description
customEmailSubject	string	Een optioneel aangepast e-mailonderwerp voor gebruik in e-mailmeldingen.
customWebhookPayload	string	Een optionele aangepaste nettolading voor webhook om te gebruiken in webhookmeldingen.
groupIds	string[]	De resource-id's van de actiegroep.

AlertRule

De informatie over de waarschuwingsregel

Name	Type	Default value	Description
id	string		De resource-id.
location	string	global	De resourcelocatie.
name	string		De resourcenaam.
properties.actionGroups	ActionGroupsInformation		De acties van de waarschuwingsregel.
properties.description	string		De beschrijving van de waarschuwingsregel.
properties.detector	Detector		De detector van de waarschuwingsregel.
properties.frequency	string		De frequentie van de waarschuwingsregel in ISO8601 indeling. De tijdgranulariteit moet in minuten zijn en de minimumwaarde is 5 minuten.
properties.scope	string[]		Het bereik van de waarschuwingsregelresources.
properties.severity	Severity		De ernst van de waarschuwingsregel.
properties.state	AlertRuleState		De status van de waarschuwingsregel.
properties.throttling	ThrottlingInformation		De informatie over de beperking van de waarschuwingsregel.
tags	object		De resourcetags.
type	string		Het resourcetype.

AlertRulePatchObject

Patch-informatie over de waarschuwingsregel

Name	Type	Description
id	string	De resource-id.
name	string	De resourcenaam.
properties.actionGroups	ActionGroupsInformation	De acties van de waarschuwingsregel.
properties.description	string	De beschrijving van de waarschuwingsregel.
properties.frequency	string	De frequentie van de waarschuwingsregel in ISO8601 indeling. De tijdgranulariteit moet in minuten zijn en de minimumwaarde is 5 minuten.
properties.severity	Severity	De ernst van de waarschuwingsregel.
properties.state	AlertRuleState	De status van de waarschuwingsregel.
properties.throttling	ThrottlingInformation	De informatie over de beperking van de waarschuwingsregel.
tags	object	De resourcetags.
type	string	Het resourcetype.

AlertRuleState

De status van de waarschuwingsregel.

Name	Type	Description
Disabled	string
Enabled	string

Detector

De detectorinformatie. Dit wordt standaard niet ingevuld, tenzij dit is opgegeven in expandDetector

Name	Type	Description
description	string	De beschrijving van de slimme detector. Dit wordt standaard niet ingevuld, tenzij dit is opgegeven in expandDetector
id	string	De detector-id.
imagePaths	string[]	Het afbeeldingspad van Smart Detector. Dit wordt standaard niet ingevuld, tenzij dit is opgegeven in expandDetector
name	string	De naam van de Smart Detector. Dit wordt standaard niet ingevuld, tenzij dit is opgegeven in expandDetector
parameters	object	De parameters van de detector.'
supportedResourceTypes	string[]	De door Smart Detector ondersteunde resourcetypen. Dit wordt standaard niet ingevuld, tenzij dit is opgegeven in expandDetector

Severity

De ernst van de waarschuwingsregel.

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

SmartDetectorErrorResponse

Beschrijf de indeling van een foutantwoord.

Name	Type	Description
code	string	Foutcode
message	string	Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.

ThrottlingInformation

Optionele beperkingsinformatie voor de waarschuwingsregel.

Name	Type	Description
duration	string	De vereiste duur (in ISO8601 indeling) om te wachten voordat de waarschuwingsregel opnieuw wordt gemeld. De tijdgranulariteit moet in minuten zijn en de minimumwaarde is 0 minuten

Delen via