sp_add_agent_parameter (Transact-SQL)sp_add_agent_parameter (Transact-SQL)

S’APPLIQUE À : ouiSQL Server ouiAzure SQL Database (Managed Instance uniquement) nonAzure SQL Data Warehouse nonParallel Data Warehouse APPLIES TO: yesSQL Server yesAzure SQL Database (Managed Instance only) noAzure SQL Data Warehouse noParallel Data Warehouse

Ajoute un nouveau paramètre et sa valeur au profil d'un agent.Adds a new parameter and its value to an agent profile. Cette procédure stockée est exécutée sur n’importe quelle base de données du serveur de distribution.This stored procedure is executed at the Distributor on any database.

Icône de lien de rubrique Conventions de la syntaxe Transact-SQLTopic link icon Transact-SQL Syntax Conventions

SyntaxeSyntax

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

ArgumentsArguments

[ @profile_id = ] profile_idID du profil de la table MSagent_profiles dans la base de données msdb .[ @profile_id = ] profile_id Is the ID of the profile from the MSagent_profiles table in the msdb database. l’option par défaut est de type int, sans valeur par défaut.profile_id is int, with no default.

Pour déterminer le type d’agent représenté par l’élément de la table, recherchez le type d’agent dans le tableau Transact-SQL () de MSagent_profiles , puis notez la valeur du champ agent_type .To find out what agent type this profile_id represents, find the profile_id in the MSagent_profiles (Transact-SQL) table, and note the agent_type field value. Les valeurs sont les suivantes :The values are as follows:

ValueValue DescriptionDescription
11 Agent d'instantanéSnapshot Agent
22 l'Agent de lecture du journal ;Log Reader Agent
33 Agent de distributionDistribution Agent
44 Agent de fusionMerge Agent
99 Agent de lecture de la file d'attenteQueue Reader Agent

[ @parameter_name = ] 'parameter_name'Nom du paramètre.[ @parameter_name = ] 'parameter_name' Is the name of the parameter. nom_de_paramètre est de type sysname, sans valeur par défaut.parameter_name is sysname, with no default. Pour obtenir la liste des paramètres déjà définis dans les profils système, consultez Replication Agent Profiles.For a list of parameters already defined in system profiles, see Replication Agent Profiles. Pour obtenir la liste complète des paramètres valides pour chaque agent, consultez les rubriques suivantes :For a complete list of valid parameters for each agent, see the following topics:

[ @parameter_value = ] 'parameter_value'Valeur à assigner au paramètre.[ @parameter_value = ] 'parameter_value' Is the value to be assigned to the parameter. parameter_value est de type nvarchar (255) , sans valeur par défaut.parameter_value is nvarchar(255), with no default.

Valeurs des codes de retourReturn Code Values

0 (succès) ou 1 (échec)0 (success) or 1 (failure)

NotesRemarks

sp_add_agent_parameter est utilisé dans la réplication d’instantané, la réplication transactionnelle et la réplication de fusion.sp_add_agent_parameter is used in snapshot replication, transactional replication, and merge replication.

AutorisationsPermissions

Seuls les membres du rôle serveur fixe sysadmin peuvent exécuter sp_add_agent_parameter.Only members of the sysadmin fixed server role can execute sp_add_agent_parameter.

Voir aussiSee Also

Utiliser des profils d’Agent de réplication Work with Replication Agent Profiles
Profils de l’Agent de réplication Replication Agent Profiles
sp_add_agent_profile (Transact-SQL) sp_add_agent_profile (Transact-SQL)
sp_change_agent_profile (Transact-SQL) sp_change_agent_profile (Transact-SQL)
sp_change_agent_parameter (Transact-SQL) sp_change_agent_parameter (Transact-SQL)
sp_drop_agent_parameter (Transact-SQL) sp_drop_agent_parameter (Transact-SQL)
sp_help_agent_parameter (Transact-SQL)sp_help_agent_parameter (Transact-SQL)