sp_update_job (Transact-SQL)sp_update_job (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

ジョブの属性を変更します。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. 新しい名前nvarchar (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. カテゴリnvarchar (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

[ @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_levelとして同じ値を使用してeventlog_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_levelとして同じ値を使用してeventlog_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_levelとして同じ値を使用してeventlog_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_levelとして同じ値を使用してeventlog_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)