sysmail_update_profile_sp (Transact-SQL)

Статья
06/18/2013

Изменяет описание или имя профиля компонента Database Mail.

Значок ссылки на раздел Синтаксические обозначения Transact-SQL

Синтаксис

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

Аргументы

[ @profile_id = ] profile_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 (неудачное завершение)

Замечания

Если одновременно указаны идентификатор и имя профиля, то процедура изменяет имя профиля на введенное и обновляет описание профиля. Если указан только один из этих аргументов, то процедура обновляет описание профиля.

Хранимая процедура sysmail_update_profile_sp находится в базе данных msdb и принадлежит схеме dbo. Если текущей базой данных является не msdb, процедуру следует выполнять с трехкомпонентным именем.

Разрешения

Разрешения на выполнение этой процедуры по умолчанию предоставляются членам предопределенной роли сервера sysadmin.

Примеры

А. Изменение описания профиля

В следующем примере изменяется описание профиля с именем AdventureWorks Administrator в базе данных msdb.

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

Б. Изменение имени и описания профиля

В следующем примере изменяется имя и описание профиля с идентификатором профиля 750.

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