AlertsManagementExtensions.GetServiceAlertSummaryAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetServiceAlertSummaryAsync(SubscriptionResource, SubscriptionResourceGetServiceAlertSummaryOptions, CancellationToken) |
Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).
|
| GetServiceAlertSummaryAsync(SubscriptionResource, AlertsSummaryGroupByField, Nullable<Boolean>, String, String, String, Nullable<MonitorServiceSourceForAlert>, Nullable<MonitorCondition>, Nullable<ServiceAlertSeverity>, Nullable<ServiceAlertState>, String, Nullable<TimeRangeFilter>, String, CancellationToken) |
Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).
|
GetServiceAlertSummaryAsync(SubscriptionResource, SubscriptionResourceGetServiceAlertSummaryOptions, CancellationToken)
Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary
- Operation Id: Alerts_GetSummary
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSummary>> GetServiceAlertSummaryAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.ResourceManager.AlertsManagement.Models.SubscriptionResourceGetServiceAlertSummaryOptions options, System.Threading.CancellationToken cancellationToken = default);static member GetServiceAlertSummaryAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.ResourceManager.AlertsManagement.Models.SubscriptionResourceGetServiceAlertSummaryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSummary>><Extension()>
Public Function GetServiceAlertSummaryAsync (subscriptionResource As SubscriptionResource, options As SubscriptionResourceGetServiceAlertSummaryOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ServiceAlertSummary))Parameters
- subscriptionResource
- SubscriptionResource
The SubscriptionResource instance the method will execute against.
A property bag which contains all the parameters of this method except the LRO qualifier and request context parameter.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
subscriptionResource or options is null.
Applies to
GetServiceAlertSummaryAsync(SubscriptionResource, AlertsSummaryGroupByField, Nullable<Boolean>, String, String, String, Nullable<MonitorServiceSourceForAlert>, Nullable<MonitorCondition>, Nullable<ServiceAlertSeverity>, Nullable<ServiceAlertState>, String, Nullable<TimeRangeFilter>, String, CancellationToken)
Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary
- Operation Id: Alerts_GetSummary
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSummary>> GetServiceAlertSummaryAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.ResourceManager.AlertsManagement.Models.AlertsSummaryGroupByField groupby, bool? includeSmartGroupsCount = default, string targetResource = default, string targetResourceType = default, string targetResourceGroup = default, Azure.ResourceManager.AlertsManagement.Models.MonitorServiceSourceForAlert? monitorService = default, Azure.ResourceManager.AlertsManagement.Models.MonitorCondition? monitorCondition = default, Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSeverity? severity = default, Azure.ResourceManager.AlertsManagement.Models.ServiceAlertState? alertState = default, string alertRule = default, Azure.ResourceManager.AlertsManagement.Models.TimeRangeFilter? timeRange = default, string customTimeRange = default, System.Threading.CancellationToken cancellationToken = default);static member GetServiceAlertSummaryAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.ResourceManager.AlertsManagement.Models.AlertsSummaryGroupByField * Nullable<bool> * string * string * string * Nullable<Azure.ResourceManager.AlertsManagement.Models.MonitorServiceSourceForAlert> * Nullable<Azure.ResourceManager.AlertsManagement.Models.MonitorCondition> * Nullable<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSeverity> * Nullable<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertState> * string * Nullable<Azure.ResourceManager.AlertsManagement.Models.TimeRangeFilter> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSummary>><Extension()>
Public Function GetServiceAlertSummaryAsync (subscriptionResource As SubscriptionResource, groupby As AlertsSummaryGroupByField, Optional includeSmartGroupsCount As Nullable(Of Boolean) = Nothing, Optional targetResource As String = Nothing, Optional targetResourceType As String = Nothing, Optional targetResourceGroup As String = Nothing, Optional monitorService As Nullable(Of MonitorServiceSourceForAlert) = Nothing, Optional monitorCondition As Nullable(Of MonitorCondition) = Nothing, Optional severity As Nullable(Of ServiceAlertSeverity) = Nothing, Optional alertState As Nullable(Of ServiceAlertState) = Nothing, Optional alertRule As String = Nothing, Optional timeRange As Nullable(Of TimeRangeFilter) = Nothing, Optional customTimeRange As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ServiceAlertSummary))Parameters
- subscriptionResource
- SubscriptionResource
The SubscriptionResource instance the method will execute against.
- groupby
- AlertsSummaryGroupByField
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.
Include count of the SmartGroups as part of the summary. Default value is 'false'.
- targetResource
- String
Filter by target resource( which is full ARM ID) Default value is select all.
- targetResourceType
- String
Filter by target resource type. Default value is select all.
- targetResourceGroup
- String
Filter by target resource group name. Default value is select all.
- monitorService
- Nullable<MonitorServiceSourceForAlert>
Filter by monitor service which generates the alert instance. Default value is select all.
- monitorCondition
- Nullable<MonitorCondition>
Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.
- severity
- Nullable<ServiceAlertSeverity>
Filter by severity. Default value is select all.
- alertState
- Nullable<ServiceAlertState>
Filter by state of the alert instance. Default value is to select all.
- alertRule
- String
Filter by specific alert rule. Default value is to select all.
- timeRange
- Nullable<TimeRangeFilter>
Filter by time range by below listed values. Default value is 1 day.
- customTimeRange
- String
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.
- cancellationToken
- CancellationToken
The cancellation token to use.
