alert-definition

alert-definition
alert-definition

Defines a Problem by associating the Criticality level (Criticality)
of Symptom Definitions on related objects in the AlertDefinitionState
and also associates to a particular impact (AlertDefinitionImpact)

JSON Example
{
    "id": "string",
    "name": "string",
    "description": "string",
    "adapterKindKey": "string",
    "resourceKindKey": "string",
    "waitCycles": 0,
    "cancelCycles": 0,
    "type": 0,
    "subType": 0,
    "states": [
        {
            "severity": "string",
            "base-symptom-set": {},
            "impact": {
                "impactType": "string",
                "detail": "string"
            },
            "recommendationPriorityMap": {
                "recommendationPriorityMap": 0
            }
        }
    ],
    "forVCDTenants": false
}
string
id
Optional

The unique identifier across the system. Must be null during create

string
name
Required

The Name of the Problem Definition

string
description
Optional

The description of the problem definition

string
adapterKindKey
Required

The adapter kind key of the Adapter Kind that the Alert Definition applies to

string
resourceKindKey
Required

The resource kind key for the Resource Kind that the Alert Definition applies to

integer As int32 As int32
waitCycles
Optional
Constraints: minimum: 1

The Number of cycles the symptom conditions are true before triggering the problem alert

integer As int32 As int32
cancelCycles
Optional
Constraints: minimum: 1

The Number of cycles the symptom conditions are false before ending the problem alert

integer As int32 As int32
type
Optional

The type of the problem, for the purposes of routing an alert generated
by this problem.

integer As int32 As int32
subType
Optional

The sub type of the problem, for the purposes of routing an alert
generated by this problem.

array of alert-definition-state
states
Required

An Alert Definition state identifies the severity and impact a problem has when the
set of Symptom Definition conditions are true. One Alert Definition state per severity.

boolean
forVCDTenants
Optional

Is alert definition for tenants or not

Property Of
Parameter To
Returned By