These pages cover SQL Monitor 12, which is not the latest version. Help for other versions is also available.
Get-SqlMonitorBaseMonitor
Published 21 October 2021
Gets the details of all of the base monitors in SQL Monitor.
Syntax
- Get-SqlMonitorBaseMonitor [[-Name] <string>] [<CommonParameters>]
Description
The Get-SqlMonitorBaseMonitor cmdlet gets details of Base Monitors from the SQL Monitor Server.
Without parameters, this cmdlet will get all Base Monitors from the SQL Monitor Server.
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-Name
<String>
The Base Monitor name to match.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| 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.
-
[BaseMonitor] For more information, see https://documentation.red-gate.com/sm/api/custom-types#CustomTypes-BaseMonitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
- Get-SqlMonitorBaseMonitor
-------------------------- EXAMPLE 2 --------------------------
- Get-SqlMonitorBaseMonitor -Name "ExampleBaseMonitor"
