commands

^

Remove-DbaAgentProxy

Author Mikey Bronowski (@MikeyBronowski), https://bronowski.it
Availability Windows, Linux, macOS

 

Synopsis

Removes SQL Agent agent proxy(s).

Description

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

Syntax

Remove-DbaAgentProxy
    [-SqlInstance <DbaInstanceParameter[]>]
    [-SqlCredential <PSCredential>]
    [-Proxy <String[]>]
    [-ExcludeProxy <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-DbaAgentProxy
    [-SqlInstance <DbaInstanceParameter[]>]
    [-SqlCredential <PSCredential>]
    [-Proxy <String[]>]
    [-ExcludeProxy <String[]>] -InputObject <ProxyAccount[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Remove-DbaAgentProxy -SqlInstance localhost, localhost\namedinstance

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

Example: 2
PS C:\> Remove-DbaAgentProxy -SqlInstance localhost -Proxy MyDatabaseProxy

Removes MyDatabaseProxy SQL Agent proxy on the localhost.

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

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

Required Parameters

-InputObject

Allows piping from Get-DbaAgentProxy.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value
-Proxy

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

Alias
Required False
Pipeline false
Default Value
-ExcludeProxy

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

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

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

Alias wi
Required False
Pipeline false
Default Value
-Confirm

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

Alias cf
Required False
Pipeline false
Default Value

 

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