Skip to content

Remove‑SqlDscAgentAlert

dscbot edited this page Aug 25, 2025 · 1 revision

SYNOPSIS

Removes a SQL Agent Alert.

SYNTAX

ServerObject

Remove-SqlDscAgentAlert -ServerObject <Server> -Name <String> [-Force] [-Refresh]
 [-WhatIf] [-Confirm] [<CommonParameters>]

AlertObject

Remove-SqlDscAgentAlert -AlertObject <Alert> [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

This command removes a SQL Agent Alert from a SQL Server Database Engine instance.

EXAMPLES

EXAMPLE 1

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$alertObject = $serverObject | Get-SqlDscAgentAlert -Name 'MyAlert'
$alertObject | Remove-SqlDscAgentAlert

Removes the alert named MyAlert.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$serverObject | Remove-SqlDscAgentAlert -Name 'MyAlert'

Removes the alert named MyAlert.

EXAMPLE 3

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$serverObject | Remove-SqlDscAgentAlert -Name 'MyAlert' -Force

Removes the alert named MyAlert without confirmation.

PARAMETERS

-AlertObject

Specifies an alert object to remove.

Type: Alert
Parameter Sets: AlertObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

Specifies that the alert should be removed without any confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the SQL Agent Alert to remove.

Type: String
Parameter Sets: ServerObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Refresh

Specifies that the ServerObject's alerts should be refreshed before trying to remove the alert object. This is helpful when alerts could have been modified outside of the ServerObject, for example through T-SQL.

Type: SwitchParameter
Parameter Sets: ServerObject
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ServerObject

Specifies current server connection object.

Type: Server
Parameter Sets: ServerObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.SqlServer.Management.Smo.Server

SQL Server Database Engine instance object.

Microsoft.SqlServer.Management.Smo.Agent.Alert

SQL Agent Alert object to remove.

OUTPUTS

None.

NOTES

RELATED LINKS

Home

Commands

Resources

Usage

Clone this wiki locally