sp_drop_agent_parameter (Transact-SQL)
Collapse the table of content
Expand the table of content

sp_drop_agent_parameter (Transact-SQL)

Applies To: SQL Server 2014, SQL Server 2016 Preview

Topic Status: Some information in this topic is preview and subject to change in future releases. Preview information describes new features or changes to existing features in Microsoft SQL Server 2016 Community Technology Preview 2 (CTP2).

Drops one or all parameters from a profile in the MSagent_parameters table. This stored procedure is executed at the Distributor where the agent is running, on any database.

Topic link icon Transact-SQL Syntax Conventions

sp_drop_agent_parameter [ @profile_id = ] profile_id
    [ , [ @parameter_name = ] 'parameter_name' ]

[ @profile_id=] profile_id

Is the ID of the profile for which a parameter is to be dropped. profile_id is int, with no default.

[ @parameter_name=] 'parameter_name'

Is the name of the parameter to be dropped. parameter_name is sysname, with a default of %. If %, all parameters for the specified profile are dropped.

0 (success) or 1 (failure)

sp_drop_agent_parameter is used in all types of replication.

Only members of the sysadmin fixed server role can execute sp_drop_agent_parameter.

Community Additions

© 2016 Microsoft