Get-SqlMonitorADPrincipal
Published 14 February 2023
Gets AD Principals from all base monitors. This is deprecated and will be removed from next major release, use Get-SqlMonitorPrincipal instead.
Syntax
Get-SqlMonitorADPrincipal [[-BaseMonitors] <BaseMonitor[]>] [[-Name] <string>] [<CommonParameters>]
Description
The Get-SqlMonitorADPrincipal cmdlet gets details of AD Principals from the SQL Monitor Server.
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-BaseMonitors
<BaseMonitor[]>
The Base Monitors to get AD Principals from. For more information, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Name
<String>
The Name of the AD Principal.
| 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.
-
None.
You cannot pipe input to this cmdlet.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[ADPrincipal[]] Details of AD Principals found
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorADPrincipal -Name "test.user@example.com"
