sp_add_agent_profile (Transact-SQL)

适用于: SQL Server Azure SQL 托管实例

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

Transact-SQL 语法约定

语法

sp_add_agent_profile [ [ @profile_id = ] profile_id OUTPUT ]
      , [ @profile_name = ] 'profile_name'
      , [ @agent_type = ] agent_type
    [ , [ @profile_type = ] profile_type ]
    [ , [ @description = ] N'description' ]
    [ , [ @default = ] default ]

参数

[ @profile_id = ] profile_id

与新插入的配置文件关联的 ID。 @profile_idint ,是可选的 OUTPUT 参数。 如果指定该 ID,则值将设置为新的配置文件 ID。

[ @profile_name = ] 'profile_name'

配置文件的名称。 @profile_namesysname,无默认值。

[ @agent_type = ] agent_type

复制代理的类型。 @agent_type为 int,没有默认值,可以是其中一个值。

说明
1 快照代理
2 日志读取器代理
3 分发代理
4 合并代理
9 队列读取器代理

[ @profile_type = ] profile_type

配置文件的类型。profile_type为 int,默认值为 1.

0 指示系统配置文件。 1 指示自定义配置文件。 只能使用此存储过程创建自定义配置文件;因此,唯一的有效值为 1. 只有 SQL Server 创建系统配置文件。

[ @description = ] N'description'

关于配置文件的说明。 @description为 nvarchar(3000),没有默认值。

[ @default = ] default

指示配置文件是否为@agent_type的默认配置文件。 @default为,默认值为 0. 1指示所添加的配置文件将成为由@agent_type指定的代理的新默认配置文件。

返回代码值

0(成功)或 1(失败)。

注解

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

自定义代理配置文件与默认代理参数值一起添加。 使用 sp_change_agent_parameter 更改这些默认值或 sp_add_agent_parameter 添加其他参数。

执行时sp_add_agent_profile,将为MSagent_profiles表中的新自定义配置文件添加一行,并将此配置文件的关联默认参数添加到MSagent_parameters表中。

权限

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