Custom Types
Published 28 March 2024
AbsoluteOrPercentAlertSettings
Class
Alert specific settings for a generic "absolute or percent" alert ('AbsoluteOrPercent'). The 'Mode' property indicates which kind of unit will be used by the thresholds.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Mode | AbsoluteOrPercentAlertSettingsMode | Yes | Mode of the alert settings |
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | object | No | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | object | No | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | object | No | Low threshold value of the specific alert settings |
| Duration | Int32 | Yes | Time threshold in seconds to trigger the alert |
AbsoluteValueThresholdAlertSettings
Class
Alert specific settings for multiple percentage and absolute value alert types.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | Double | Yes | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | Double | Yes | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | Double | Yes | Low threshold value of the specific alert settings |
| Duration | Int | Yes | Time threshold in seconds to trigger the alert |
AccessReport
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| AccessGranted | Boolean | No | |
| AccessReason | string | No | |
| BaseMonitor | BaseMonitor | No |
AdDomain
Class
Inherits from: MonitoredIamObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No |
ADPrincipal
Class
Inherits from: Principal
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| BaseMonitor | BaseMonitor | No | |
| PrincipalRole | string | No | |
| PrincipalType | string | No | |
| Groups | Group[] | No | |
| MonitoredObjects | MonitoredObject[] | No | |
| All | Boolean | No | |
| AuthenticationType | string | No |
AlertSettings
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Status | AlertStatus | No | Status of the alert settings |
| Comments | String | No | Comments of the alert settings |
| NotificationSettings | NotificationSettings | No | Notification settings of the alert settings |
| SpecificSettings | SpecificAlertSettings | No | Specific settings of the alert settings |
AlertSuppressionWindowModel
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Id | Int32 | Yes | |
| Name | String | No | |
| Start | TimeSpan | No | |
| Duration | Int32 | No | |
| ScheduleFrequency | String | No | |
| AlertTypeGroupToSuppress | String | No | |
| AlertSuppressionLevel | String | No | |
| Type | string | No | |
| Status | string | No | |
| Targets | IdentifiableObject[] | No | |
| StartDate | DateTime | Yes | |
| Monday | Boolean | No | |
| Tuesday | Boolean | No | |
| Wednesday | Boolean | No | |
| Thursday | Boolean | No | |
| Friday | Boolean | No | |
| Saturday | Boolean | No | |
| Sunday | Boolean | No | |
| ScheduleSetPosition | String | No | |
| MonthlyScheduleDayOfWeek | System.DayOfWeek | Yes |
AlertType
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | String | No | Name of the alert type |
| Id | int32 | No | Type of the alert |
AmazonAuroraCluster
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this Amazon Aurora cluster is monitored by |
| Group | Group | No | The Group this Amazon Aurora cluster is assigned to |
| Alias | String | No | Alias of the Amazon Aurora cluster |
AmazonRdsDatabase
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| AmazonRdsSqlServer | AmazonRdsSqlServer | No | The server this Amazon RDS SQL Database is on |
| Tags | Tag[] | No |
AmazonRdsHost
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this Amazon RDS host is monitored by |
| Group | Group | No | The Group this Amazon RDS host is assigned to |
| Alias | String | No | Alias of the Amazon RDS host |
AmazonRdsSqlServer
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this Amazon RDS SQL Server is monitored by |
| Group | Group | No | The Group this Amazon RDS SQL Server is assigned to |
| Alias | String | No | Alias of the Amazon RDS SQL Server |
AvailabilityGroup
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Cluster | Cluster | No | The cluster that hosts this availability group |
| Listeners | AvailabilityGroupListener[] | No |
AvailabilityGroupListener
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IpAddress | string | No | |
| Port | int | No |
AwsCloudServiceCredential
Class
Inherits from: IdentifiableObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| Id | string | No | |
| Region | string | No | |
| AccessKeyId | string | No | |
| PartiallyRedactedSecretAccessKey | string | No | |
| CreatedDate | datetime | No | |
| Usage | int | No | |
| BaseMonitor | BaseMonitor | No |
AzureFlexHost
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this Azure flexible host is monitored by |
| Group | Group | No | The Group this Azure flexible host is assigned to |
| Alias | String | No | Alias of the Azure Flexible Server instance |
AzureManagedInstance
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this Azure Managed Instance is monitored by |
| Group | Group | No | The Group this Azure Managed Instance is assigned to |
| Alias | String | No | Alias of the Azure Managed Instance |
AzureManagedInstanceDatabase
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| AzureManagedInstance | AzureManagedInstance | No | The Azure Managed Instance this database belongs to |
| Tags | Tag[] | No |
AzureSqlDatabase
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| AzureSqlServer | AzureSqlServer | No | The server this Azure SQL database is on |
| Alias | String | No | Alias of the database |
| Tags | Tag[] | No |
AzureSqlServer
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this Azure SQL server is monitored by |
| Group | Group | No | The Group this Azure SQL server is assigned to |
| AutoDiscoveryEnabled | Boolean | No |
BackupOverdueAlertSettings
Class
Alert specific settings for backup overdue alerts. ('DatabaseNotBackedUp', 'DatabaseNotLogBackedUp').
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | |
| HighThreshold | Int32 | Yes | |
| MediumEnabled | Boolean | Yes | |
| MediumThreshold | Int32 | Yes | |
| LowEnabled | Boolean | Yes | |
| LowThreshold | Int32 | Yes | |
| IgnoreCopyOnlyBackups | Boolean | Yes | |
| IgnoreDatabaseNameRegexes | String[] | No |
BaseAlertSuppressionWindow
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| BaseMonitor | BaseMonitor | No | |
| Name | string | No | Unique name for the window within its Base Monitor |
| StartTime | timespan | No | The start time of day for the window |
| Duration | timespan | No | Duration for the window to be active |
| AlertTypeGroupToSuppress | AlertSuppressionAlertTypeGroupToSuppress | No | Type of alerts that will be affected by this alert suppression window |
| AlertSuppressionLevel | AlertSuppressionLevel | No | Indicates the suppression level during this alert suppression window |
| Targets | IdentifiableObject[] | No | Target monitored objects to which the window will be applied to |
BaseMonitor
Class
Inherits from: TraversableObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsDisconnected | Boolean | No |
Cluster
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this cluster is monitored by |
| Group | Group | No |
ClusterInstance
Class
Inherits from: Instance
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Alias | String | No | Alias of the SQL instance |
| Cluster | Cluster | No | The cluster that hosts this instance |
| VirtualInstanceName | String | No |
ClusterMachine
Class
Inherits from: Machine
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Cluster | Cluster | No | The cluster this machine forms part of |
ConfigurationChangeAlertSettings
Class
Alert specific settings for SQL Server configuration change.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Severity | SeverityDto | Yes | |
| DatabaseEngine | DatabaseEngineDto | Yes |
CustomMetricAlertSettings
Class
Alert specific settings for custom metrics.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | Double | Yes | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | Double | Yes | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | Double | Yes | Low threshold value of the specific alert settings |
| MinimumDuration | Int32 | Yes | Minimum time threshold in seconds to trigger the alert |
Database
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Instance | Instance | No | The instance this database is on |
| Tags | Tag[] | No |
DatabaseFileUsageAlertSettings
Class
Alert specific settings for database file usage alert ('DatabaseFileUsage'). The 'Mode' property indicates which kind of unit will be used by the thresholds.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Mode | DatabaseFileUsageAlertSettingsMode | Yes | Mode of the alert settings |
| UseMaxFileSizeWhenAutoGrowthEnabled | Boolean | Yes | |
| MsdbEnabled | Boolean | Yes | |
| TempDbEnabled | Boolean | Yes | |
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | object | No | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | object | No | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | object | No | Low threshold value of the specific alert settings |
| LogFileConfiguration | DatabaseLogFileUsageAlertSettings | No | |
| IgnoreDatabaseNameRegexes | String[] | No |
DatabaseLogFileUsageAlertSettings
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Enabled | Boolean | Yes | |
| Mode | DatabaseLogFileUsageAlertSettingsMode | Yes | |
| UseMaxFileSizeWhenAutoGrowthEnabled | Boolean | Yes | |
| MsdbEnabled | Boolean | Yes | |
| TempDbEnabled | Boolean | Yes | |
| HighEnabled | Boolean | Yes | |
| HighThreshold | object | No | |
| MediumEnabled | Boolean | Yes | |
| MediumThreshold | object | No | |
| LowEnabled | Boolean | Yes | |
| LowThreshold | object | No |
DatabasePermissionChangeRule
Class
A per-action / per-securable severity rule for the Database Permissions Changes alert.
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Action | DatabasePermissionChangeAction | No | The permission action to match. Use Any to match any action. |
| Securable | SqlServerObjectType | No | The SqlServerObjectType to match, or null for any. Note that Object matches any schema-bound object, while Table, View etc. match only their specific type. |
| Severity | SeverityDto | Yes | The severity to raise when this rule matches. |
DatabasePermissionChangesAlertSettings
Class
Alert specific settings for the Database Permissions Changes alert.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Mode | AlertConfigurationMode | Yes | Simple or Advanced configuration mode. |
| Severity | SeverityDto | Yes | Used in Simple mode — severity to raise for every permission change. |
| Rules | DatabasePermissionChangeRule[] | No | Used in Advanced mode — list of per-action/per-securable severity rules. The highest matching severity is used when multiple rules apply. |
DatabaseUnavailableAlertSettings
Class
Alert specific settings for a database unavailable alert ('DatabaseUnavailable').
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | |
| HighThreshold | Int32 | Yes | |
| MediumEnabled | Boolean | Yes | |
| MediumThreshold | Int32 | Yes | |
| LowEnabled | Boolean | Yes | |
| LowThreshold | Int32 | Yes | |
| AlertForDatabasesInRestoringState | Boolean | Yes | |
| IgnoreDatabaseNameRegexes | String[] | No |
DeadlockAlertSettings
Class
Alert specific settings for deadlocks detected. The regular expression properties can be used to exclude databases, reources or logins from the alert.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Severity | SeverityDto | Yes | |
| RaiseAlertForVictimless | bool | Yes | |
| DatabaseNameRegexes | string[] | No | |
| ResourceNameRegexes | string[] | No | |
| LoginNameRegexes | string[] | No |
DiffBackupOverdueAlertSettings
Class
Alert specific settings for differential backup overdue alerts. ('DatabaseNotDifferentialBackedUp').
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | |
| HighThreshold | Int32 | Yes | |
| MediumEnabled | Boolean | Yes | |
| MediumThreshold | Int32 | Yes | |
| LowEnabled | Boolean | Yes | |
| LowThreshold | Int32 | Yes | |
| IgnoreDatabaseNameRegexes | string[] | No |
Disk
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Machine | Machine | No | The machine that this disk is located on |
ElasticPool
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| AzureSqlServer | AzureSqlServer | No | The server this Azure Elastic Pool is on |
ErrorLogEntryAlertSettings
Class
Alert specific settings for database instance error log entries.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | |
| HighThreshold | Int32 | Yes | |
| MediumEnabled | Boolean | Yes | |
| MediumThreshold | Int32 | Yes | |
| LowEnabled | Boolean | Yes | |
| LowThreshold | Int32 | Yes | |
| IgnoreMatchingErrorMessageRegex | String[] | No | |
| IgnoreMatchingErrorNumberRegex | String[] | No | |
| IgnoreMatchingSeverityRegex | String[] | No |
FilterableProcessAlertSettings
Class
Alert specific settings for filterable process alert ('FilterableProcess').
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | |
| HighThreshold | Int32 | Yes | |
| MediumEnabled | Boolean | Yes | |
| MediumThreshold | Int32 | Yes | |
| LowEnabled | Boolean | Yes | |
| LowThreshold | Int32 | Yes | |
| IgnoreCommand | String[] | No | |
| IgnoreProcess | String[] | No | |
| IgnoreDatabase | String[] | No | |
| IgnoreLogin | String[] | No |
FragmentedIndexAlertSettings
Class
Alert specific settings for a fragmented index alert ('FragmentedIndex').
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | Int32 | Yes | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | Int32 | Yes | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | Int32 | Yes | Low threshold value of the specific alert settings |
| IgnoreReadOnlyDatabases | Boolean | Yes | True if read-only databases should be ignored |
| MinPages | Int32 | Yes | |
| IgnoreDatabaseNameRegexes | String[] | No |
GoogleCloudHost
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | |
| Group | Group | No | |
| Alias | String | No |
Group
Class
Inherits from: TraversableObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| BaseMonitor | BaseMonitor | No | The Base Monitor this group is on |
IdentifiableObject
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No |
Instance
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Alias | String | No | Alias of the SQL instance |
IntegrityCheckOverdueAlertSettings
Class
Alert specific settings for an integrity check overdue alert ('IntegrityCheckOverdue').
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | Int32 | Yes | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | Int32 | Yes | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | Int32 | Yes | Low threshold value of the specific alert settings |
| IgnoreReadOnlyDatabases | Boolean | Yes | True if read-only databases should be ignored |
| IgnoreDatabaseNameRegexes | String[] | No |
Job
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Instance | Instance | No | The instance that this job is defined on |
JobFailureAlertSettings
Class
Inherits from: JobSingleSeverityAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| SingleSeverityAlertSetting | SingleSeverityAlertSettings | No | |
| IgnoreJobNameRegexes | String[] | No | |
| IgnoreJobOwnerRegexes | String[] | No | |
| IgnoreSecondary | Boolean | No | |
| AlertOnStepFailure | Boolean | No |
JobSingleSeverityAlertSettings
Class
Alert specific settings for job alerts characterized by a single threshold value.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| SingleSeverityAlertSetting | SingleSeverityAlertSettings | No | |
| IgnoreJobNameRegexes | String[] | No | |
| IgnoreJobOwnerRegexes | String[] | No | |
| IgnoreSecondary | Boolean | No |
LinuxMachine
Class
Inherits from: Machine
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this Linux machine is monitored by |
| Group | Group | No | The Group this Linux machine is assigned to |
LogEntryAlertSettings
Class
Alert specific settings for database instance log entries.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | |
| MediumEnabled | Boolean | Yes | |
| LowEnabled | Boolean | Yes | |
| IncludeMatchingMessageRegexHigh | String[] | No | |
| IncludeMatchingMessageRegexMedium | String[] | No | |
| IncludeMatchingMessageRegexLow | String[] | No |
Machine
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
MachineInstance
Class
Inherits from: Instance
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Alias | String | No | Alias of the SQL instance |
| Machine | Machine | No | The machine that hosts this instance |
MicrosoftEntraId
Class
Inherits from: MonitoredIamObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No |
MonitoredIamObject
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
MonitoredObject
Class
Inherits from: TraversableObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
MonitoredObjectState
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| IsMonitored | Boolean | No | |
| Status | String | No | |
| ConfigurationState | String | No |
MonthlyAlertSuppressionWindow
Class
Inherits from: BaseAlertSuppressionWindow
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| BaseMonitor | BaseMonitor | No | |
| Name | string | No | Unique name for the window within its Base Monitor |
| StartTime | timespan | No | The start time of day for the window |
| Duration | timespan | No | Duration for the window to be active |
| AlertTypeGroupToSuppress | AlertSuppressionAlertTypeGroupToSuppress | No | Type of alerts that will be affected by this alert suppression window |
| AlertSuppressionLevel | AlertSuppressionLevel | No | Indicates the suppression level during this alert suppression window |
| Targets | IdentifiableObject[] | No | Target monitored objects to which the window will be applied to |
| ScheduleSetPosition | AlertSuppressionScheduleSetPosition | No | Relative week in which the monthly alert suppression window will be active |
| Day | System.DayOfWeek | No | Day in which the monthly alert suppression window will be active |
NonRecurringAlertSuppressionWindow
Class
Inherits from: BaseAlertSuppressionWindow
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| BaseMonitor | BaseMonitor | No | |
| Name | string | No | Unique name for the window within its Base Monitor |
| StartTime | timespan | No | The start time of day for the window |
| Duration | timespan | No | Duration for the window to be active |
| AlertTypeGroupToSuppress | AlertSuppressionAlertTypeGroupToSuppress | No | Type of alerts that will be affected by this alert suppression window |
| AlertSuppressionLevel | AlertSuppressionLevel | No | Indicates the suppression level during this alert suppression window |
| Targets | IdentifiableObject[] | No | Target monitored objects to which the window will be applied to |
| StartDate | System.DateTime | No | Contains the date and time for the start of the window |
NotificationSettings
Class
Class containing all the properties that can be customized.
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| EMailNotificationOption | EmailNotificationOption | Yes | Notification option for the alert |
| EmailAddresses | String[] | No | Email addresses for the specific notification receivers (used if EmailNotificationOption is set to "SendToCustom") |
| SlackEnabled | Boolean | Yes | True if notification also needs to be sent through Slack |
| SnmpEnabled | Boolean | Yes | True if notification also needs to be sent through SNMP |
| WebhookEnabled | Boolean | Yes | |
| ScriptEnabled | Boolean | Yes | |
| ServiceNowEnabled | Boolean | Yes | |
| MsTeamsEnabled | Boolean | Yes | |
| GenericCustomEmailText | String | No | |
| LowSeverityCustomEmailText | String | No | |
| MediumSeverityCustomEmailText | String | No | |
| HighSeverityCustomEmailText | String | No |
PostgresErrorLogEntryAlertSettings
Class
Alert specific settings for PostgreSQL database instance error log entries.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | |
| HighThresholdValue | String | No | |
| MediumEnabled | Boolean | Yes | |
| MediumThresholdValue | String | No | |
| LowEnabled | Boolean | Yes | |
| LowThresholdValue | String | No | |
| IgnoreMatchingErrorMessageRegex | String[] | No | |
| IgnoreMatchingErrorNumberRegex | String[] | No |
PostgresInstance
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| LinuxMachine | LinuxMachine | No | (Optional) The Linux machine that hosts this server |
| WindowsMachine | WindowsMachine | No | (Optional) The Windows machine that hosts this server |
| AmazonRdsHost | AmazonRdsHost | No | (Optional) The RDS instance that hosts this server |
| AmazonAuroraCluster | AmazonAuroraCluster | No | (Optional) The Aurora cluster that hosts this server |
| AzureFlexHost | AzureFlexHost | No | (Optional) The Azure Flexible Server that hosts this server |
| GoogleCloudHost | GoogleCloudHost | No | (Optional) The Google Cloud host that hosts this server |
| BaseMonitor | BaseMonitor | No | The Base Monitor this Postgres instance is monitored by |
| Alias | String | No | Alias of the Postgres instance |
Principal
Class
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| BaseMonitor | BaseMonitor | No | |
| PrincipalRole | string | No | |
| PrincipalType | string | No | |
| Groups | Group[] | No | |
| MonitoredObjects | MonitoredObject[] | No | |
| All | Boolean | No | |
| AuthenticationType | string | No |
RepeatedLoginFailuresAlertSettings
Class
Alert specific settings for the Repeated Login Failures alert.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Severity | SeverityDto | Yes | |
| FailureThreshold | Int32 | Yes | |
| TimeWindowMinutes | Int32 | Yes | |
| DetectionScope | LoginFailureDetectionScope | Yes |
ServerRoleMembershipChangesAlertSettings
Class
Alert specific settings for the Server Role Membership Changes alert.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Severity | SeverityDto | Yes | Default severity that will be raised if an override isn't matched. |
| RoleOverrides | ServerRoleOverrideSettings[] | No | List of role overrides with severity. The highest severity with a matching override will be raised. |
ServerRoleOverrideSettings
Class
A per-role severity override entry for the Server Role Membership Changes alert.
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| RoleName | String | No | Name of the role to match against. |
| Severity | OverrideSeverityDto | Yes | Severity of the alert that will be raised if this override is matched against. |
ServicePrincipalCredential
Class
Inherits from: IdentifiableObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | Name of the service principal |
| Id | string | No | |
| TenantId | string | No | The tenantId of the registered app |
| ClientId | string | No | The ClientId of the registered app |
| PartiallyRedactedClientSecret | string | No | |
| CreatedDate | datetime | No | |
| Usage | int | No | |
| BaseMonitor | BaseMonitor | No | The Base Monitor this principal belongs to |
ServiceStateAlertSettings
Class
Alert specific settings for service state changes.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| ServiceState | ServiceState | Yes | |
| Severity | SeverityDto | Yes | Severity of the alert settings |
SingleSeverityAlertSettings
Class
Alert specific settings for alerts characterized by a single threshold value.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Severity | SeverityDto | Yes | Severity of the alert settings |
SpecificAlertSettings
Class
Generic base type to store specific alert settings.
| Member Name | Type | Nullable | Description |
|---|
SqlReplicationJobFailureAlertSettings
Class
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| SingleSeverityAlertSetting | SingleSeverityAlertSettings | No | |
| IgnoreJobNameRegexes | String[] | No | |
| AlertOnStepFailure | Boolean | No | |
| IgnoreSecondary | Boolean | No |
SqlServerInstanceOnLinux
Class
Inherits from: Instance
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| Alias | String | No | Alias of the SQL instance |
| Machine | LinuxMachine | No | |
| BaseMonitor | BaseMonitor | No | The Base Monitor this SqlServerInstance is monitored by |
SshPrivateKey
Class
Inherits from: IdentifiableObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| Usage | Int32 | No | The usage count of this key |
| CreatedDate | System.DateTime | No | The date and time of when this key was added |
| BaseMonitor | BaseMonitor | No | The Base Monitor this key is added to |
StandaloneMachine
Class
Inherits from: Machine
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | The Base Monitor this standalone machine is monitored by |
| Group | Group | No |
Tag
Class
Inherits from: IdentifiableObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No |
ThresholdDurationJobExclusionAlertSettings
Class
Alert when a job duration deviates from its baseline duration.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | Int32 | Yes | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | Int32 | Yes | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | Int32 | Yes | Low threshold value of the specific alert settings |
| Duration | Int32 | Yes | Time threshold in seconds to trigger the alert |
| IgnoreJobNameRegexes | String[] | No | |
| IgnoreJobOwnerRegexes | String[] | No |
ThresholdPlusDurationAlertSettings
Class
Alert specific settings for azure and local server metrics using percentage ('PercentConfig'). The threshold values will always represent percentage point, varying from 0 to 1.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | Int32 | Yes | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | Int32 | Yes | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | Int32 | Yes | Low threshold value of the specific alert settings |
| Duration | Int32 | Yes | Time threshold in seconds to trigger the alert |
TimeThresholdAlertSettings
Class
Alert specific settings for time-threshold related alerts.
Inherits from: SpecificAlertSettings
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| HighEnabled | Boolean | Yes | True if the high threshold is defined |
| HighThreshold | Int32 | Yes | High threshold value of the specific alert settings |
| MediumEnabled | Boolean | Yes | True if the medium threshold is defined |
| MediumThreshold | Int32 | Yes | Medium threshold value of the specific alert settings |
| LowEnabled | Boolean | Yes | True if the low threshold is defined |
| LowThreshold | Int32 | Yes | Low threshold value of the specific alert settings |
TraversableObject
Class
Inherits from: IdentifiableObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No |
UpdateTagOperation
Class
WeeklyAlertSuppressionWindow
Class
Inherits from: BaseAlertSuppressionWindow
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| BaseMonitor | BaseMonitor | No | |
| Name | string | No | Unique name for the window within its Base Monitor |
| StartTime | timespan | No | The start time of day for the window |
| Duration | timespan | No | Duration for the window to be active |
| AlertTypeGroupToSuppress | AlertSuppressionAlertTypeGroupToSuppress | No | Type of alerts that will be affected by this alert suppression window |
| AlertSuppressionLevel | AlertSuppressionLevel | No | Indicates the suppression level during this alert suppression window |
| Targets | IdentifiableObject[] | No | Target monitored objects to which the window will be applied to |
| Days | System.DayOfWeek[] | No | Days in which the weekly alert suppression window will be active |
WindowsMachine
Class
Inherits from: MonitoredObject
| Member Name | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | |
| IsMonitored | Boolean | No | True if this entity is currently being successfully monitored. |
| Status | String | No | The success or error state for monitoring of this entity. |
| ConfigurationState | String | No | The configured state of this entity. |
| BaseMonitor | BaseMonitor | No | |
| Group | Group | No |
AbsoluteOrPercentAlertSettingsMode
Enum
Enumeration containing possible modes for the AbsoluteOrPercentAlertSettings object.
- Percentage = 1 - Indicates that the corresponding threshold value is a percentage
- Absolute - Indicates that the corresponding threshold value is an absolute value
AlertConfigurationMode
Enum
Selects between Simple and Advanced configuration of the Database Permissions Changes alert.
- Simple = 0 - Raises every database permission change at a single severity
- Advanced = 1 - Raises alerts only when a permission change matches one of the configured rules; unmatched changes do not raise an alert.
AlertStatus
Enum
- Inherited - Inherited alert status from the parent
- Customized - Customized alert status
- Disabled - Disabled alert status
AlertSuppressionAlertTypeGroupToSuppress
Enum
- PerformanceRelatedAlertsAndCustomAlerts = 0
- AllAlerts = 1
AlertSuppressionLevel
Enum
- NotificationsOnly = 0
- AlertsAndNotifications = 1
AlertSuppressionScheduleFrequency
Enum
- NonRecurring = 0
- Weekly
- Monthly
AlertSuppressionScheduleSetPosition
Enum
- Last = -1
- First = 1
- Second = 2
- Third = 3
- Fourth = 4
AzureApiAuthenticationMode
Enum
- ManagedIdentity
- ServicePrincipal
CloudProvider
Enum
- Azure
- AWS
DatabaseEngineDto
Enum
Enumeration containing database engines.
- SqlServer
- Postgres
DatabaseFileUsageAlertSettingsMode
Enum
Enumeration containing possible modes for the DatabaseFileUsageAlertSettings object.
- PercentFull = 1 - 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
DatabaseLogFileUsageAlertSettingsMode
Enum
Enumeration containing possible modes for the DatabaseLogFileUsageAlertSettings object.
- PercentFull = 1
- BytesRemaining
DatabasePermissionChangeAction
Enum
Enumeration of the SQL permission actions that can be matched by a Database Permissions Changes rule.
- Any - Matches any permission action.
- Grant - Matches GRANT permission changes.
- Revoke - Matches REVOKE permission changes.
- Deny - Matches DENY permission changes.
- TakeOwnership - Matches TAKE OWNERSHIP permission changes.
EmailNotificationOption
Enum
Enumeration containing all the email notification options that can be specified.
- DontEmail - Do not send a notification email
- SendToDefault - Send email notifications to the default recipients
- SendToCustom - Send email notifications to the specific recipients
LoginFailureDetectionScope
Enum
Selects whether the Repeated Login Failures alert groups failure counts per login, or aggregates them across every login on the instance.
- PerLogin = 0
- AllLogins = 1
MonitoredIamObjectType
Enum
- MicrosoftEntraId
- ActiveDirectoryDomain
MonitoredObjectType
Enum
Enumeration containing all monitored object types that can be specified.
- AmazonRdsHost
- Cluster
- Machine
- SqlServerInstance
- AzureSqlServer
- AzureManagedInstance
- PostgresInstance
- AmazonAuroraCluster
- AzureFlexHost
- GoogleCloudHost
- WindowsMachine
OverrideSeverityDto
Enum
Enumeration containing severity levels for overrides, including None to suppress alerting.
- None = 0 - An alert will not be raised.
- Low = 1 - A low level alert level.
- Medium - A medium level alert level.
- High - A high level alert level.
ServiceState
Enum
- Stopped = 1
- Paused = 2
- Started = 4
- StoppedOrPaused = 1 -bor 2 - bitwise combination of Stopped and Paused
- StartedOrPaused = 2 -bor 4 - bitwise combination of Started and Paused
SeverityDto
Enum
Enumeration containing alert levels.
- Low = 1
- Medium
- High
SqlServerObjectType
Enum
Represents a SQL Server database-scoped securable type.
- Aggregate
- ApplicationRole
- Assembly
- AsymmetricKey
- Certificate
- Contract
- Database
- DatabaseScopedCredential
- ExternalLanguage
- ExternalLibrary
- ExternalModel
- FulltextCatalog
- FulltextStoplist
- Function
- MessageType
- Object
- Queue
- RemoteServiceBinding
- Role
- Route
- Schema
- SearchPropertyList
- Sequence
- Service
- StoredProcedure
- SymmetricKey
- Synonym
- Table
- Type
- User
- View
- XmlSchemaCollection
This documentation contains proprietary information and is protected by copyright law.
Copyright © 2026 Red Gate Software Limited. All rights reserved
