Activity Log Alerts - Get
Obtenga una regla de alertas del registro de actividad.
GET 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 |
---|---|---|---|---|
activity
|
path | True |
string |
Nombre de la regla de alerta del registro de actividad. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas. |
subscription
|
path | True |
string minLength: 1 |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string minLength: 1 |
Versión de la API que se va a usar para esta operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La solicitud se realizó correctamente. |
|
Other Status Codes |
Se produjo un error y no se pudo recuperar la regla de alerta del registro de actividad. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantar la cuenta de usuario |
Ejemplos
Get an Activity Log Alert rule
Solicitud de ejemplo
GET https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRule?api-version=2020-10-01
Respuesta de muestra
{
"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."
}
}
Definiciones
Nombre | Description |
---|---|
Action |
Puntero a un grupo de acciones de Azure. |
Action |
Lista de acciones de regla de alertas del registro de actividad. |
Activity |
Un recurso de regla de alerta del registro de actividad. |
Alert |
Una condición de regla de alerta del registro de actividad que se cumple cuando se cumplen todas sus condiciones de miembro. |
Alert |
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 diferentes tipos NO PUEDEN existir en una condición.
|
Alert |
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'. |
Error |
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 |
Lista de los grupos de acciones. |
ActivityLogAlertResource
Un recurso de regla de alerta del registro de actividad.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
id |
string |
Identificador del recurso. |
|
location |
string |
global |
La ubicación del recurso. Las reglas de alertas del registro de actividad de Azure se admiten en las regiones Global, Oeste de Europa y Norte de Europa. |
name |
string |
Nombre del recurso. |
|
properties.actions |
Las acciones que se activarán cuando se cumpla la condición. |
||
properties.condition |
Condición que hará que esta alerta se active. |
||
properties.description |
string |
Descripción de esta regla de alerta del registro de actividad. |
|
properties.enabled |
boolean |
True |
Indica si esta regla de alerta 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 del 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 |
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 diferentes 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: debe contener solo "anyOf" (que es una matriz de condiciones hoja). Tenga en cuenta que "field", "equals" y "containsAny" deben no establecerse en una condición AnyOf.
Nombre | Tipo | Description |
---|---|---|
anyOf |
Una condición "anyOf" de una regla de alerta del registro de actividad. |
|
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 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 elemento 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 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 elemento 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. |