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
System.DateTime
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 |
LinuxMachine
Inherits Machine
Member Name | Type | Description |
---|
Name | string | Name of the linux machine (inherited from MonitoredObject) |
BaseMonitor | BaseMonitor | The Base Monitor this Linux machine is monitored by |
Group | Group | The Group this Linux machine is assigned to |
Instance
Inherits MonitoredObject
Member Name | Type | Description |
---|
Name | string | Name of the SQL instance (inherited from MonitoredObject) |
Alias | string | Alias of the SQL instance |
ClusterInstance
Inherits Instance
Member Name | Type | Description |
---|
Name | string | Name of the SQL instance (inherited from MonitoredObject) |
Alias | string | Alias of the SQL instance (inherited from Instance) |
Cluster | Cluster | The cluster that hosts this instance |
GetTags() |
| Returns all the tags of the current instance |
MachineInstance
Inherits Instance
Member Name | Type | Description |
---|
Name | string | Name of the SQL instance (inherited from MonitoredObject) |
Alias | string | Alias of the SQL instance (inherited from Instance) |
Machine | Machine | The machine that hosts this instance |
GetTags() |
| Returns all the tags of the current instance |
SqlServerInstanceOnLinux
Inherits Instance
Member Name | Type | Description |
---|
Name | string | Name of the SQL instance (inherited from MonitoredObject) |
BaseMonitor | BaseMonitor | The Base Monitor this SqlServerInstance is monitored by |
LinuxMachine | LinuxMachine | The machine that hosts this instance |
Alias | string | Alias of the SQL instance |
GetTags() |
| Returns all the tags of the current 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 |
AzureManagedInstance
Inherits MonitoredObject
Member Name | Type | Description |
---|
Name | string | Name of the server (inherited from MonitoredObject) |
BaseMonitor | BaseMonitor | The Base Monitor this Azure Managed Instance is monitored by |
Group | Group | The Group this Azure Managed Instance is assigned to |
Alias | string | Alias of the Azure Managed Instance |
GetTags() |
| Returns all the tags of the current instance |
AzureManagedInstanceDatabase
Inherits MonitoredObject
AmazonRdsSqlServer
Inherits MonitoredObject
Member Name | Type | Description |
---|
Name | string | Name of the server (inherited from MonitoredObject) |
BaseMonitor | BaseMonitor | The Base Monitor this Amazon RDS SQL Server is monitored by |
Group | Group | The Group this Amazon RDS SQL Server is assigned to |
Alias | string | Alias of the Amazon RDS SQL Server |
GetTags() |
| Returns all the tags of the current instance |
AmazonRdsDatabase
Inherits MonitoredObject
Member Name | Type | Description |
---|
Name | string | Name of the server (inherited from MonitoredObject) |
AmazonRdsSqlServer | AmazonRdsSqlServer | The server this Amazon RDS SQL Database is 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 |
Group | Group | The Group this Azure SQL server is assigned to |
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 |
Alias | string | Alias of the database |
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 a 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 |
DatabaseFileUsageAlertSettingsMode
Member Name | Description |
---|
PercentFull | Used database file space is more than the threshold |
BytesRemaining | Remaining database file space is less than the threshold |
TimeRemaining | Remaining time until the database file gets full |
AbsoluteOrPercentAlertSettingsMode
Member Name | Description |
---|
Percentage | Indicates that the corresponding threshold value is a percentage |
Absolute | Indicates that the corresponding threshold value is an absolute value |
SeverityDto
Member Name | Description |
---|
Low |
|
Medium |
|
High |
|
ServiceState
Member Name | Description |
---|
Stopped |
|
Paused |
|
Started |
|
StoppedOrPaused |
|
StartedOrPaused |
|
AlertStatus
Member Name | Description |
---|
Inherited | Inherited alert status from the parent |
Customized | Customized alert status |
Disabled | Disabled alert status |
AlertSettings
Member Name | Type | Description |
---|
Status | AlertStatus | Status of the alert settings |
Comments | string | Comments of the alert settings |
NotificationSettings | NotificationSettings | Notification settings of the alert settings |
SpecificSettings | SpecificAlertSettings | Specific settings of the alert settings |
SpecificAlertSettings
Generic base type to store specific alert settings
DatabaseFileUsageAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
Mode | DatabaseFileUsageAlertSettingsMode | Mode of the alert settings |
DisableWhenAutogrowthEnabled | boolean | Disables the alert when Autogrowth is enabled |
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
AbsoluteValueThresholdAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
Duration | int32 | Time threshold in seconds to trigger the alert |
AbsoluteOrPercentAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
Mode | AbsoluteOrPercentAlertSettingsMode | Mode of the alert settings |
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
Duration | int32 | Time threshold in seconds to trigger the alert |
FilterableSqlProcessAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
IgnoreCommand | string | SQL commands to ignore (Regular expression) |
IgnoreProcess | string | SQL processes to ignore (Regular expression) |
DeadlockXEAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
Severity | SeverityDto | Severity of the alert settings |
RaiseAlertForVictimless | boolean | True if victimless deadlocks should be raised |
DatabaseNameRegexes | string | Database names where alerts should raise for (Regular expression) |
ResourceNameRegexes | string | Resource names where alerts should raise for (Regular expression) |
LoginNameRegexes | string | Login names where alerts should raise for (Regular expression) |
FragmentedIndexAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
IgnoreReadOnlyDatabases | boolean | True if read-only databases should be ignored |
MinPages | int32 |
|
IntegrityCheckOverdueAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
IgnoreReadOnlyDatabases | boolean | True if read-only databases should be ignored |
SqlErrorLogAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
IgnoreMatchingErrorMessageRegex | string |
|
IgnoreMatchingErrorNumberRegex | string |
|
IgnoreMatchingSeverityRegex | string |
|
ThresholdPlusDurationAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
Duration | int32 | Time threshold in seconds to trigger the alert |
SingleSeverityAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
Severity | SeverityDto | Severity of the alert settings |
ServiceStateAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
Severity | SeverityDto | Severity of the alert settings |
ServiceState | ServiceState |
|
ThresholdDurationJobExclusionAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
Duration | int32 | Time threshold in seconds to trigger the alert |
JobExclusionRegexes | string | Job names to exclude (Regular Expression) |
CustomMetricAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
MinimumDuration | int32 | Minimum time threshold in seconds to trigger the alert |
TimeThresholdAlertSettings
Inherits SpecificAlertSettings
Member Name | Type | Description |
---|
HighEnabled | boolean | True if the high threshold is defined |
HighThreshold | object | High threshold value of the specific alert settings |
MediumEnabled | boolean | True if the medium threshold is defined |
MediumThreshold | object | Medium threshold value of the specific alert settings |
LowEnabled | boolean | True if the low threshold is defined |
LowThreshold | object | Low threshold value of the specific alert settings |
AlertSuppressionAlertTypeGroupToSuppress
Member Name | Description |
---|
PerformanceRelatedAlertsAndCustomAlerts |
|
AllAlerts |
|
AlertSuppressionLevel
Member Name | Description |
---|
NotificationsOnly |
|
AlertsAndNotifications |
|
AlertSuppressionScheduleSetPosition
Member Name | Description |
---|
Last |
|
First |
|
Second |
|
Third |
|
Fourth |
|
BaseAlertSuppressionWindow
Base class for alert suppression window. It is inherited by the specific types of alert suppression windows.
Member Name | Type | Description |
---|
Name | string | Unique name for the window within its Base Monitor |
StartTime | System.TimeSpan | The start time of day for the window |
Duration | System.TimeSpan | Duration for the window to be active |
AlertTypeGroupToSuppress | AlertSuppressionAlertTypeGroupToSuppress | Type of alerts that will be affected by this alert suppression window |
AlertSuppressionLevel | AlertSuppressionLevel | Indicates the suppression level during this alert suppression window |
Targets | MonitoredObject[] | Target monitored objects to which the window will be applied to |
NonRecurringAlertSuppressionWindow
Inherits BaseAlertSuppressionWindow
Member Name | Type | Description |
---|
StartDate | System.DateTime | Contains the date and time for the start of the window |
WeeklyAlertSuppressionWindow
Inherits BaseAlertSuppressionWindow
Member Name | Type | Description |
---|
Days | System.DayOfWeek[] | Days in which the weekly alert suppression window will be active |
MonthlyAlertSuppressionWindow
Inherits BaseAlertSuppressionWindow
Member Name | Type | Description |
---|
Day | System.DayOfWeek | Day in which the monthly alert suppression window will be active |
ScheduleSetPosition | AlertSuppressionScheduleSetPosition | Relative week in which the monthly alert suppression window will be active |
ADPrincipal
Member Name | Type | Description |
---|
Name | string | The name of the AD Principal |
BaseMonitor | BaseMonitor | The base monitor the AD Principal is stored on |
PrincipalRole | string | The role of the AD Principal ("Administrator", "Standard", "Reporting" or "ReadOnly") |
Groups | Group[] | The groups the AD Principal has access to (if All is false) |
MonitoredObjects | MonitoredObject[] | The monitored objects the AD Principal has access to (outside groups, if All is false) |
All | boolean | True if the ADPrincipal has access to the entire estate; false otherwise |
Tag
Member Name | Type | Description |
---|
Name | string | Textual description of the tag |
EntityReference
Member Name | Type | Description |
---|
Reference | string | A unique id for a monitored entity placed on a base monitor |
SshPrivateKey
Member Name | Type | Description |
---|
Name | string | The name of the SSH private key |
Usage | int32 | The usage count of this key |
CreatedDate | System.DateTime | The date and time of when this key was added |
BaseMonitor | BaseMonitor | The Base Monitor this key is added to |