TimeWindowCustomAlertRule interface

A custom alert rule that checks if the number of activities (depends on the custom alert type) in a time window is within the given range.

Extends

Properties

ruleType

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

timeWindowSize

The time window size in iso8601 format.

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.

maxThreshold

The maximum threshold.

minThreshold

The minimum threshold.

Property Details

ruleType

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

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

Property Value

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

timeWindowSize

The time window size in iso8601 format.

timeWindowSize: string

Property Value

string

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 ThresholdCustomAlertRule.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 ThresholdCustomAlertRule.displayName

isEnabled

Status of the custom alert.

isEnabled: boolean

Property Value

boolean

Inherited From ThresholdCustomAlertRule.isEnabled

maxThreshold

The maximum threshold.

maxThreshold: number

Property Value

number

Inherited From ThresholdCustomAlertRule.maxThreshold

minThreshold

The minimum threshold.

minThreshold: number

Property Value

number

Inherited From ThresholdCustomAlertRule.minThreshold