Alert Rules - List By Resource Group
Enumere las reglas de alertas de métricas clásicas dentro de un grupo de recursos.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules?api-version=2016-03-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
subscription
|
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. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Solicitud correcta para obtener una lista de reglas de alerta |
|
Other Status Codes |
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
List alert rules
Sample Request
GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules?api-version=2016-03-01
Sample Response
{
"value": [
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/myRuleName",
"name": "myRuleName",
"type": "Microsoft.Insights/alertRules",
"location": "West US",
"tags": {
"$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
},
"properties": {
"name": "myRuleName",
"description": "Pura Vida",
"isEnabled": true,
"condition": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
"dataSource": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
"resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
"metricName": "Requests"
},
"operator": "GreaterThan",
"threshold": 2,
"windowSize": "PT5M",
"timeAggregation": "Total"
},
"lastUpdatedTime": "2016-11-10T21:04:39.0005255Z",
"actions": [
{
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction",
"sendToServiceOwners": true,
"customEmails": [
"gu@ms.com",
"su@ms.net"
]
}
]
}
},
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin0",
"name": "chiricutin0",
"type": "Microsoft.Insights/alertRules",
"location": "West US",
"tags": {
"$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
},
"properties": {
"name": "chiricutin0",
"description": "Pura Vida 0",
"isEnabled": true,
"condition": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
"dataSource": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
"resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
"metricName": "Requests"
},
"operator": "GreaterThan",
"threshold": 2,
"windowSize": "PT5M",
"timeAggregation": "Total"
},
"lastUpdatedTime": "2016-11-10T21:04:39.1082596Z",
"actions": []
}
}
]
}
Definiciones
Nombre | Description |
---|---|
Alert |
Recurso de regla de alerta. |
Alert |
Representa una colección de recursos de regla de alertas. |
Condition |
Operadores permitidos en la condición de regla. |
Error |
Describe el formato de respuesta de error. |
Location |
Condición de regla basada en un determinado número de ubicaciones con errores. |
Management |
La manera en que se recopilan los datos se debería combinar con el tiempo. |
Management |
Una condición de regla de eventos de administración. |
Rule |
Especifica la acción para enviar correo electrónico cuando se evalúa la condición de regla. El discriminador siempre es RuleEmailAction en este caso. |
Rule |
Las notificaciones de un origen de datos de eventos de administración de reglas. |
Rule |
Origen de datos de eventos de administración de reglas. Los campos discriminadores siempre son RuleManagementEventDataSource en este caso. |
Rule |
Un origen de datos de métrica de regla. El valor de discriminador siempre es RuleMetricDataSource en este caso. |
Rule |
Especifica la acción que se va a publicar en el servicio cuando se evalúa la condición de regla. El discriminador siempre es RuleWebhookAction en este caso. |
Threshold |
Una condición de regla basada en una métrica que cruza un umbral. |
Time |
Operadores de agregación permitidos en una regla. |
AlertRuleResource
Recurso de regla de alerta.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso de Azure |
location |
string |
Ubicación de los recursos |
name |
string |
Nombre de recurso de Azure |
properties.action | RuleAction: |
acción que se realiza cuando la regla de alerta se activa y cuando se resuelve una condición de alerta. |
properties.actions | RuleAction[]: |
matriz de acciones que se realizan cuando la regla de alerta se activa y cuando se resuelve una condición de alerta. |
properties.condition | RuleCondition: |
condición que da lugar a que se active la regla de alerta. |
properties.description |
string |
la descripción de la regla de alerta que se incluirá en el correo electrónico de alerta. |
properties.isEnabled |
boolean |
marca que indica si la regla de alerta está habilitada. |
properties.lastUpdatedTime |
string |
Última vez que la regla se actualizó en ISO8601 formato. |
properties.name |
string |
el nombre de la regla de alerta. |
properties.provisioningState |
string |
estado de aprovisionamiento. |
tags |
object |
Etiquetas del recurso |
type |
string |
Tipo de recurso de Azure |
AlertRuleResourceCollection
Representa una colección de recursos de regla de alertas.
Nombre | Tipo | Description |
---|---|---|
value |
los valores de los recursos de la regla de alerta. |
ConditionOperator
Operadores permitidos en la condición de regla.
Nombre | Tipo | Description |
---|---|---|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
ErrorResponse
Describe el formato de 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. |
LocationThresholdRuleCondition
Condición de regla basada en un determinado número de ubicaciones con errores.
Nombre | Tipo | Description |
---|---|---|
dataSource | RuleDataSource: |
el recurso desde el que la regla recopila sus datos. Para este tipo dataSource siempre será de tipo RuleMetricDataSource. |
failedLocationCount |
integer |
número de ubicaciones que deben no activar la alerta. |
odata.type |
string:
Microsoft. |
especifica el tipo de condición. Puede ser uno de estos tres tipos: ManagementEventRuleCondition (repeticiones de eventos de administración), LocationThresholdRuleCondition (basado en el número de errores de una prueba web) y ThresholdRuleCondition (basado en el umbral de una métrica). |
windowSize |
string |
el período de tiempo (en formato de duración ISO 8601) que se usa para supervisar la actividad de alerta en función del umbral. Si se especifica, debe estar entre 5 minutos y 1 día. |
ManagementEventAggregationCondition
La manera en que se recopilan los datos se debería combinar con el tiempo.
Nombre | Tipo | Description |
---|---|---|
operator |
operador condition. |
|
threshold |
number |
El valor de umbral que activa el alerta. |
windowSize |
string |
el período de tiempo (en formato de duración ISO 8601) que se usa para supervisar la actividad de alerta en función del umbral. Si se especifica, debe estar entre 5 minutos y 1 día. |
ManagementEventRuleCondition
Una condición de regla de eventos de administración.
Nombre | Tipo | Description |
---|---|---|
aggregation |
Cómo se deben combinar los datos recopilados con el tiempo y cuándo se activa la alerta. Tenga en cuenta que, para la administración, la agregación de alertas de eventos es opcional; si no se proporciona, cualquier evento hará que se active la alerta. |
|
dataSource | RuleDataSource: |
el recurso desde el que la regla recopila sus datos. Para este tipo dataSource siempre será de tipo RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
especifica el tipo de condición. Puede ser uno de estos tres tipos: ManagementEventRuleCondition (repeticiones de eventos de administración), LocationThresholdRuleCondition (basado en el número de errores de una prueba web) y ThresholdRuleCondition (basado en el umbral de una métrica). |
RuleEmailAction
Especifica la acción para enviar correo electrónico cuando se evalúa la condición de regla. El discriminador siempre es RuleEmailAction en este caso.
Nombre | Tipo | Description |
---|---|---|
customEmails |
string[] |
la lista de direcciones de correo electrónico personalizadas del administrador para notificar la activación de la alerta. |
odata.type |
string:
Microsoft. |
especifica el tipo de la acción. Hay dos tipos de acciones: RuleEmailAction y RuleWebhookAction. |
sendToServiceOwners |
boolean |
Si los administradores (de servicio y coadministradores) del servicio deben recibir o no una notificación cuando se activa la alerta. |
RuleManagementEventClaimsDataSource
Las notificaciones de un origen de datos de eventos de administración de reglas.
Nombre | Tipo | Description |
---|---|---|
emailAddress |
string |
la dirección de correo electrónico. |
RuleManagementEventDataSource
Origen de datos de eventos de administración de reglas. Los campos discriminadores siempre son RuleManagementEventDataSource en este caso.
Nombre | Tipo | Description |
---|---|---|
claims |
las notificaciones. |
|
eventName |
string |
el nombre del evento. |
eventSource |
string |
el origen del evento. |
legacyResourceId |
string |
el identificador de recurso heredado del recurso que supervisa la regla. NOTA: esta propiedad no se puede actualizar para una regla existente. |
level |
string |
el nivel. |
metricNamespace |
string |
espacio de nombres de la métrica. |
odata.type |
string:
Microsoft. |
especifica el tipo de origen de datos. Hay dos tipos de orígenes de datos de reglas: RuleMetricDataSource y RuleManagementEventDataSource |
operationName |
string |
El nombre de la operación que se debe comprobar. Si no se proporciona ningún nombre, coincidirá cualquier operación. |
resourceGroupName |
string |
el nombre del grupo de recursos. |
resourceLocation |
string |
la ubicación del recurso. |
resourceProviderName |
string |
el nombre del proveedor de recursos. |
resourceUri |
string |
el identificador de recurso del recurso que supervisa la regla. NOTA: esta propiedad no se puede actualizar para una regla existente. |
status |
string |
El estado de la operación que se debe comprobar. Si no se proporciona ningún estado, coincidirá cualquier estado. |
subStatus |
string |
subestado. |
RuleMetricDataSource
Un origen de datos de métrica de regla. El valor de discriminador siempre es RuleMetricDataSource en este caso.
Nombre | Tipo | Description |
---|---|---|
legacyResourceId |
string |
el identificador de recurso heredado del recurso que supervisa la regla. NOTA: esta propiedad no se puede actualizar para una regla existente. |
metricName |
string |
el nombre de la métrica que define lo que supervisa la regla. |
metricNamespace |
string |
espacio de nombres de la métrica. |
odata.type |
string:
Microsoft. |
especifica el tipo de origen de datos. Hay dos tipos de orígenes de datos de reglas: RuleMetricDataSource y RuleManagementEventDataSource |
resourceLocation |
string |
la ubicación del recurso. |
resourceUri |
string |
el identificador de recurso del recurso que supervisa la regla. NOTA: esta propiedad no se puede actualizar para una regla existente. |
RuleWebhookAction
Especifica la acción que se va a publicar en el servicio cuando se evalúa la condición de regla. El discriminador siempre es RuleWebhookAction en este caso.
Nombre | Tipo | Description |
---|---|---|
odata.type |
string:
Microsoft. |
especifica el tipo de la acción. Hay dos tipos de acciones: RuleEmailAction y RuleWebhookAction. |
properties |
object |
diccionario de propiedades personalizadas que se van a incluir con la operación posterior. Estos datos se anexan a la carga del webhook. |
serviceUri |
string |
el URI del servicio para publicar la notificación cuando la alerta se activa o resuelve. |
ThresholdRuleCondition
Una condición de regla basada en una métrica que cruza un umbral.
Nombre | Tipo | Description |
---|---|---|
dataSource | RuleDataSource: |
el recurso desde el que la regla recopila sus datos. Para este tipo dataSource siempre será de tipo RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
especifica el tipo de condición. Puede ser uno de estos tres tipos: ManagementEventRuleCondition (repeticiones de eventos de administración), LocationThresholdRuleCondition (basado en el número de errores de una prueba web) y ThresholdRuleCondition (basado en el umbral de una métrica). |
operator |
operador utilizado para comparar los datos y el umbral. |
|
threshold |
number |
valor de umbral que activa la alerta. |
timeAggregation |
operador de agregación de hora. Cómo se deben combinar los datos recopilados con el tiempo. El valor predeterminado es PrimaryAggregationType de la métrica. |
|
windowSize |
string |
el período de tiempo (en formato de duración ISO 8601) que se usa para supervisar la actividad de alerta en función del umbral. Si se especifica, debe estar entre 5 minutos y 1 día. |
TimeAggregationOperator
Operadores de agregación permitidos en una regla.
Nombre | Tipo | Description |
---|---|---|
Average |
string |
|
Last |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |