MetricAlertPropertiesPatch interface

Package:

@azure/arm-monitor

An alert rule properties for patch.

Properties

actionProperties	The properties of an action properties.
actions	The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
autoMitigate	The flag that indicates whether the alert should be auto resolved or not. The default is true.
criteria	Defines the specific alert criteria information.
customProperties	The properties of an alert payload.
description	The description of the metric alert that will be included in the alert email.
enabled	The flag that indicates whether the metric alert is enabled.
evaluationFrequency	How often the metric alert is evaluated represented in ISO 8601 duration format.
isMigrated	The value indicating whether this alert rule is migrated.
lastUpdatedTime	Last time the rule was updated in ISO8601 format.
resolveConfiguration	The configuration for how the alert is resolved. Applicable for PromQLCriteria.
scopes	The list of resource id's that this metric alert is scoped to.
severity	Alert severity {0, 1, 2, 3, 4}
targetResourceRegion	The region of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria.
targetResourceType	The resource type of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria.
windowSize	The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

Property Details

actionProperties

The properties of an action properties.

actionProperties?: Record<string, string>

Property Value

Record<string, string>

actions

The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

actions?: MetricAlertAction[]

Property Value

MetricAlertAction[]

autoMitigate

The flag that indicates whether the alert should be auto resolved or not. The default is true.

autoMitigate?: boolean

Property Value

boolean

criteria

Defines the specific alert criteria information.

criteria?: MetricAlertCriteriaUnion

Property Value

MetricAlertCriteriaUnion

customProperties

The properties of an alert payload.

customProperties?: Record<string, string>

Property Value

Record<string, string>

description

The description of the metric alert that will be included in the alert email.

description?: string

Property Value

string

enabled

The flag that indicates whether the metric alert is enabled.

enabled?: boolean

Property Value

boolean

evaluationFrequency

How often the metric alert is evaluated represented in ISO 8601 duration format.

evaluationFrequency?: string

Property Value

string

isMigrated

The value indicating whether this alert rule is migrated.

isMigrated?: boolean

Property Value

boolean

lastUpdatedTime

Last time the rule was updated in ISO8601 format.

lastUpdatedTime?: Date

Property Value

Date

resolveConfiguration

The configuration for how the alert is resolved. Applicable for PromQLCriteria.

resolveConfiguration?: ResolveConfiguration

Property Value

ResolveConfiguration

scopes

The list of resource id's that this metric alert is scoped to.

scopes?: string[]

Property Value

string[]

severity

Alert severity {0, 1, 2, 3, 4}

severity?: number

Property Value

number

targetResourceRegion

The region of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria.

targetResourceRegion?: string

Property Value

string

targetResourceType

The resource type of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria.

targetResourceType?: string

Property Value

string

windowSize

The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

windowSize?: string

Property Value

string