sysmail_update_profile_sp (Transact-SQL)
適用対象: SQL サーバー
データベース メール プロファイルの説明または名前を変更します。
構文
sysmail_update_profile_sp [ [ @profile_id = ] profile_id , ] [ [ @profile_name = ] 'profile_name' , ]
[ [ @description = ] 'description' ]
[ ; ]
引数
[ @profile_id = ] profile_id
更新するプロファイル ID。 @profile_id は int で、既定値は NULL
です。 少なくとも 1 つの @profile_id または @profile_name を指定する必要があります。 両方を指定すると、プロシージャによってプロファイルの名前が変更されます。
[ @profile_name = ] 'profile_name'
更新するプロファイルの名前、またはプロファイルの新しい名前。 @profile_name は sysname で、既定値は NULL
です。 少なくとも 1 つの @profile_id または @profile_name を指定する必要があります。 両方を指定すると、プロシージャによってプロファイルの名前が変更されます。
[ @description = ] '説明'
プロファイルの新しい説明。 @description は nvarchar(256) で、既定値は NULL
です。
リターン コードの値
0
(成功) または 1
(失敗)。
解説
プロファイル ID とプロファイル名の両方を指定すると、プロシージャはプロファイルの名前を指定された名前に変更し、プロファイルの説明を更新します。 これらの引数のいずれかが指定されている場合、プロシージャはプロファイルの説明を更新します。
ストアド プロシージャ sysmail_update_profile_sp
は msdb
データベースにあり、 dbo スキーマによって所有されます。 現在のデータベースが msdb
されていない場合は、プロシージャを 3 部構成の名前で実行する必要があります。
アクセス許可
このストアド プロシージャは、 db_owner ロールによって所有されています。 EXECUTE
アクセス許可は任意のユーザーに付与できますが、SQL Server のアップグレード中にこれらのアクセス許可がオーバーライドされる可能性があります。
例
A. プロファイルの説明を変更する
次の例では、msdb
データベースの AdventureWorks Administrator
という名前のプロファイルの説明を変更します。
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.';