sysmail_update_profile_sp (Transact-SQL)
适用范围:SQL Server
更改数据库邮件配置文件的说明或名称。
语法
sysmail_update_profile_sp [ [ @profile_id = ] profile_id , ] [ [ @profile_name = ] 'profile_name' , ]
[ [ @description = ] 'description' ]
[ ; ]
参数
[ @profile_id = ] profile_id
要更新的配置文件 ID。 @profile_id为 int,默认值为 NULL
. 必须至少指定一个 @profile_id 或 @profile_name 。 如果同时指定二者,则过程将更改配置文件的名称。
[ @profile_name = ] 'profile_name'
要更新的配置文件名称或配置文件的新的名称。 @profile_name为 sysname,默认值为 NULL
. 必须至少指定一个 @profile_id 或 @profile_name 。 如果同时指定二者,则过程将更改配置文件的名称。
[ @description = ] 'description'
对配置文件的新的说明。 @description为 nvarchar(256),默认值为 NULL
.
返回代码值
0
(成功)或 1
(失败)。
注解
当同时指定配置文件 ID 和配置文件名称时,该过程会将配置文件的名称更改为提供的名称,并更新配置文件的说明。 当只提供其中的一个参数时,该过程会更新配置文件的说明。
存储过程 sysmail_update_profile_sp
位于 msdb
数据库中,由 dbo 架构拥有。 如果当前数据库不是 msdb
,则必须使用三部分名称执行该过程。
权限
可以授予 EXECUTE
此过程的权限,但在 SQL Server 升级期间可能会重写这些权限。
示例
A. 更改配置文件的说明
以下示例更改数据库中命名 AdventureWorks Administrator
的 msdb
配置文件的说明。
EXEC msdb.dbo.sysmail_update_profile_sp
@profile_name = 'AdventureWorks Administrator',
@description = 'Administrative mail profile.';
B. 更改配置文件的名称和说明
以下示例使用配置文件 ID 750
更改配置文件的名称和说明。
EXEC msdb.dbo.sysmail_update_profile_sp
@profile_id = 750,
@profile_name = 'Operator',
@description = 'Profile to send alert e-mail to operators.';