SQL Monitor 13

Update-SqlMonitorMonitoredObject

Updates the given monitored object.

Syntax

Update-SqlMonitorMonitoredObject [-MonitoredObject] <MonitoredObject> [<CommonParameters>]

Description

The Update-SqlMonitorMonitoredObject cmdlet updates Amazon RDS SQL Servers, Azure SQL Servers, Azure SQL Databases, Azure Managed Instances, Cluster instances, Machine instances, and SQL Server on Linux instances. This currently only works for updating the Alias and Group on the objects mentioned above.

Parameters

-MonitoredObject <MonitoredObject>

Object to update. Use one of Get-SqlMonitorAmazonRdsSqlServer, Get-SqlMonitorAzureManagedInstance, or Get-SqlMonitorInstance to find the object you want to update. To update an AzureSqlDatabase, first retrieve the AzureSqlServer it belongs to by using Get-SqlMonitorAzureSqlServer. Then, use the Get-SqlMonitorDatabase cmdlet to retrieve the AzureSqlDatabases in this AzureSqlServer.

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-SqlMonitorAmazonRdsSqlServer -BaseMonitor $baseMonitor -Name "ExampleAmazonRdsSqlServer"
$instance.Alias = "My favourite RDS server"
$instance | Update-SqlMonitorMonitoredObject

This script will get an Amazon RDS SQL Server "ExampleAmazonRdsSqlServer" from the specified base monitor and edit its alias.


Do you have any feedback on this documentation?

Let us know at sqlmonitorfeedback@red-gate.com


Didn't find what you were looking for?