Sign in

v18

latestSwagger 2.0raw.githubusercontent.com2022-09-2672335.7 KB

Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).

get/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary

Path parameters

subscriptionIdstring required

The ID of the target subscription.

Query parameters

groupby'severity' | 'alertState' | 'monitorCondition' | 'monitorService' | 'signalType' | 'alertRule' required

This parameter allows the result set to be grouped by input fields (Maximum 2 comma separated fields supported). For example, groupby=severity or groupby=severity,alertstate.

includeSmartGroupsCountboolean

Include count of the SmartGroups as part of the summary. Default value is 'false'.

targetResourcestring

Filter by target resource( which is full ARM ID) Default value is select all.

targetResourceTypestring

Filter by target resource type. Default value is select all.

targetResourceGroupstring

Filter by target resource group name. Default value is select all.

monitorService'Application Insights' | 'ActivityLog Administrative' | 'ActivityLog Security' | 'ActivityLog Recommendation' | 'ActivityLog Policy' | 'ActivityLog Autoscale' | 'Log Analytics' | 'Nagios' | 'Platform' | 'SCOM' | 'ServiceHealth' | 'SmartDetector' | 'VM Insights' | 'Zabbix'

Filter by monitor service which generates the alert instance. Default value is select all.

monitorCondition'Fired' | 'Resolved'

Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.

severity'Sev0' | 'Sev1' | 'Sev2' | 'Sev3' | 'Sev4'

Filter by severity. Default value is select all.

alertState'New' | 'Acknowledged' | 'Closed'

Filter by state of the alert instance. Default value is to select all.

alertRulestring

Filter by specific alert rule. Default value is to select all.

timeRange'1h' | '1d' | '7d' | '30d'

Filter by time range by below listed values. Default value is 1 day.

customTimeRangestring

Filter by custom time range in the format <start-time>/<end-time> where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none.

api-version'2019-05-05-preview' required

client API version

Response

OK. Alert summary returned.

idstring

Azure resource Id

typestring

Azure resource type

namestring

Azure resource name