MetricAlertResourcePatch interface

The metric alert resource for patch operations.

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.

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. NOTE: This property will not be serialized. It can only be populated by the server.

lastUpdatedTime

Last time the rule was updated in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

scopes

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

severity

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

tags

Resource tags

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

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

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

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. NOTE: This property will not be serialized. It can only be populated by the server.

isMigrated?: boolean

Property Value

boolean

lastUpdatedTime

Last time the rule was updated in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

lastUpdatedTime?: Date

Property Value

Date

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

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

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