ScheduledQueryRuleResource interface

Package:

@azure/arm-monitor

The scheduled query rule resource.

Extends

ProxyResource

Properties

actions	Actions to invoke when the alert fires.
autoMitigate	The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert.
checkWorkspaceAlertsStorageConfigured	The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
createdWithApiVersion	The api-version used when creating this alert rule
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
etag	Resource entity tag (ETag).
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.
identity	The identity of the resource.
isLegacyLogAnalyticsRule	True if alert rule is legacy Log Analytic rule
isWorkspaceAlertsStorageConfigured	The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
kind	Indicates the type of scheduled query rule. The default is LogAlert.
location	The geo-location where the resource lives
muteActionsDuration	Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant 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.
resolveConfiguration	Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert.
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.
skipQueryValidation	The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
tags	Resource tags.
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.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

actions

Actions to invoke when the alert fires.

actions?: Actions

Property Value

Actions

autoMitigate

The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert.

autoMitigate?: boolean

Property Value

boolean

checkWorkspaceAlertsStorageConfigured

The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.

checkWorkspaceAlertsStorageConfigured?: boolean

Property Value

boolean

createdWithApiVersion

The api-version used when creating this alert rule

createdWithApiVersion?: string

Property Value

string

criteria

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

criteria?: ScheduledQueryRuleCriteria

Property Value

ScheduledQueryRuleCriteria

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

etag

Resource entity tag (ETag).

etag?: string

Property Value

string

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

identity

The identity of the resource.

identity?: Identity

Property Value

Identity

isLegacyLogAnalyticsRule

True if alert rule is legacy Log Analytic rule

isLegacyLogAnalyticsRule?: boolean

Property Value

boolean

isWorkspaceAlertsStorageConfigured

The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.

isWorkspaceAlertsStorageConfigured?: boolean

Property Value

boolean

kind

Indicates the type of scheduled query rule. The default is LogAlert.

kind?: string

Property Value

string

location

The geo-location where the resource lives

location: string

Property Value

string

muteActionsDuration

Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.

muteActionsDuration?: 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

resolveConfiguration

Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert.

resolveConfiguration?: RuleResolveConfiguration

Property Value

RuleResolveConfiguration

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

skipQueryValidation

The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.

skipQueryValidation?: boolean

Property Value

boolean

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

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

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type