Smart Detector Alert Rules - Get

Riferimento

Servizio:: Monitor

Versione API:: 2019-06-01

Ottenere una regola di avviso di Rilevamento intelligente specifica.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
alertRuleName	path	True	string	Nome della regola di avviso.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API client.
expandDetector	query		boolean	Indica se il rilevamento intelligente deve essere espanso.

Risposte

Nome	Tipo	Descrizione
200 OK	AlertRule	Richiesta riuscita per ottenere la regola di avviso di Rilevamento intelligente.
Other Status Codes	SmartDetectorErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get a Smart Detector alert rule

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
    }
  }
}

Definizioni

Nome	Descrizione
ActionGroupsInformation	Informazioni sui gruppi di azioni usate dalla regola di avviso.
AlertRule	Informazioni sulla regola di avviso
AlertRuleState	Stato della regola di avviso.
Detector	Informazioni sul rilevamento. Per impostazione predefinita, questa opzione non viene popolata, a meno che non sia specificata in expandDetector
Severity	Gravità della regola di avviso.
SmartDetectorErrorResponse	Descrivere il formato di una risposta di errore.
ThrottlingInformation	Informazioni facoltative sulla limitazione per la regola di avviso.

ActionGroupsInformation

Informazioni sui gruppi di azioni usate dalla regola di avviso.

Nome	Tipo	Descrizione
customEmailSubject	string	Un messaggio di posta elettronica personalizzato facoltativo da usare nelle notifiche tramite posta elettronica.
customWebhookPayload	string	Payload web-hook facoltativo da usare nelle notifiche web-hook.
groupIds	string[]	ID risorsa gruppo di azioni.

AlertRule

Informazioni sulla regola di avviso

Nome	Tipo	Valore predefinito	Descrizione
id	string		L'ID della risorsa.
location	string	global	Percorso della risorsa.
name	string		Nome della risorsa.
properties.actionGroups	ActionGroupsInformation		Azioni della regola di avviso.
properties.description	string		Descrizione della regola di avviso.
properties.detector	Detector		Rilevamento della regola di avviso.
properties.frequency	string		Frequenza della regola di avviso in formato ISO8601. La granularità del tempo deve essere espressa in minuti e il valore minimo è di 5 minuti.
properties.scope	string[]		Ambito delle risorse della regola di avviso.
properties.severity	Severity		Gravità della regola di avviso.
properties.state	AlertRuleState		Stato della regola di avviso.
properties.throttling	ThrottlingInformation		Informazioni sulla limitazione della regola di avviso.
tags	object		Tag di risorsa.
type	string		Tipo di risorsa.

AlertRuleState

Stato della regola di avviso.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

Detector

Informazioni sul rilevamento. Per impostazione predefinita, questa opzione non viene popolata, a meno che non sia specificata in expandDetector

Nome	Tipo	Descrizione
description	string	Descrizione del rilevamento intelligente. Per impostazione predefinita, questa opzione non viene popolata, a meno che non sia specificata in expandDetector
id	string	ID rilevamento.
imagePaths	string[]	Percorso immagine rilevamento intelligente. Per impostazione predefinita, questa opzione non viene popolata, a meno che non sia specificata in expandDetector
name	string	Nome rilevamento intelligente. Per impostazione predefinita, questa opzione non viene popolata, a meno che non sia specificata in expandDetector
parameters	object	Parametri del rilevatore.
supportedResourceTypes	string[]	Tipi di risorse supportati da Smart Detector. Per impostazione predefinita, questa opzione non viene popolata, a meno che non sia specificata in expandDetector

Severity

Gravità della regola di avviso.

Nome	Tipo	Descrizione
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SmartDetectorErrorResponse

Descrivere il formato di una risposta di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.

ThrottlingInformation

Informazioni facoltative sulla limitazione per la regola di avviso.

Nome	Tipo	Descrizione
duration	string	Durata necessaria (in formato ISO8601) da attendere prima di inviare nuovamente una notifica alla regola di avviso. La granularità del tempo deve essere in minuti e il valore minimo è di 0 minuti

Condividi tramite