sp_update_alert (Transact-SQL)sp_update_alert (Transact-SQL)

適用対象: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

既存のアラートの設定を更新します。Updates the settings of an existing alert.

トピック リンク アイコン Transact-SQL 構文表記規則Topic link icon Transact-SQL Syntax Conventions

構文Syntax

  
sp_update_alert   
     [ @name =] 'name'   
     [ , [ @new_name =] 'new_name']   
     [ , [ @enabled =] enabled]   
     [ , [ @message_id =] message_id]   
     [ , [ @severity =] severity]   
     [ , [ @delay_between_responses =] delay_between_responses]   
     [ , [ @notification_message =] 'notification_message']   
     [ , [ @include_event_description_in =] include_event_description_in]   
     [ , [ @database_name =] 'database']   
     [ , [ @event_description_keyword =] 'event_description_keyword']   
     [ , [ @job_id =] job_id | [@job_name =] '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 =] 'performance_condition' ]   
     [ , [ @category_name =] 'category']  
     [ , [ @wmi_namespace = ] 'wmi_namespace' ]  
     [ , [ @wmi_query = ] 'wmi_query' ]  

引数Arguments

[ @name = ] 'name'更新する警告の名前を指定します。[ @name = ] 'name' The name of the alert that is to be updated. 名前sysname,、既定値はありません。name is sysname, with no default.

[ @new_name = ] 'new_name'警告の新しい名前。[ @new_name = ] 'new_name' A new name for the alert. 名前は一意である必要があります。The name must be unique. 新しい名前sysname,、既定値は NULL です。new_name is sysname, with a default of NULL.

[ @enabled = ] enabledアラートが有効 (1) か無効 (0) かを指定します。[ @enabled = ] enabled Specifies whether the alert is enabled (1) or not enabled (0). 有効になっているはtinyint,、既定値は NULL です。enabled is tinyint, with a default of NULL. 起動するには、アラートを有効にする必要があります。An alert must be enabled to fire.

[ @message_id = ] message_id警告定義の新しいメッセージまたはエラー番号。[ @message_id = ] message_id A new message or error number for the alert definition. 通常、 message_idsysmessagesテーブルのエラー番号に対応します。Typically, message_id corresponds to an error number in the sysmessages table. message_idint,、既定値は NULL です。message_id is int, with a default of NULL. メッセージ ID は、警告の重大度レベルの設定が0の場合にのみ使用できます。A message ID can be used only if the severity level setting for the alert is 0.

[ @severity = ] severity警告定義の新しい重大度レベル ( 1 ~ 25)。[ @severity = ] severity A new severity level (from 1 through 25) for the alert definition. Windows アプリケーションログに指定した重要度のメッセージが送信されると、アラートがアクティブ化されます。SQL ServerSQL Server MicrosoftMicrosoftAny MicrosoftMicrosoft SQL ServerSQL Server message sent to the Windows application log with the specified severity will activate the alert. 重大度int,、既定値は NULL です。severity is int, with a default of NULL. 重大度レベルは、警告のメッセージ ID 設定が0の場合にのみ使用できます。A severity level can be used only if the message ID setting for the alert is 0.

[ @delay_between_responses = ] delay_between_responses警告への応答の間の新しい待機時間 (秒単位)。[ @delay_between_responses = ] delay_between_responses The new waiting period, in seconds, between responses to the alert. delay_between_responsesint,、既定値は NULL です。delay_between_responses is int, with a default of NULL.

[ @notification_message = ] 'notification_message'電子メール、 net send、またはポケットベルによる通知の一部としてオペレーターに送信される追加メッセージの変更されたテキスト。[ @notification_message = ] 'notification_message' The revised text of an additional message sent to the operator as part of the e-mail, net send, or pager notification. このパラメーターnvarchar (512) ,、既定値は NULL です。notification_message is nvarchar(512), with a default of NULL.

[ @include_event_description_in = ] include_event_description_inWindows アプリケーションログからのSQL ServerSQL Serverエラーの説明を通知メッセージに含めるかどうかを指定します。[ @include_event_description_in = ] include_event_description_in Specifies whether the description of the SQL ServerSQL Server error from the Windows application log should be included in the notification message. include_event_description_intinyint,、既定値は NULL の場合、これらの値の1つ以上を指定できます。include_event_description_in is tinyint, with a default of NULL, and can be one or more of these values.

Value 説明Description
00 なしNone
11 [電子メール]E-mail
22 [ポケットベル]Pager
44 net sendnet send
77 AllAll

[ @database_name = ] 'database'警告を起動するためにエラーが発生する必要があるデータベースの名前。[ @database_name = ] 'database' The name of the database in which the error must occur for the alert to fire. データベースsysname です。database is sysname. 角かっこ ([]) で囲まれた名前は使用できません。Names that are enclosed in brackets ([ ]) are not allowed. 既定値は NULL です。The default value is NULL.

[ @event_description_keyword = ] 'event_description_keyword'エラーメッセージログのエラーの説明に含まれている文字のシーケンス。[ @event_description_keyword = ] 'event_description_keyword' A sequence of characters that must be found in the description of the error in the error message log. Transact-SQLTransact-SQLLIKE 式パターン一致文字を使用できます。LIKE expression pattern-matching characters can be used. event_description_keywordnvarchar (100) ,、既定値は NULL です。event_description_keyword is nvarchar(100), with a default of NULL. このパラメーターは、オブジェクト名 ( % customer_table% など) をフィルター処理する場合に便利です。This parameter is useful for filtering object names (for example, %customer_table%).

[ @job_id = ] job_idジョブの識別番号を指定します。[ @job_id = ] job_id The job identification number. job_iduniqueidentifier,、既定値は NULL です。job_id is uniqueidentifier, with a default of NULL. Job_idを指定する場合は、 job_nameを省略する必要があります。If job_id is specified, job_name must be omitted.

[ @job_name = ] 'job_name'この警告に応答して実行されるジョブの名前。[ @job_name = ] 'job_name' The name of the job that executes in response to this alert. job_namesysname,、既定値は NULL です。job_name is sysname, with a default of NULL. Job_nameを指定する場合は、 job_idを省略する必要があります。If job_name is specified, job_id must be omitted.

[ @occurrence_count = ] occurrence_countアラートが発生した回数をリセットします。[ @occurrence_count = ] occurrence_count Resets the number of times the alert has occurred. occurrence_countint,、既定値は NULL の場合にのみ設定できます0です。occurrence_count is int, with a default of NULL, and can be set only to 0.

[ @count_reset_date = ] count_reset_date発生回数が最後にリセットされた日付をリセットします。[ @count_reset_date = ] count_reset_date Resets the date the occurrence count was last reset. count_reset_dateint,、既定値は NULL です。count_reset_date is int, with a default of NULL.

[ @count_reset_time = ] count_reset_time発生回数が最後にリセットされた時刻をリセットします。[ @count_reset_time = ] count_reset_time Resets the time the occurrence count was last reset. count_reset_timeint,、既定値は NULL です。count_reset_time is int, with a default of NULL.

[ @last_occurrence_date = ] last_occurrence_date警告が最後に発生した日付をリセットします。[ @last_occurrence_date = ] last_occurrence_date Resets the date the alert last occurred. last_occurrence_dateint,、既定値は NULL の場合にのみ設定できます0です。last_occurrence_date is int, with a default of NULL, and can be set only to 0.

[ @last_occurrence_time = ] last_occurrence_timeアラートが最後に発生した時刻をリセットします。[ @last_occurrence_time = ] last_occurrence_time Resets the time the alert last occurred. last_occurrence_timeint,、既定値は NULL の場合にのみ設定できます0です。last_occurrence_time is int, with a default of NULL, and can be set only to 0.

[ @last_response_date = ] last_response_dateSQLServerAgent サービスが最後に警告に応答した日付をリセットします。[ @last_response_date = ] last_response_date Resets the date the alert was last responded to by the SQLServerAgent service. last_response_dateint,、既定値は NULL の場合にのみ設定できます0です。last_response_date is int, with a default of NULL, and can be set only to 0.

[ @last_response_time = ] last_response_timeSQLServerAgent サービスが最後に警告に応答した時刻をリセットします。[ @last_response_time = ] last_response_time Resets the time the alert was last responded to by the SQLServerAgent service. last_response_timeint,、既定値は NULL の場合にのみ設定できます0です。last_response_time is int, with a default of NULL, and can be set only to 0.

[ @raise_snmp_trap = ] raise_snmp_trap確保.[ @raise_snmp_trap = ] raise_snmp_trap Reserved.

[ @performance_condition = ] 'performance_condition' ' Itemcomparatorvalue ' という形式で表された値。[ @performance_condition = ] 'performance_condition' A value expressed in the format 'itemcomparatorvalue'. performance_conditionnvarchar (512) ,、既定値は NULL の場合、これらの要素で構成されます。performance_condition is nvarchar(512), with a default of NULL, and consists of these elements.

要素の書式設定Format element 説明Description
アイテムItem パフォーマンス オブジェクト、パフォーマンス カウンター、またはカウンターの名前付きインスタンス。A performance object, performance counter, or named instance of the counter
演算子Comparator 次のいずれかの > 演算子 < :、、 =One of these operators: >, <, =
[値]Value カウンターの数値Numeric value of the counter

[ @category_name = ] 'category'警告カテゴリの名前。[ @category_name = ] 'category' The name of the alert category. categorysysnameで、既定値は NULL です。category is sysname with a default of NULL.

[ @wmi_namespace = ] 'wmi_namespace'イベントを照会する WMI 名前空間。[ @wmi_namespace = ] 'wmi_namespace' The WMI namespace to query for events. wmi_namespacesysname,、既定値は NULL です。wmi_namespace is sysname, with a default of NULL.

[ @wmi_query = ] 'wmi_query'警告の WMI イベントを指定するクエリ。[ @wmi_query = ] 'wmi_query' The query that specifies the WMI event for the alert. wmi_querynvarchar (512) ,、既定値は NULL です。wmi_query is nvarchar(512), with a default of NULL.

リターン コードの値Return Code Values

0 (成功) または1 (失敗)0 (success) or 1 (failure)

コメントRemarks

MicrosoftMicrosoft Windows アプリケーションログに書き込まれたsysmessagesのみが、アラートを発生させることができます。Only sysmessages written to the MicrosoftMicrosoft Windows application log can fire an alert.

sp_update_alertでは、パラメーター値が指定されているアラート設定のみが変更されます。sp_update_alert changes only those alert settings for which parameter values are supplied. パラメーターを省略した場合は、現在の設定が保持されます。If a parameter is omitted, the current setting is retained.

アクセス許可Permissions

このストアドプロシージャを実行するには、 sysadmin固定サーバーロールのメンバーである必要があります。To run this stored procedure, users must be a member of the sysadmin fixed server role.

使用例Examples

次の例では、警告が有効になっている Test Alert の設定を 0 (無効) に変更します。The following example changes the enabled setting of Test Alert to 0.

USE msdb ;  
GO  
  
EXEC dbo.sp_update_alert  
    @name = N'Test Alert',  
    @enabled = 0 ;  
GO  

関連項目See Also

sp_add_alert (Transact-SQL) sp_add_alert (Transact-SQL)
sp_help_alert (transact-sql) sp_help_alert (Transact-SQL)
システム ストアド プロシージャ (Transact-SQL)System Stored Procedures (Transact-SQL)