Custom Types
Published 04 June 2019
MonitoredObject
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the monitored object |
BaseMonitor
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the base monitor |
Cluster
Inherits MonitoredObject
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the cluster (inherited from MonitoredObject) |
| BaseMonitor | BaseMonitor | The base monitor this cluster is monitored by |
Machine
Inherits MonitoredObject
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the machine (inherited from MonitoredObject) |
StandaloneMachine
Inherits Machine
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the machine (inherited from MonitoredObject) |
| BaseMonitor | BaseMonitor | The base monitor this standalone machine is monitored by |
ClusterMachine
Inherits Machine
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the machine (inherited from MonitoredObject) |
| Cluster | Cluster | The cluster this machine forms part of |
Instance
Inherits MonitoredObject
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the SQL Instance (inherited from MonitoredObject) |
ClusterInstance
Inherits Instance
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the SQL Instance (inherited from MonitoredObject) |
| Cluster | Cluster | The cluster that hosts this instance |
MachineInstance
Inherits Instance
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the SQL Instance (inherited from MonitoredObject) |
| Machine | Machine | The machine that hosts this instance |
AvailabilityGroup
Inherits MonitoredObject
| Member Name: | Type | Description |
|---|---|---|
| Name | string | Name of the availability group (inherited from MonitoredObject) |
| Cluster | Cluster | The cluster that hosts this availability group |
Disk
Inherits MonitoredObject
| Member Name | Type | Description |
|---|---|---|
| Name | string | Name of the disk (inherited from MonitoredObject) |
| Machine | Machine | The machine that this disk is located on |
Database
Inherits MonitoredObject
| Member Name | Type | Description |
|---|---|---|
| Name | string | Name of the database (inherited from MonitoredObject) |
| Instance | Instance | The instance this database is on |
Job
Inherits MonitoredObject
| Member Name | Type | Description |
|---|---|---|
| Name | string | Name of the job (inherited from MonitoredObject) |
| Instance | Instance | The instance that this job is defined on |
AzureSqlServer
Inherits MonitoredObject
| Member Name | Type | Description |
|---|---|---|
| Name | string | Name of the server (inherited from MonitoredObject) |
| BaseMonitor | BaseMonitor | The base monitor this Azure SQL server is monitored by |
AzureSqlDatabase
Inherits MonitoredObject
| Member Name | Type | Description |
|---|---|---|
| Name | string | Name of the database (inherited from MonitoredObject) |
| AzureSqlServer | AzureSqlServer | The server this Azure SQL database is on |
ElasticPool
Inherits MonitoredObject
| Member Name | Type | Description |
|---|---|---|
| Name | string | Name of the Elastic Pool (inherited from MonitoredObject) |
| AzureSqlServer | AzureSqlServer | The server this Azure Elastic Pool is on |
Group
Inherits MonitoredObject
| Member Name | Type | Description |
|---|---|---|
| Name | string | Name of the group (inherited from MonitoredObject) |
| BaseMonitor | BaseMonitor | The base monitor this group is on |
| Id | string | ID of the group |
| ParentId | string | ID of the parent group |
AlertType
| Member Name | Type | Description |
|---|---|---|
| Name | string | Name of the alert type |
| Id | int32 | Type of the alert |
EmailNotificationOption
| Member Name | Description |
|---|---|
| DontEmail | Do not send notification email |
| SendToDefault | Send email notifications to the default recipients |
| SendToCustom | Send email notifications to the specific recipients |
NotificationSettings
| Member Name | Type | Description |
|---|---|---|
| EmailNotificationOption | EmailNotificationOption | Notification option for the alert |
| EmailAddresses | string array | Email addresses for the specific notification receivers (used if EmailNotificationOption is set to "SendToCustom") |
| SlackEnabled | boolean | True if notification also needs to be sent through slack |
| SnmpEnabled | boolean | True if notification also needs to be sent through snmp |
