Options
All
  • Public
  • Public/Protected
  • All
Menu

Module UpdateAlertRuleDetails

The update alert rule details.

Properties

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

Optional description

description: undefined | string

The description of the alert rule

Optional displayName

displayName: undefined | string

The name of the alert rule.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: `{\"Department\": \"Finance\"}`

Optional message

message: undefined | string

The message to be delivered to the recipients when alert is triggered

Optional recipients

recipients: undefined | string

The audience that will receive the alert when it triggers. If you need to clear out this value, please pass in an empty string instead of null.

Optional threshold

threshold: undefined | number

The threshold for triggering the alert expressed as a whole number or decimal value. If thresholdType is ABSOLUTE, threshold can have at most 12 digits before the decimal point and up to 2 digits after the decimal point. If thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to 2 digits after the decimal point.

Optional thresholdType

thresholdType: model.ThresholdType

The type of threshold.

Optional type

type: model.AlertType

Type of alert. Valid values are ACTUAL (the alert will trigger based on actual usage) or FORECAST (the alert will trigger based on predicted usage).

Functions

getJsonObj