Get-SqlMonitorAlertSettings
Published 14 February 2023
Gets the alert settings for a specific monitored object and alert type.
Syntax
Get-SqlMonitorAlertSettings [-MonitoredObject] <TraversableObject> [-AlertType] <int> [<CommonParameters>]
Description
Gets the alert settings for a specific monitored object and alert type.
Parameters
  
    -MonitoredObject
    <TraversableObject>
  
The object to be configured (e.g. cluster, disk, database etc).
| Aliases | None | 
| Required? | true | 
| Position? | 1 | 
| Default Value | None | 
| Accept Pipeline Input | False | 
| Accept Wildcard Characters | false | 
  
    -AlertType
    <Int32>
  
The id of the alert type. Predefined ids are accessible through global alert type variables, $AlertType, $AgAlertTypes, $AzureSqlDatabaseAlertTypes, $AzureSqlServerAlertTypes, $ClusterAlertTypes, $ClusterMachineAlertTypes, $DatabaseAlertTypes, $DiskAlertTypes, $ElasticPoolAlertTypes, $InstanceAlertTypes, $JobAlertTypes and $StandaloneMachineAlertTypes.
| Aliases | None | 
| Required? | true | 
| Position? | 2 | 
| Default Value | 0 | 
| Accept Pipeline Input | False | 
| Accept Wildcard Characters | false | 
  
    -ProgressAction
    <ActionPreference>
  
{{ Fill ProgressAction Description }}
| Aliases | None | 
| Required? | false | 
| Position? | named | 
| Default Value | None | 
| Accept Pipeline Input | False | 
| Accept Wildcard Characters | false | 
  <CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- 
    None.
    
 You cannot pipe input to this cmdlet.
Return values
The output type is the type of the objects that the cmdlet emits.
- 
    [AlertSettings] See https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-AlertSettings
    
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorAlertSettings -MonitoredObject $cluster -AlertType $ClusterAlertTypes.SqlServerUnreachable