为复制代理程序创建新配置文件。此存储过程在分发服务器的任何数据库上执行。

语法

sp_add_agent_profile [ [ @profile_id = ] profile_id OUTPUT ]

    { , [ @profile_name = ] 'profile_name' [ , [ @agent_type = ] 'agent_type' ] }

    [ , [ @profile_type = ] profile_type ]

    , [ @description = ] 'description'

    [ , [ @default = ] default ]

参数

[@profile_id = ] profile_id

是与新插入的配置关联的 ID。profile_id 的数据类型为 int，并且是可选 OUTPUT 参数。如果已指定，则该值将设置为新配置 ID。

[ @profile_name = ] 'profile_name'

是配置文件名。profile_name 的数据类型为 sysname，没有默认设置。

[ @agent_type = ] 'agent_type'

是复制代理程序的类型。agent_type 的数据类型为 int，没有默认设置，可以是下列值之一。

[ @profile_type = ] profile_type

是配置的类型。profile_type 的数据类型为 int，默认设置为 1。0 表示系统配置。1 表示自定义配置。使用此存储过程只能创建自定义配置文件。只有 SQL Server 能创建系统配置文件。

[@description = ] 'description'

是对配置的描述。description 的数据类型为 nvarchar(3000)，没有默认设置。

[ @default = ] default

表示配置是否是 agent_type 的默认设置。default 的数据类型为 bit，默认设置为 0。0 表示配置不是默认设置。1 表示正添加的配置文件将成为 @agent_type 参数所指定的代理程序的新默认配置文件。

返回代码值

0（成功）或 1（失败）

注释

sp_add_agent_profile 用于快照复制、事务复制和合并复制。

在 MSagent_profiles 表中为配置添加行。

权限

只有 sysadmin 固定服务器角色成员才能执行 sp_add_agent_profile。