Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.94 KB

sp-drop-agent-parameter-transact-sql.md

File metadata and controls

62 lines (44 loc) · 1.94 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
sp_drop_agent_parameter (Transact-SQL)
sp_drop_agent_parameter drops one or all parameters from a profile in the MSagent_parameters table.
markingmyname
maghan
randolphwest
11/28/2023
sql
replication
reference
sp_drop_agent_parameter_TSQL
sp_drop_agent_parameter
sp_drop_agent_parameter
TSQL

sp_drop_agent_parameter (Transact-SQL)

[!INCLUDE SQL Server]

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.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

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

Arguments

[ @profile_id = ] profile_id

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

[ @parameter_name = ] N'parameter_name'

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.

Return code values

0 (success) or 1 (failure).

Remarks

sp_drop_agent_parameter is used in all types of replication.

Permissions

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

Related content