ThresholdCustomAlertRule interface

A custom alert rule that checks if a value (depends on the custom alert type) is within the given range.

Extends

Properties

maxThreshold

The maximum threshold.

minThreshold

The minimum threshold.

ruleType

Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

description

The description of the custom alert. NOTE: This property will not be serialized. It can only be populated by the server.

displayName

The display name of the custom alert. NOTE: This property will not be serialized. It can only be populated by the server.

isEnabled

Status of the custom alert.

Property Details

maxThreshold

The maximum threshold.

maxThreshold: number

Property Value

number

minThreshold

The minimum threshold.

minThreshold: number

Property Value

number

ruleType

Polymorphic discriminator, which specifies the different types this object can be

ruleType: "ActiveConnectionsNotInAllowedRange" | "AmqpC2DMessagesNotInAllowedRange" | "AmqpC2DRejectedMessagesNotInAllowedRange" | "AmqpD2CMessagesNotInAllowedRange" | "ThresholdCustomAlertRule" | "TimeWindowCustomAlertRule" | "MqttC2DMessagesNotInAllowedRange" | "HttpC2DMessagesNotInAllowedRange" | "MqttC2DRejectedMessagesNotInAllowedRange" | "HttpC2DRejectedMessagesNotInAllowedRange" | "MqttD2CMessagesNotInAllowedRange" | "HttpD2CMessagesNotInAllowedRange" | "DirectMethodInvokesNotInAllowedRange" | "FailedLocalLoginsNotInAllowedRange" | "FileUploadsNotInAllowedRange" | "QueuePurgesNotInAllowedRange" | "TwinUpdatesNotInAllowedRange" | "UnauthorizedOperationsNotInAllowedRange"

Property Value

"ActiveConnectionsNotInAllowedRange" | "AmqpC2DMessagesNotInAllowedRange" | "AmqpC2DRejectedMessagesNotInAllowedRange" | "AmqpD2CMessagesNotInAllowedRange" | "ThresholdCustomAlertRule" | "TimeWindowCustomAlertRule" | "MqttC2DMessagesNotInAllowedRange" | "HttpC2DMessagesNotInAllowedRange" | "MqttC2DRejectedMessagesNotInAllowedRange" | "HttpC2DRejectedMessagesNotInAllowedRange" | "MqttD2CMessagesNotInAllowedRange" | "HttpD2CMessagesNotInAllowedRange" | "DirectMethodInvokesNotInAllowedRange" | "FailedLocalLoginsNotInAllowedRange" | "FileUploadsNotInAllowedRange" | "QueuePurgesNotInAllowedRange" | "TwinUpdatesNotInAllowedRange" | "UnauthorizedOperationsNotInAllowedRange"

Inherited Property Details

description

The description of the custom alert. NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

Inherited From CustomAlertRule.description

displayName

The display name of the custom alert. NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

Inherited From CustomAlertRule.displayName

isEnabled

Status of the custom alert.

isEnabled: boolean

Property Value

boolean

Inherited From CustomAlertRule.isEnabled