Activity Log Alerts - Create Or Update

  • Referencia
Service:
Monitor
API Version:
2020-10-01

Cree una nueva regla de alertas del registro de actividad o actualice una existente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}?api-version=2020-10-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
activityLogAlertName
 path True

string

Nombre de la regla de alertas del registro de actividad.
resourceGroupName
 path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId
 path True

string

Identificador de la suscripción de destino.
api-version
 query True

string

Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
properties.actions True

ActionList

Las acciones que se activarán cuando se cumpla la condición.
properties.condition True

AlertRuleAllOfCondition

Condición que hará que esta alerta se active.
properties.scopes True

string[]

Lista de identificadores de recursos que se usarán como prefijos. La alerta solo se aplicará a los eventos del registro de actividad con identificadores de recursos que se encuentran en uno de estos prefijos. Esta lista debe incluir al menos un elemento.
location

string

Ubicación del recurso. Las reglas de alertas del registro de actividad de Azure se admiten en regiones Globales, Oeste de Europa y Norte de Europa.
properties.description

string

Descripción de esta regla de alertas del registro de actividad.
properties.enabled

boolean

Indica si esta regla de alertas del registro de actividad está habilitada. Si una regla de alerta del registro de actividad no está habilitada, no se activará ninguna de sus acciones.
tags

object

Etiquetas del recurso.

Respuestas

Nombre Tipo Description
200 OK

ActivityLogAlertResource

Se actualizó correctamente una regla de alerta del registro de actividad existente.
201 Created

ActivityLogAlertResource

Se creó correctamente una nueva regla de alertas del registro de actividad.
Other Status Codes

ErrorResponse

Error y no se pudo crear ni actualizar la regla de alerta del registro de actividad.

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

Create or update an Activity Log Alert rule
Create or update an Activity Log Alert rule with 'anyOf' condition
Create or update an Activity Log Alert rule with 'containsAny'

Create or update an Activity Log Alert rule

Sample Request

PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRule?api-version=2020-10-01

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "/subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "Administrative"
        },
        {
          "field": "level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "Category",
          "equals": "Administrative"
        },
        {
          "field": "Level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}
Status code:
201 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "Category",
          "equals": "Administrative"
        },
        {
          "field": "Level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Create or update an Activity Log Alert rule with 'anyOf' condition

Sample Request

PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition?api-version=2020-10-01

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithAnyOfCondition",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}
Status code:
201 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithAnyOfCondition",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}

Create or update an Activity Log Alert rule with 'containsAny'

Sample Request

PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny?api-version=2020-10-01

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithContainsAny",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}
Status code:
201 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithContainsAny",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}

Definiciones

Nombre Description
ActionGroup

Puntero a un grupo de acciones de Azure.
ActionList

Lista de acciones de regla de alertas del registro de actividad.
ActivityLogAlertResource

Un recurso de regla de alertas del registro de actividad.
AlertRuleAllOfCondition

Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro.
AlertRuleAnyOfOrLeafCondition

Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro. Cada condición puede ser de uno de los siguientes tipos: Importante: Cada tipo tiene su subconjunto único de propiedades. Las propiedades de distintos tipos NO PUEDEN existir en una condición.

  • Condición hoja: debe contener 'field' y 'equals' o 'containsAny'. Tenga en cuenta que 'anyOf' no debe establecerse en una condición hoja.
  • Condición AnyOf: solo debe contener " anyOf" (que es una matriz de condiciones hoja). Tenga en cuenta que "field", "equals" y "containsAny" no deben establecerse en una condición AnyOf.
AlertRuleLeafCondition

Una condición de regla de alerta del registro de actividad que se cumple comparando el campo y el valor de un evento registro de actividad. Esta condición debe contener 'field' y 'equals' o 'containsAny'.
ErrorResponse

Respuesta de error.

ActionGroup

Puntero a un grupo de acciones de Azure.

Nombre Tipo Description
actionGroupId

string

Identificador de recurso del grupo de acciones. Esto no puede ser nulo ni estar vacío.
webhookProperties

object

diccionario de propiedades personalizadas que se van a incluir con la operación posterior. Estos datos se anexan a la carga del webhook.

ActionList

Lista de acciones de regla de alertas del registro de actividad.

Nombre Tipo Description
actionGroups

ActionGroup[]

Lista de los grupos de acciones.

ActivityLogAlertResource

Un recurso de regla de alertas del registro de actividad.

Nombre Tipo Valor predeterminado Description
id

string

Identificador del recurso.
location

string

global

Ubicación del recurso. Las reglas de alertas del registro de actividad de Azure se admiten en regiones Globales, Oeste de Europa y Norte de Europa.
name

string

Nombre del recurso.
properties.actions

ActionList

Las acciones que se activarán cuando se cumpla la condición.
properties.condition

AlertRuleAllOfCondition

Condición que hará que esta alerta se active.
properties.description

string

Descripción de esta regla de alertas del registro de actividad.
properties.enabled

boolean

True

Indica si esta regla de alertas del registro de actividad está habilitada. Si una regla de alerta del registro de actividad no está habilitada, no se activará ninguna de sus acciones.
properties.scopes

string[]

Lista de identificadores de recursos que se usarán como prefijos. La alerta solo se aplicará a los eventos del registro de actividad con identificadores de recursos que se encuentran en uno de estos prefijos. Esta lista debe incluir al menos un elemento.
tags

object

Etiquetas del recurso.
type

string

Tipo de recurso.

AlertRuleAllOfCondition

Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro.

Nombre Tipo Description
allOf

AlertRuleAnyOfOrLeafCondition[]

Lista de condiciones de regla de alertas del registro de actividad.

AlertRuleAnyOfOrLeafCondition

Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro. Cada condición puede ser de uno de los siguientes tipos: Importante: Cada tipo tiene su subconjunto único de propiedades. Las propiedades de distintos tipos NO PUEDEN existir en una condición.

  • Condición hoja: debe contener 'field' y 'equals' o 'containsAny'. Tenga en cuenta que 'anyOf' no debe establecerse en una condición hoja.
  • Condición AnyOf: solo debe contener " anyOf" (que es una matriz de condiciones hoja). Tenga en cuenta que "field", "equals" y "containsAny" no deben establecerse en una condición AnyOf.
Nombre Tipo Description
anyOf

AlertRuleLeafCondition[]

Una condición "anyOf" de la regla de alerta del registro de actividad.
Una condición de regla de alerta del registro de actividad que se cumple cuando se cumple al menos una de sus condiciones de hoja miembro.
containsAny

string[]

El valor del campo del evento se comparará con los valores de esta matriz (sin distinción entre mayúsculas y minúsculas) para determinar si se cumple la condición.
equals

string

El valor del campo del evento se comparará con este valor (sin distinción entre mayúsculas y minúsculas) para determinar si se cumple la condición.
field

string

Nombre del campo del evento del registro de actividad que examinará esta condición. Los valores posibles para este campo son (sin distinción entre mayúsculas y minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', o cualquier cosa que comience por 'properties'.

AlertRuleLeafCondition

Una condición de regla de alerta del registro de actividad que se cumple comparando el campo y el valor de un evento registro de actividad. Esta condición debe contener 'field' y 'equals' o 'containsAny'.

Nombre Tipo Description
containsAny

string[]

El valor del campo del evento se comparará con los valores de esta matriz (sin distinción entre mayúsculas y minúsculas) para determinar si se cumple la condición.
equals

string

El valor del campo del evento se comparará con este valor (sin distinción entre mayúsculas y minúsculas) para determinar si se cumple la condición.
field

string

Nombre del campo del evento del registro de actividad que examinará esta condición. Los valores posibles para este campo son (sin distinción entre mayúsculas y minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', o cualquier cosa que comience por 'properties'.

ErrorResponse

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.