Remove-RedgateMonitorMonitoredObject
Published 18 April 2024
Removes the given monitored object from Redgate Monitor.
Syntax
- Remove-RedgateMonitorMonitoredObject [-MonitoredObject] <MonitoredObject[]> [-DeleteData] [<CommonParameters>]
Description
The Remove-RedgateMonitorMonitoredObject cmdlet removes the given monitored object from a Redgate Monitor Server.
Connect-RedgateMonitor must be called before this cmdlet.
Parameters
-MonitoredObject
<MonitoredObject[]>
The Monitored Object to remove. For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-MonitoredObject.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-DeleteData
<SwitchParameter>
The switch to determine whether to delete data associated this object from the database.
| Aliases | None |
| Required? | false |
| Position? | named |
| 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.
-
[MonitoredObject] For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-MonitoredObject.
Examples
-------------------------- EXAMPLE 1 --------------------------
- Get-RedgateMonitorMonitoredObject -Type Cluster -Name 'exampleserver.mydomain.com' | Remove-RedgateMonitorMonitoredObject
-------------------------- EXAMPLE 2 --------------------------
- Remove-RedgateMonitorMonitoredObject -MonitoredObject $monitoredObject
-------------------------- EXAMPLE 3 --------------------------
- Remove-RedgateMonitorMonitoredObject -MonitoredObject $monitoredObject -DeleteData
