sp_change_agent_profile (Transact-SQL)
Applies to: SQL Server Azure SQL Managed Instance
Changes a parameter of a replication agent profile stored in the MSagent_profiles (Transact-SQL) table. This stored procedure is executed at the Distributor on any database.
Transact-SQL syntax conventions
Syntax
sp_change_agent_profile [ @profile_id = ] profile_id
, [ @property = ] 'property'
, [ @value = ] 'value'
Arguments
[ @profile_id = ] profile_id
Is the ID of the profile. profile_id is int, with no default.
[ @property = ] 'property'
Is the name of the property. property is sysname, with no default.
[ @value = ] 'value'
Is the new value of the property. value is nvarchar(3000), with no default.
This table describes the profile properties that can be changed.
Property | Description |
---|---|
description | Description for the profile. |
Return Code Values
0 (success) or 1 (failure)
Remarks
sp_change_agent_profile is used in all types of replication.
Permissions
Only members of the sysadmin fixed server role can execute sp_change_agent_profile.
See Also
sp_add_agent_profile (Transact-SQL)
sp_drop_agent_profile (Transact-SQL)
sp_help_agent_profile (Transact-SQL)
System Stored Procedures (Transact-SQL)
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for