symptom-definition

symptom-definition
symptom-definition

A Symptom Definition defines conditions and properties which define when an alarm is triggered

JSON Example
{
    "adapterKindKey": "string",
    "cancelCycles": 0,
    "id": "string",
    "name": "string",
    "realtimeMonitoringEnabled": false,
    "resourceKindKey": "string",
    "state": {
        "condition": {
            "instanced": false,
            "key": "string",
            "operator": "string",
            "settingValue": "string",
            "targetKey": "string",
            "thresholdType": "string"
        },
        "severity": "string"
    },
    "waitCycles": 0
}
string
adapterKindKey
Required

The adapter kind identifier for the SymptomDefinition

integer As int32 As int32
cancelCycles
Optional

The number of consecutive cycles to wait when a symptom state is false before a symptom is cancelled

string
id
Optional

The identifier for the SymptomDefinition. Must be null during create.

string
name
Optional

The name of the SymptomDefinition

boolean
realtimeMonitoringEnabled
Optional

Indicates whether real-time monitoring is enabled for the symptom or not. (This field is only visible in SaaS)

string
resourceKindKey
Required

The resource kind identifier for the SymptomDefinition

state
Optional

The SymptomState is a product of the severity and a condition. A symptom definition may have one SymptomState per severity level.

integer As int32 As int32
waitCycles
Optional

The number of consecutive cycles to wait when a symptom state is true before a symptom is triggered