sp_update_alert (Transact-SQL)
適用対象: SQL Server
既存のアラートの設定を更新します。
構文
sp_update_alert
[ @name = ] N'name'
[ , [ @new_name = ] N'new_name' ]
[ , [ @enabled = ] enabled ]
[ , [ @message_id = ] message_id ]
[ , [ @severity = ] severity ]
[ , [ @delay_between_responses = ] delay_between_responses ]
[ , [ @notification_message = ] N'notification_message' ]
[ , [ @include_event_description_in = ] include_event_description_in ]
[ , [ @database_name = ] N'database_name' ]
[ , [ @event_description_keyword = ] N'event_description_keyword' ]
[ , [ @job_id = ] 'job_id' ]
[ , [ @job_name = ] N'job_name' ]
[ , [ @occurrence_count = ] occurrence_count ]
[ , [ @count_reset_date = ] count_reset_date ]
[ , [ @count_reset_time = ] count_reset_time ]
[ , [ @last_occurrence_date = ] last_occurrence_date ]
[ , [ @last_occurrence_time = ] last_occurrence_time ]
[ , [ @last_response_date = ] last_response_date ]
[ , [ @last_response_time = ] last_response_time ]
[ , [ @raise_snmp_trap = ] raise_snmp_trap ]
[ , [ @performance_condition = ] N'performance_condition' ]
[ , [ @category_name = ] N'category_name' ]
[ , [ @wmi_namespace = ] N'wmi_namespace' ]
[ , [ @wmi_query = ] N'wmi_query' ]
[ ; ]
引数
[ @name = ] N'name'
更新する警告の名前を指定します。 @name は sysname で、既定値はありません。
[ @new_name = ] N'new_name'
アラートの新しい名前。 名前は一意である必要があります。 @new_name は sysname で、既定値は NULL
です。
[ @enabled = ] enabled
アラートを有効 (1
) にするか、有効にしないかを指定します (0
)。 @enabled は tinyint で、既定値は NULL
です。 アラートを起動するには、有効にする必要があります。
[ @message_id = ] message_id
警告定義のための新しいメッセージまたはエラー番号を指定します。 通常、 message_id は、 sysmessages テーブル内のエラー番号に対応します。 @message_id は int で、既定値は NULL
です。 メッセージ ID は、アラートの重大度レベルの設定が 0
場合にのみ使用できます。
[ @severity = ] severity
アラート定義の新しい重大度レベル ( 1
から 25
まで)。 指定された重大度の Windows アプリケーション ログに送信された SQL Server メッセージは、アラートをアクティブにします。 @severity は int で、既定値は NULL
です。 重大度レベルは、アラートのメッセージ ID 設定が 0
場合にのみ使用できます。
[ @delay_between_responses = ] delay_between_responses
警告に対する 1 つの応答から次の応答までの、新しい待機時間を秒単位で指定します。 @delay_between_responses は int で、既定値は NULL
です。
[ @notification_message = ] N'notification_message'
電子メール、 net send、またはポケットベル通知の一部としてオペレーターに送信された追加メッセージの変更されたテキスト。 @notification_message は nvarchar(512) で、既定値は NULL
です。
[ @include_event_description_in = ] include_event_description_in
Windows アプリケーション ログからの SQL Server エラーの説明を通知メッセージに含めるかどうかを指定します。 @include_event_description_in は tinyint であり、これらの値の 1 つ以上を指定できます。
値 | 説明 |
---|---|
0 |
なし |
1 |
電子メール |
2 |
ポケットベル |
4 |
net send |
7 |
すべて |
[ @database_name = ] N'database_name'
警告に関連するデータベースの名前を指定します。警告を発するには、このデータベースでエラーが発生する必要があります。 @database_name は sysname で、既定値は NULL
です。 角かっこ ([]
) で囲まれた名前は使用できません。
[ @event_description_keyword = ] N'event_description_keyword'
エラー メッセージ ログの SQL Server エラーの説明に含まれている必要がある一連の文字。 @event_description_keyword は nvarchar(100)で、既定値は NULL
です。 このパラメーターは、オブジェクト名 (たとえば、 customer_table
) をフィルター処理する場合に便利です。
Note
Transact-SQL LIKE
式のパターンマッチング文字は使用できません。
[ @job_id = ] 'job_id'
@job_id は uniqueidentifier で、既定値は NULL
です。
[ @job_name = ] N'job_name'
ジョブ ID 番号。 @job_name は sysname で、既定値は NULL
です。 job_idを指定する場合は、job_nameを省略する必要があります。
[ @occurrence_count = ] occurrence_count
警告が発生した回数をリセットします。 @occurrence_count は int で、既定値は NULL
で、 0
にのみ設定できます。
[ @count_reset_date = ] count_reset_date
発生回数が最後にリセットされた日付をリセットします。 @count_reset_date は int で、既定値は NULL
です。
[ @count_reset_time = ] count_reset_time
発生回数が最後にリセットされた時刻をリセットします。 @count_reset_time は int で、既定値は NULL
です。
[ @last_occurrence_date = ] last_occurrence_date
アラートが最後に発生した日付をリセットします。 @last_occurrence_date は int で、既定値は NULL
で、 0
にのみ設定できます。
[ @last_occurrence_time = ] last_occurrence_time
警告が最後に発生した時刻をリセットします。 @last_occurrence_time は int で、既定値は NULL
で、 0
にのみ設定できます。
[ @last_response_date = ] last_response_date
SQLServerAgent サービスが最後に警告に応答した日付をリセットします。 @last_response_date は int で、既定値は NULL
で、 0
にのみ設定できます。
[ @last_response_time = ] last_response_time
SQLServerAgent サービスが最後に警告に応答した時刻をリセットします。 @last_response_time は int で、既定値は NULL
で、 0
にのみ設定できます。
[ @raise_snmp_trap = ] raise_snmp_trap
単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。
[ @performance_condition = ] N'performance_condition'
<itemcomparatorvalue>
形式で表される値。 @performance_condition は nvarchar(512)であり、次の要素で構成されます。
Format 要素 | 説明 |
---|---|
品目 | パフォーマンス オブジェクト、パフォーマンス カウンター、またはカウンターの名前付きインスタンス。 |
コンパレータ | これらの演算子の 1 つ: > 、 < 、 = |
Value | カウンターの数値 |
[ @category_name = ] N'category_name'
アラート カテゴリの名前。 @category_name は sysname で、既定値は NULL
です。
[ @wmi_namespace = ] N'wmi_namespace'
イベントのクエリを実行する WMI 名前空間。 @wmi_namespace は sysname で、既定値は NULL
です。
[ @wmi_query = ] N'wmi_query'
アラートの WMI イベントを指定するクエリ。 @wmi_query は nvarchar(512) で、既定値は NULL
です。
リターン コードの値
0
(成功) または 1
(失敗)。
解説
アラートを生成できるのは、Windows アプリケーション ログに書き込まれた sysmessages
だけです。
sp_update_alert
では、パラメーター値が指定されているアラート設定のみが変更されます。 パラメーターを省略すると、現在の設定は保持されます。
アクセス許可
このストアド プロシージャを実行するには、固定サーバー ロール sysadmin のメンバーである必要があります。
例
次の例では、警告が有効になっている Test Alert
の設定を 0
(無効) に変更します。
USE msdb;
GO
EXEC dbo.sp_update_alert
@name = N'Test Alert',
@enabled = 0;
GO