These pages cover SQL Monitor 13, which is not the latest version. Help for other versions is also available.
Test-SqlMonitorGroupAccess
Published 14 February 2023
Tests if a principal has access to a given SQL Monitor Group.
Syntax
- Test-SqlMonitorGroupAccess [-Principal] <ADPrincipal> [-Group] <Group> [<CommonParameters>]
Description
The Test-SqlMonitorGroupAccess cmdlet checks the authorizations for a principal to work out if it has access to a Group.
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-Principal
<ADPrincipal>
The Name of the AD Principal to check access for.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Group
<Group>
The SQL Monitor Group to test access to.
| Aliases | None |
| Required? | true |
| 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.
-
None.
You cannot pipe input to this cmdlet.
Examples
-------------------------- EXAMPLE 1 --------------------------
- $Report = Test-SqlMonitorGroupAccess -Principal $Principal -Group $Group
