Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricAlertResource

Package version

The metric alert resource.

Hierarchy

Index

Properties

Optional actions

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

Optional autoMitigate

autoMitigate: undefined | false | true

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

criteria

defines the specific alert criteria information.

Optional description

description: undefined | string

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

enabled

enabled: boolean

the flag that indicates whether the metric alert is enabled.

evaluationFrequency

evaluationFrequency: string

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

Optional id

id: undefined | string

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional isMigrated

isMigrated: undefined | false | true

the value indicating whether this alert rule is migrated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastUpdatedTime

lastUpdatedTime: Date

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

location

location: string

Resource location

Optional name

name: undefined | string

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

scopes

scopes: string[]

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

severity

severity: number

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

Optional tags

tags: undefined | {}

Resource tags

Optional targetResourceRegion

targetResourceRegion: undefined | string

the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.

Optional targetResourceType

targetResourceType: undefined | string

the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.

Optional type

type: undefined | string

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

windowSize

windowSize: string

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

Generated using TypeDoc