AlertsGetSummaryOptionalParams interface

Package:

@azure/arm-alertsmanagement

Optional parameters.

Extends

OperationOptions

Properties

alertRule	Filter by specific alert rule. Default value is to select all.
alertState	Filter by state of the alert instance. Default value is to select all.
customTimeRange	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.
includeSmartGroupsCount	Include count of the SmartGroups as part of the summary. Default value is 'false'.
monitorCondition	Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.
monitorService	Filter by monitor service which generates the alert instance. Default value is select all.
severity	Filter by severity. Default value is select all.
targetResource	Filter by target resource( which is full ARM ID) Default value is select all.
targetResourceGroup	Filter by target resource group name. Default value is select all.
targetResourceType	Filter by target resource type. Default value is select all.
timeRange	Filter by time range by below listed values. Default value is 1 day.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
tracingOptions	Options used when tracing is enabled.

Property Details

alertRule

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

alertRule?: string

Property Value

string

alertState

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

alertState?: string

Property Value

string

customTimeRange

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.

customTimeRange?: string

Property Value

string

includeSmartGroupsCount

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

includeSmartGroupsCount?: boolean

Property Value

boolean

monitorCondition

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

monitorCondition?: string

Property Value

string

monitorService

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

monitorService?: string

Property Value

string

severity

Filter by severity. Default value is select all.

severity?: string

Property Value

string

targetResource

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

targetResource?: string

Property Value

string

targetResourceGroup

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

targetResourceGroup?: string

Property Value

string

targetResourceType

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

targetResourceType?: string

Property Value

string

timeRange

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

timeRange?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions