These pages cover SQL Monitor 13, which is not the latest version. Help for other versions is also available.
Update-SqlMonitorAlertSettingsComment
Published 29 August 2023
Updates the comments of the alert configuration for a specific monitored object and alert type.
Syntax
- Update-SqlMonitorAlertSettingsComment [-MonitoredObject] <TraversableObject> [-AlertType] <int> [[-Comments] <string>] [<CommonParameters>]
Description
Updates the comments of the alert configuration for a specific monitored object and alert type.
Parameters
-MonitoredObject
<TraversableObject>
The object to be configured (e.g. cluster, disk, database etc)
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-AlertType
<Int32>
The id of the alert type. Predefined ids are accessible through global alert type variables, $AlertType, $AgAlertTypes, $AzureSqlDatabaseAlertTypes, $AzureSqlServerAlertTypes, $ClusterAlertTypes, $ClusterMachineAlertTypes, $DatabaseAlertTypes, $DiskAlertTypes, $ElasticPoolAlertTypes, $InstanceAlertTypes, $JobAlertTypes and $StandaloneMachineAlertTypes.
| Aliases | None |
| Required? | true |
| Position? | 2 |
| Default Value | 0 |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Comments
<String>
The comments for the alert.
| Aliases | None |
| Required? | false |
| Position? | 3 |
| 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.
Examples
-------------------------- EXAMPLE 1 --------------------------
- Update-SqlMonitorAlertSettingsComment -MonitoredObject $cluster -AlertType $ClusterAlertTypes.SqlServerUnreachable -Comments "..."
