Smart Detector Alert Rules - Get

Referens

Tjänst:: Monitor

API-version:: 2019-06-01

Hämta en specifik aviseringsregel för Smart Detector.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
alertRuleName	path	True	string	Namnet på aviseringsregeln.
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Klient-API-version.
expandDetector	query		boolean	Anger om Smart Detector ska expanderas.

Svar

Name	Typ	Description
200 OK	AlertRule	En lyckad begäran om att få aviseringsregeln smart detektor.
Other Status Codes	SmartDetectorErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get a Smart Detector alert rule

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
ActionGroupsInformation	Information om åtgärdsgrupper som används av aviseringsregeln.
AlertRule	Information om aviseringsregeln
AlertRuleState	Aviseringsregelns tillstånd.
Detector	Detektorinformationen. Som standard är detta inte ifyllt, såvida det inte anges i expandDetector
Severity	Allvarlighetsgrad för aviseringsregeln.
SmartDetectorErrorResponse	Beskriv formatet för ett felsvar.
ThrottlingInformation	Valfri begränsningsinformation för aviseringsregeln.

ActionGroupsInformation

Information om åtgärdsgrupper som används av aviseringsregeln.

Name	Typ	Description
customEmailSubject	string	Ett valfritt anpassat e-postämne som ska användas i e-postaviseringar.
customWebhookPayload	string	En valfri anpassad web-hook-nyttolast som ska användas i web-hook-meddelanden.
groupIds	string[]	Resurs-ID:t för åtgärdsgruppen.

AlertRule

Information om aviseringsregeln

Name	Typ	Standardvärde	Description
id	string		Resurs-ID:t.
location	string	global	Resursplatsen.
name	string		Resursnamnet.
properties.actionGroups	ActionGroupsInformation		Aviseringsregelåtgärderna.
properties.description	string		Beskrivning av aviseringsregeln.
properties.detector	Detector		Aviseringsregelns detektor.
properties.frequency	string		Aviseringsregelns frekvens i ISO8601 format. Tidskornigheten måste vara i minuter och minimivärdet är 5 minuter.
properties.scope	string[]		Resursomfånget för aviseringsregeln.
properties.severity	Severity		Allvarlighetsgrad för aviseringsregeln.
properties.state	AlertRuleState		Aviseringsregelns tillstånd.
properties.throttling	ThrottlingInformation		Information om begränsning av aviseringsregeln.
tags	object		Resurstaggar.
type	string		Resurstypen.

AlertRuleState

Aviseringsregelns tillstånd.

Name	Typ	Description
Disabled	string
Enabled	string

Detector

Detektorinformationen. Som standard är detta inte ifyllt, såvida det inte anges i expandDetector

Name	Typ	Description
description	string	Beskrivning av smart detektor. Som standard är detta inte ifyllt, såvida det inte anges i expandDetector
id	string	Detektor-ID:t.
imagePaths	string[]	Sökvägen till Smart Detector-avbildningen. Som standard är detta inte ifyllt, såvida det inte anges i expandDetector
name	string	Smart Detector-namnet. Som standard är detta inte ifyllt, såvida det inte anges i expandDetector
parameters	object	Detektorns parametrar."
supportedResourceTypes	string[]	Resurstyper som stöds av Smart Detector. Som standard är detta inte ifyllt, såvida det inte anges i expandDetector

Severity

Allvarlighetsgrad för aviseringsregeln.

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

SmartDetectorErrorResponse

Beskriv formatet för ett felsvar.

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ThrottlingInformation

Valfri begränsningsinformation för aviseringsregeln.

Name	Typ	Description
duration	string	Den varaktighet (i ISO8601 format) som krävs för att vänta innan aviseringsregeln meddelas igen. Tidskornigheten måste vara i minuter och minimivärdet är 0 minuter

Dela via