Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateAlertRuleDetails

The create alert rule details. This is a batch-create.

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: {@code {\"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. Avoid entering confidential information.

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: {@code {\"Department\": \"Finance\"}}

Optional message

message: undefined | string

The message to be sent to the recipients when the alert rule is triggered.

Optional recipients

recipients: undefined | string

The audience that receives the alert when it triggers. An empty string is interpreted as null.

threshold

threshold: number

The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

thresholdType

thresholdType: ThresholdType

The type of threshold.

type

type: AlertType

The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).

Functions

getDeserializedJsonObj

getJsonObj