• [アーティクル]

sysmail_update_profile_sp (Transact-SQL)

データベース メール プロファイルの説明または名前を変更します。

トピック リンク アイコンTransact-SQL 構文表記規則

構文

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 でない場合、このプロシージャを実行するときには名前に 3 つの要素を指定する必要があります。

権限

このプロシージャの実行権限は、既定では sysadmin 固定サーバー ロールのメンバーに与えられています。

例

A. プロファイルの説明を変更する

次の例では、msdb データベースの AdventureWorks2008R2 Administrator というプロファイルの説明を変更します。

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

B. プロファイルの名前と説明を変更する

次の例では、プロファイル ID 750 のプロファイルの説明を変更します。

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