sysmail_update_profile_sp (Transact-SQL)

Article
08/20/2013

Modifie la description ou le nom d'un profil de messagerie de base de données.

Icône Lien de rubrique Conventions de la syntaxe Transact-SQL

Syntaxe

sysmail_update_profile_sp [ [ @profile_id = ] profile_id , ] [ [ @profile_name = ] 'profile_name' , ]
    [ [ @description = ] 'description' ]

Arguments

[ @profile_id = ] profile_id
Identificateur du profil à mettre à jour. profile_id est de type int, avec NULL comme valeur par défaut. Au moins un argument, profile_id ou profile_name, doit être spécifié. Si les deux arguments sont indiqués, la procédure modifie le nom du profil.
[ @profile_name = ] 'profile_name'
Nom du profil à mettre à jour ou nouveau nom pour le profil. profile_name est de type sysname, avec NULL comme valeur par défaut. Au moins un argument, profile_id ou profile_name, doit être spécifié. Si les deux arguments sont indiqués, la procédure modifie le nom du profil.
[ @description = ] 'description'
Nouvelle description du profil. description est de type nvarchar(256), avec NULL comme valeur par défaut.

Valeurs des codes de retour

0 (réussite) ou 1 (échec)

Notes

Lorsque l'identificateur et le nom du profil sont tous les deux spécifiés, la procédure remplace le nom du profil par celui qui est fourni et met à jour la description. Lorsqu'un seul de ces arguments est indiqué, la procédure met simplement à jour la description du profil.

La procédure stockée sysmail_update_profile_sp se trouve dans la base de données msdb et appartient au schéma dbo. Cette procédure doit être exécutée avec un nom en trois parties si la base de données active n'est pas msdb.

Autorisations

Les autorisations d'exécution de cette procédure sont accordées par défaut aux membres du rôle de serveur fixe sysadmin.

Exemples

A. Modification de la description d'un profil

L'exemple suivant modifie la description du profil appelé AdventureWorks Administrator dans la base de données msdb.

EXECUTE msdb.dbo.sysmail_update_profile_sp
    @profile_name = 'AdventureWorks Administrator'
    ,@description = 'Administrative mail profile.';

B. Modification du nom et de la description d'un profil

L'exemple suivant modifie le nom et la description du profil à l'aide de l'ID de profil 750.

EXECUTE msdb.dbo.sysmail_update_profile_sp
    @profile_id = 750
    ,@profile_name = 'Operator'
    ,@description = 'Profile to send alert e-mail to operators.';