sp_help_agent_parameter (Transact-SQL)
Applies to: SQL Server Azure SQL Managed Instance
Returns all the parameters of a profile from the MSagent_parameters system table. This stored procedure is executed at the Distributor where the agent is running, on any database.
Transact-SQL syntax conventions
Syntax
sp_help_agent_parameter [ [ @profile_id = ] profile_id ]
[ ; ]
Arguments
[ @profile_id = ] profile_id
The ID of the profile from the MSagent_parameters table. @profile_id is int, with a default of -1
, which returns all parameters.
Result set
Column name | Data type | Description |
---|---|---|
profile_id |
int | ID of the agent profile. |
parameter_name |
sysname | Name of the parameter. |
value |
nvarchar(255) | Value of the parameter. |
Return code values
0
(success) or 1
(failure).
Remarks
sp_help_agent_parameter
is used in all types of replication.
Permissions
Only members of the sysadmin fixed server role or the replmonitor fixed database role can execute sp_help_agent_parameter
.