sp_add_agent_parameter (Transact-SQL)

S’applique à : SQL Server Azure SQL Managed Instance

Ajoute un nouveau paramètre et sa valeur au profil d'un agent. Cette procédure stockée est exécutée sur le serveur de distribution sur n’importe quelle base de données.

Conventions de la syntaxe Transact-SQL

Syntaxe

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

Arguments

[ @profile_id = ] profile_id

ID du profil de la MSagent_profiles table dans la msdb base de données. @profile_id est int, sans valeur par défaut.

Pour savoir quel type d’agent cette @profile_id représente, recherchez la @profile_id dans la table MSagent_profiles , puis notez la valeur du agent_type champ. Les valeurs sont les suivantes :

Valeur Description
1 Agent d'instantané
2 l'Agent de lecture du journal ;
3 Agent de distribution
4 Agent de fusion
9 Agent de lecture de la file d'attente

[ @parameter_name = ] 'parameter_name'

Nom du paramètre. @parameter_name est sysname, sans valeur par défaut. Pour obtenir la liste des paramètres déjà définis dans les profils système, consultez Profils de l’agent de réplication. Pour obtenir la liste complète des paramètres valides pour chaque agent, consultez les rubriques suivantes :

[ @parameter_value = ] 'parameter_value'

Valeur à affecter au paramètre. @parameter_value est nvarchar(255), sans valeur par défaut.

Valeurs des codes de retour

0 (réussite) or 1 (échec).

Notes

sp_add_agent_parameter est utilisé dans la réplication d’instantanés, la réplication transactionnelle et la réplication de fusion.

autorisations

Seuls les membres du rôle serveur fixe sysadmin peuvent s’exécuter.sp_add_agent_parameter