Get-RedgateMonitorMonitoredIamObject
Published 21 January 2025
Gets the details of all of the monitored objects in Redgate Monitor.
Syntax
- Get-RedgateMonitorMonitoredIamObject [-BaseMonitor <BaseMonitor>] [-Type <MonitoredIamObjectType>] [-Name <string>] [<CommonParameters>]
Description
The Get-RedgateMonitorMonitoredIamObject cmdlet gets details of Redgate Monitor Monitored objects from the Redgate Monitor Server.
Connect-RedgateMonitor must be called before this cmdlet.
Parameters
-BaseMonitor
<BaseMonitor>
The Base Monitor to limit results to.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Type
<MonitoredIamObjectType>
The type of IAM object to limit results to MicrosoftEntraId.
MicrosoftEntraId will return details of Microsoft EntraID
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Name
<String>
The name of a monitored object to match.
| Aliases | None |
| Required? | false |
| Position? | named |
| 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] For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-BaseMonitor.
-
[Type] For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-MonitoredIamObjectType.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[MicrosoftEntraId] For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-MicrosoftEntraId.
Examples
-------------------------- EXAMPLE 1 --------------------------
- Get-RedgateMonitorMonitoredIamObject
-------------------------- EXAMPLE 2 --------------------------
- Get-RedgateMonitorMonitoredIamObject -Type MicrosoftEntraId
-------------------------- EXAMPLE 3 --------------------------
- Get-RedgateMonitorMonitoredIamObject -BaseMonitor $baseMonitor
-------------------------- EXAMPLE 4 --------------------------
- Get-RedgateMonitorMonitoredIamObject -Name "ExampleName"
-------------------------- EXAMPLE 5 --------------------------
- Get-RedgateMonitorMonitoredIamObject -BaseMonitor $baseMonitor -Name "ExampleName" -Type MicrosoftEntraId
