Smart Detector Alert Rules - Patch

Referencia

Service:: Monitor

API Version:: 2019-06-01

Aplicar revisiones a una regla de alertas de Smart Detector específica.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
alertRuleName	path	True	string	El nombre de la regla de alerta.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.actionGroups	ActionGroupsInformation	Acciones de la regla de alertas.
properties.description	string	Descripción de la regla de alerta.
properties.frequency	string	Frecuencia de la regla de alerta en formato ISO8601. La granularidad de tiempo debe estar en minutos y el valor mínimo es de 5 minutos.
properties.severity	Severity	Gravedad de la regla de alerta.
properties.state	AlertRuleState	Estado de la regla de alerta.
properties.throttling	ThrottlingInformation	Información de limitación de la regla de alertas.
tags	object	Etiquetas del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	AlertRule	Solicitud correcta para aplicar revisiones a la regla de alertas de Smart Detector.
Other Status Codes	SmartDetectorErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Patch alert rules

Sample Request

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

Sample Response

Status code:: 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"
    }
  }
}

Definiciones

Nombre	Description
ActionGroupsInformation	La información de los grupos de acciones, usada por la regla de alertas.
AlertRule	Información de la regla de alertas
AlertRulePatchObject	Información de revisión de la regla de alertas
AlertRuleState	Estado de la regla de alerta.
Detector	Información del detector. De forma predeterminada, esto no se rellena, a menos que se especifique en expandDetector.
Severity	Gravedad de la regla de alerta.
SmartDetectorErrorResponse	Describir el formato de una respuesta de error.
ThrottlingInformation	Información de limitación opcional para la regla de alertas.

ActionGroupsInformation

La información de los grupos de acciones, usada por la regla de alertas.

Nombre	Tipo	Description
customEmailSubject	string	Un correo electrónico personalizado opcional sujeto a su uso en las notificaciones por correo electrónico.
customWebhookPayload	string	Una carga de web-hook personalizada opcional para usarla en las notificaciones de web-hook.
groupIds	string[]	Identificadores de recursos del grupo de acciones.

AlertRule

Información de la regla de alertas

Nombre	Tipo	Valor predeterminado	Description
id	string		El identificador del recurso.
location	string	global	Ubicación del recurso.
name	string		Nombre del recurso.
properties.actionGroups	ActionGroupsInformation		Acciones de la regla de alertas.
properties.description	string		Descripción de la regla de alerta.
properties.detector	Detector		Detector de la regla de alerta.
properties.frequency	string		Frecuencia de la regla de alerta en formato ISO8601. La granularidad de tiempo debe estar en minutos y el valor mínimo es de 5 minutos.
properties.scope	string[]		Ámbito de recursos de la regla de alerta.
properties.severity	Severity		Gravedad de la regla de alerta.
properties.state	AlertRuleState		Estado de la regla de alerta.
properties.throttling	ThrottlingInformation		Información de limitación de la regla de alertas.
tags	object		Etiquetas del recurso.
type	string		El tipo de recurso.

AlertRulePatchObject

Información de revisión de la regla de alertas

Nombre	Tipo	Description
id	string	El identificador del recurso.
name	string	Nombre del recurso.
properties.actionGroups	ActionGroupsInformation	Acciones de la regla de alertas.
properties.description	string	Descripción de la regla de alerta.
properties.frequency	string	Frecuencia de la regla de alerta en formato ISO8601. La granularidad de tiempo debe estar en minutos y el valor mínimo es de 5 minutos.
properties.severity	Severity	Gravedad de la regla de alerta.
properties.state	AlertRuleState	Estado de la regla de alerta.
properties.throttling	ThrottlingInformation	Información de limitación de la regla de alertas.
tags	object	Etiquetas del recurso.
type	string	El tipo de recurso.

AlertRuleState

Estado de la regla de alerta.

Nombre	Tipo	Description
Disabled	string
Enabled	string

Detector

Información del detector. De forma predeterminada, esto no se rellena, a menos que se especifique en expandDetector.

Nombre	Tipo	Description
description	string	Descripción del detector inteligente. De forma predeterminada, esto no se rellena, a menos que se especifique en expandDetector.
id	string	Identificador del detector.
imagePaths	string[]	Ruta de acceso de la imagen de Smart Detector. De forma predeterminada, esto no se rellena, a menos que se especifique en expandDetector.
name	string	Nombre del detector inteligente. De forma predeterminada, esto no se rellena, a menos que se especifique en expandDetector.
parameters	object	Los parámetros del detector.
supportedResourceTypes	string[]	Los tipos de recursos compatibles con Smart Detector. De forma predeterminada, esto no se rellena, a menos que se especifique en expandDetector.

Severity

Gravedad de la regla de alerta.

Nombre	Tipo	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SmartDetectorErrorResponse

Describir el formato de una respuesta de error.

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ThrottlingInformation

Información de limitación opcional para la regla de alertas.

Nombre	Tipo	Description
duration	string	La duración necesaria (en ISO8601 formato) que se debe esperar antes de notificar a la regla de alertas de nuevo. La granularidad de tiempo debe estar en minutos y el valor mínimo es de 0 minutos.

Compartir a través de