LogAlertRuleProperties interface

Package:

@azure/arm-previewalertrule

scheduled query rule Definition

Properties

criteria	The rule criteria that defines the conditions of the scheduled query rule.
description	The description of the scheduled query rule.
displayName	The display name of the alert rule
enabled	The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
evaluationFrequency	How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
overrideQueryTimeRange	If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
scopes	The list of resource id's that this scheduled query rule is scoped to.
severity	Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
targetResourceTypes	List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
windowSize	The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

Property Details

criteria

The rule criteria that defines the conditions of the scheduled query rule.

criteria?: LogAlertRuleCriteria

Property Value

LogAlertRuleCriteria

description

The description of the scheduled query rule.

description?: string

Property Value

string

displayName

The display name of the alert rule

displayName?: string

Property Value

string

enabled

The flag which indicates whether this scheduled query rule is enabled. Value should be true or false

enabled?: boolean

Property Value

boolean

evaluationFrequency

How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.

evaluationFrequency?: string

Property Value

string

overrideQueryTimeRange

If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.

overrideQueryTimeRange?: string

Property Value

string

scopes

The list of resource id's that this scheduled query rule is scoped to.

scopes?: string[]

Property Value

string[]

severity

Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.

severity?: number

Property Value

number

targetResourceTypes

List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert

targetResourceTypes?: string[]

Property Value

string[]

windowSize

The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

windowSize?: string

Property Value

string