sp_update_job (Transact-SQL)sp_update_job (Transact-SQL)

適用対象:Applies to: はいSQL ServerSQL Server (サポートされているすべてのバージョン) yesSQL ServerSQL Server (all supported versions) 適用対象:Applies to: はいSQL ServerSQL Server (サポートされているすべてのバージョン) yesSQL ServerSQL Server (all supported versions)

ジョブの属性を変更します。Changes the attributes of a job.

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

構文Syntax

  
sp_update_job [ @job_id =] job_id | [@job_name =] 'job_name'  
     [, [@new_name =] 'new_name' ]   
     [, [@enabled =] enabled ]  
     [, [@description =] 'description' ]   
     [, [@start_step_id =] step_id ]  
     [, [@category_name =] 'category' ]   
     [, [@owner_login_name =] 'login' ]  
     [, [@notify_level_eventlog =] eventlog_level ]  
     [, [@notify_level_email =] email_level ]  
     [, [@notify_level_netsend =] netsend_level ]  
     [, [@notify_level_page =] page_level ]  
     [, [@notify_email_operator_name =] 'operator_name' ]  
     [, [@notify_netsend_operator_name =] 'netsend_operator' ]  
     [, [@notify_page_operator_name =] 'page_operator' ]  
     [, [@delete_level =] delete_level ]   
     [, [@automatic_post =] automatic_post ]  

引数Arguments

[ @job_id = ] job_id 更新するジョブの識別番号を指定します。[ @job_id = ] job_id The identification number of the job to be updated. job_iduniqueidentifierです。job_idis uniqueidentifier.

[ @job_name = ] 'job_name' ジョブの名前。[ @job_name = ] 'job_name' The name of the job. job_namenvarchar (128) です。job_name is nvarchar(128).

*注:***Job_idまたはjob_nameのいずれかを指定する必要がありますが、両方を指定することはできません。NOTE: Either job_id or job_name must be specified but both cannot be specified.

[ @new_name = ] 'new_name' ジョブの新しい名前を指定します。[ @new_name = ] 'new_name' The new name for the job. new_namenvarchar (128) です。new_name is nvarchar(128).

[ @enabled = ] enabled ジョブが有効 (1) か無効 (0) かを指定します。[ @enabled = ] enabled Specifies whether the job is enabled (1) or not enabled (0). 有効 なは tinyintです。enabled is tinyint.

[ @description = ] 'description' ジョブの説明。[ @description = ] 'description' The description of the job. 説明nvarchar (512) です。description is nvarchar(512).

[ @start_step_id = ] step_id ジョブに対して実行する最初のステップの識別番号を指定します。[ @start_step_id = ] step_id The identification number of the first step to execute for the job. step_idintです。step_id is int.

[ @category_name = ] 'category' ジョブのカテゴリ。[ @category_name = ] 'category' The category of the job. categorynvarchar (128) です。category is nvarchar(128).

[ @owner_login_name = ] 'login' ジョブを所有するログインの名前です。[ @owner_login_name = ] 'login' The name of the login that owns the job. ログインnvarchar (128) 固定サーバーロール sysadmin のメンバーだけがジョブの所有権を変更できます。login is nvarchar(128) Only members of the sysadmin fixed server role can change job ownership.

[ @notify_level_eventlog = ] eventlog_level このジョブの Microsoft Windows アプリケーションログにエントリを配置するタイミングを指定します。[ @notify_level_eventlog = ] eventlog_level Specifies when to place an entry in the Microsoft Windows application log for this job. eventlog_levelint,、これらの値のいずれかを指定できます。eventlog_levelis int, and can be one of these values.

[値]Value 説明 (アクション)Description (action)
00 行わないNever
11 成功時On success
22 失敗時On failure
33 Always (常に)Always

[ @notify_level_email = ] email_level このジョブの完了時に電子メールを送信するタイミングを指定します。[ @notify_level_email = ] email_level Specifies when to send an e-mail upon the completion of this job. email_levelintです。 email_leveleventlog_levelと同じ値を使用します。email_levelis int. email_leveluses the same values as eventlog_level.

[ @notify_level_netsend = ] netsend_level このジョブの完了時にネットワークメッセージを送信するタイミングを指定します。[ @notify_level_netsend = ] netsend_level Specifies when to send a network message upon the completion of this job. netsend_levelintです。 netsend_leveleventlog_levelと同じ値を使用します。netsend_levelis int. netsend_leveluses the same values as eventlog_level.

[ @notify_level_page = ] page_level このジョブの完了時にページを送信するタイミングを指定します。[ @notify_level_page = ] page_level Specifies when to send a page upon the completion of this job. page_levelintです。 page_leveleventlog_levelと同じ値を使用します。page_level is int. page_leveluses the same values as eventlog_level.

[ @notify_email_operator_name = ] 'operator_name'Email_levelに達したときに電子メールを送信するオペレーターの名前。[ @notify_email_operator_name = ] 'operator_name' The name of the operator to whom the e-mail is sent when email_level is reached. email_namenvarchar (128) です。email_name is nvarchar(128).

[ @notify_netsend_operator_name = ] 'netsend_operator' ネットワークメッセージの送信先オペレーターの名前。[ @notify_netsend_operator_name = ] 'netsend_operator' The name of the operator to whom the network message is sent. netsend_operatornvarchar (128) です。netsend_operator is nvarchar(128).

[ @notify_page_operator_name = ] 'page_operator' ページを送信するオペレーターの名前。[ @notify_page_operator_name = ] 'page_operator' The name of the operator to whom a page is sent. page_operatornvarchar (128) です。page_operator is nvarchar(128).

[ @delete_level = ] delete_level いつジョブを削除するかを指定します。[ @delete_level = ] delete_level Specifies when to delete the job. delete_valueintです。 delete_leveleventlog_levelと同じ値を使用します。delete_valueis int. delete_leveluses the same values as eventlog_level.

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

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

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

解説Remarks

sp_update_job は、 msdb データベースから実行する必要があります。sp_update_job must be run from the msdb database.

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

アクセス許可Permissions

既定では、 sysadmin 固定サーバーロールのメンバーは、このストアドプロシージャを実行できます。By default, members of the sysadmin fixed server role can execute this stored procedure. 他のユーザーには、 SQL ServerSQL Server msdb データベースの次のいずれかの エージェント固定データベース ロールが許可されている必要があります。Other users must be granted one of the following SQL ServerSQL Server Agent fixed database roles in the msdb database:

  • SQLAgentUserRoleSQLAgentUserRole

  • SQLAgentReaderRoleSQLAgentReaderRole

  • SQLAgentOperatorRoleSQLAgentOperatorRole

これらのロールの権限の詳細については、「 SQL Server エージェントの固定データベース ロール」を参照してください。For details about the permissions of these roles, see SQL Server Agent Fixed Database Roles.

Sysadminのメンバーだけが、このストアドプロシージャを使用して、他のユーザーが所有するジョブの属性を編集できます。Only members of sysadmin can use this stored procedure to edit the attributes of jobs that are owned by other users.

Examples

次の例では、ジョブの名前、説明、および有効な状態を変更し NightlyBackups ます。The following example changes the name, description, and enabled status of the job NightlyBackups.

USE msdb ;  
GO  
  
EXEC dbo.sp_update_job  
    @job_name = N'NightlyBackups',  
    @new_name = N'NightlyBackups -- Disabled',  
    @description = N'Nightly backups disabled during server migration.',  
    @enabled = 0 ;  
GO  

参照See Also

sp_add_job (Transact-SQL) sp_add_job (Transact-SQL)
sp_delete_job (Transact-sql) sp_delete_job (Transact-SQL)
sp_help_job (Transact-sql) sp_help_job (Transact-SQL)
システム ストアド プロシージャ (Transact-SQL)System Stored Procedures (Transact-SQL)