Remove-DbaAgentAlert

Want to see the source code for this command? Check out Remove-DbaAgentAlert on GitHub.
Want to see the Bill Of Health for this command? Check out Remove-DbaAgentAlert.

Synopsis

Removes SQL Agent agent alert(s).

Description

Removes the SQL Agent alert(s) that have passed through the pipeline.
If not used with a pipeline, Get-DbaAgentAlert will be executed with the parameters provided
and the returned SQL Agent alert(s) will be removed.

Syntax

Remove-DbaAgentAlert
    [-SqlInstance] <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    [-Alert <String[]>]
    [-ExcludeAlert <String[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-DbaAgentAlert -InputObject <Alert[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Remove-DbaAgentAlert -SqlInstance localhost, localhost\namedinstance

Removes all SQL Agent alerts on the localhost, localhost\namedinstance instances.

Example: 2

PS C:\> Remove-DbaAgentAlert -SqlInstance localhost -Alert MyDatabaseAlert

Removes MyDatabaseAlert SQL Agent alert on the localhost.

Example: 3

PS C:\> Get-DbaAgentAlert -SqlInstance SRV1 | Out-GridView -Title 'Select SQL Agent alert(s) to drop' -OutputMode Multiple | Remove-DbaAgentAlert

Using a pipeline this command gets all SQL Agent alerts on SRV1, lets the user select those to remove and then removes the selected SQL Agent alerts.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

-InputObject

Allows piping from Get-DbaAgentAlert.

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Alert

Specifies one or more SQL Agent alert(s) to delete. If unspecified, all accounts will be removed.

-ExcludeAlert

Specifies one or more SQL Agent alert(s) to exclude.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

-Confirm

Prompts you for confirmation before executing any changing operations within the command.
This is the default. Use -Confirm:$false to suppress these prompts.