Share via


sp_add_agent_parameter (Transact-SQL)

Se aplica a:SQL ServerAzure SQL Managed Instance

Agrega un nuevo parámetro y su valor al perfil de un agente. Este procedimiento almacenado se ejecuta en el distribuidor en cualquier base de datos.

Convenciones de sintaxis de Transact-SQL

Sintaxis

sp_add_agent_parameter [ @profile_id = ] profile_id
        , [ @parameter_name = ] 'parameter_name'
        , [ @parameter_value = ] 'parameter_value'
[ ; ]

Argumentos

[ @profile_id = ] profile_id

Identificador del perfil de la MSagent_profiles tabla de la msdb base de datos. @profile_id es int, sin valor predeterminado.

Para averiguar qué tipo de agente representa este @profile_id , busque el @profile_id en la tabla MSagent_profiles (Transact-SQL) y anote el valor del agent_type campo. Éstos son sus valores:

Value Descripción
1 Agente de instantáneas
2 Agente de registro del LOG
3 Agente de distribución
4 Agente de mezcla
9 Agente de lectura de cola

[ @parameter_name = ] 'parameter_name'

El nombre del parámetro. @parameter_name es sysname, sin ningún valor predeterminado. Para obtener una lista de los parámetros ya definidos en los perfiles del sistema, consulte Perfiles del agente de replicación. Para obtener una lista completa de parámetros válidos para cada agente, vea los siguientes temas:

[ @parameter_value = ] 'parameter_value'

Valor que se va a asignar al parámetro . @parameter_value es nvarchar(255), sin ningún valor predeterminado.

Valores de código de retorno

0 (correcto) o 1 (erróneo).

Comentarios

sp_add_agent_parameter se usa en la replicación de instantáneas, la replicación transaccional y la replicación de mezcla.

Permisos

Solo los miembros del rol fijo de servidor sysadmin pueden ejecutar sp_add_agent_parameter.