Update-RedgateMonitorMonitoredObject
Published 18 April 2024
Updates the given monitored object.
Syntax
Update-RedgateMonitorMonitoredObject [-MonitoredObject] <MonitoredObject> [<CommonParameters>]
Description
The Update-RedgateMonitorMonitoredObject cmdlet updates Amazon RDS SQL Server and PostgreSQL, Amazon Aurora Clusters, Azure SQL Servers, Azure SQL Databases, Azure Managed Instances, Cluster instances, PostgreSQL instances, Machine instances, and SQL Server on Linux instances. This currently only works for updating the Alias and Group on the objects mentioned above, and some objects may only have an Alias or Group rather than both.
Parameters
-MonitoredObject
<MonitoredObject>
{{ Fill MonitoredObject Description }}
Aliases | None |
Required? | true |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | True (ByValue) |
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 --------------------------
$instance = Get-RedgateMonitorMonitoredObject -Type AmazonRdsSqlServer -BaseMonitor $baseMonitor -Name "ExampleAmazonRdsSqlServer" $instance.Alias = "My favourite RDS server" $instance | Update-RedgateMonitorMonitoredObject
This script will get an Amazon RDS SQL Server "ExampleAmazonRdsSqlServer" from the specified base monitor and edit its alias.