Get-SqlMonitorAlertSuppressionWindow
Published 14 February 2023
Gets the current alert suppression windows.
Syntax
Get-SqlMonitorAlertSuppressionWindow [[-BaseMonitor] <BaseMonitor>] [[-Name] <string>] [<CommonParameters>]
Description
Gets the current alert suppression window for a specified [BaseMonitor] or for all base monitors.
Parameters
  
    -BaseMonitor
    <BaseMonitor>
  
Only windows from the given base monitor will be returned, if not provided all windows will be returned.
| Aliases | None | 
| Required? | false | 
| Position? | 1 | 
| Default Value | None | 
| Accept Pipeline Input | True (ByValue) | 
| Accept Wildcard Characters | false | 
  
    -Name
    <String>
  
Name of the desired window. It might return multiple items with the same name from different base monitors.
| Aliases | None | 
| Required? | false | 
| Position? | 2 | 
| Default Value | None | 
| 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.
- 
    [BaseMonitor] See Get-SqlMonitorBaseMonitor.
    
Return values
The output type is the type of the objects that the cmdlet emits.
- 
    [AlertSuppressionWindow]
    
Examples
-------------------------- EXAMPLE 1 --------------------------
# Retrieve all alert suppression windows across all base monitors. $windows = Get-AlertSuppressionWindow
-------------------------- EXAMPLE 2 --------------------------
# Retrieve one or more named windows with the given name from all base monitors. $windows = Get-AlertSuppressionWindow -Name 'Weekend maintenance'
-------------------------- EXAMPLE 3 --------------------------
# Retrieve a single named window from a base monitor. $baseMonitor = Get-SqlMonitorBaseMonitor -Name 'us2.server' $weekendWindow = $baseMonitor | Get-AlertSuppressionWindow -Name 'Weekend maintenance'