These pages cover SQL Monitor 13, which is not the latest version. Help for other versions is also available.
Get-SqlMonitorGroup
Published 14 February 2023
Gets a Group from a path of group names.
Syntax
- Get-SqlMonitorGroup [-Path] <string[]> [[-BaseMonitor] <BaseMonitor>] [[-Strict] <bool>] [<CommonParameters>]
Description
The Get-SqlMonitorGroup cmdlet gets details of Groups from the SQL Monitor Server.
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-Path
<String[]>
The path of group names.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-BaseMonitor
<BaseMonitor>
The Base Monitor name to get group from.
| Aliases | None |
| Required? | false |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Strict
<Boolean>
{{ Fill Strict Description }}
| Aliases | None |
| Required? | false |
| Position? | 3 |
| Default Value | False |
| 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.
-
[Group] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Group.
Examples
-------------------------- EXAMPLE 1 --------------------------
- Get-SqlMonitorGroup -Path 'Production', 'Accounting'
-------------------------- EXAMPLE 2 --------------------------
- Get-SqlMonitorGroup -Path 'Production', 'Accounting' -BaseMonitor $BaseMonitor
