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 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 = ] N'property'
, [ @value = ] N'value'
[ ; ]
Arguments
[ @profile_id = ] profile_id
The ID of the profile. @profile_id is int, with no default.
[ @property = ] N'property'
The name of the property. @property is sysname, with no default.
[ @value = ] N'value'
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
.