AlertsOperationsExtensions.GetAllAsync Method

Definition

Namespace:

Microsoft.Azure.Management.AlertsManagement

Assembly:

Microsoft.Azure.Management.AlertsManagement.dll

Package:

Microsoft.Azure.Management.AlertsManagement v1.0.0

List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.AlertsManagement.Models.Alert>> GetAllAsync (this Microsoft.Azure.Management.AlertsManagement.IAlertsOperations operations, string targetResource = default, string targetResourceType = default, string targetResourceGroup = default, string monitorService = default, string monitorCondition = default, string severity = default, string alertState = default, string alertRule = default, string smartGroupId = default, bool? includeContext = default, bool? includeEgressConfig = default, long? pageCount = default, string sortBy = default, string sortOrder = default, string select = default, string timeRange = default, string customTimeRange = default, System.Threading.CancellationToken cancellationToken = default);

static member GetAllAsync : Microsoft.Azure.Management.AlertsManagement.IAlertsOperations * string * string * string * string * string * string * string * string * string * Nullable<bool> * Nullable<bool> * Nullable<int64> * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.AlertsManagement.Models.Alert>>

<Extension()>
Public Function GetAllAsync (operations As IAlertsOperations, Optional targetResource As String = Nothing, Optional targetResourceType As String = Nothing, Optional targetResourceGroup As String = Nothing, Optional monitorService As String = Nothing, Optional monitorCondition As String = Nothing, Optional severity As String = Nothing, Optional alertState As String = Nothing, Optional alertRule As String = Nothing, Optional smartGroupId As String = Nothing, Optional includeContext As Nullable(Of Boolean) = Nothing, Optional includeEgressConfig As Nullable(Of Boolean) = Nothing, Optional pageCount As Nullable(Of Long) = Nothing, Optional sortBy As String = Nothing, Optional sortOrder As String = Nothing, Optional select As String = Nothing, Optional timeRange As String = Nothing, Optional customTimeRange As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of Alert))

Parameters

operations

IAlertsOperations

The operations group for this extension method.

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

String

Filter by monitor service which generates the alert instance. Default value is select all. Possible values include: 'Application Insights', 'ActivityLog Administrative', 'ActivityLog Security', 'ActivityLog Recommendation', 'ActivityLog Policy', 'ActivityLog Autoscale', 'Log Analytics', 'Nagios', 'Platform', 'SCOM', 'ServiceHealth', 'SmartDetector', 'VM Insights', 'Zabbix'

monitorCondition

String

Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all. Possible values include: 'Fired', 'Resolved'

severity

String

Filter by severity. Default value is select all. Possible values include: 'Sev0', 'Sev1', 'Sev2', 'Sev3', 'Sev4'

alertState

String

Filter by state of the alert instance. Default value is to select all. Possible values include: 'New', 'Acknowledged', 'Closed'

alertRule

String

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

smartGroupId

String

Filter the alerts list by the Smart Group Id. Default value is none.

includeContext

Nullable<Boolean>

Include context which has contextual data specific to the monitor service. Default value is false'

includeEgressConfig

Nullable<Boolean>

Include egress config which would be used for displaying the content in portal. Default value is 'false'.

pageCount

Nullable<Int64>

Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25.

sortBy

String

Sort the query results by input field, Default value is 'lastModifiedDateTime'. Possible values include: 'name', 'severity', 'alertState', 'monitorCondition', 'targetResource', 'targetResourceName', 'targetResourceGroup', 'targetResourceType', 'startDateTime', 'lastModifiedDateTime'

sortOrder

String

Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others. Possible values include: 'asc', 'desc'

select

String

This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section.

timeRange

String

Filter by time range by below listed values. Default value is 1 day. Possible values include: '1h', '1d', '7d', '30d'

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.

Returns

Task<IPage<Alert>>