sp_update_job (Transact-SQL)

  • 项目

适用于：SQL ServerAzure SQL 托管实例

汇报在 SQL Server 代理 服务中创建的现有作业的属性。

Transact-SQL 语法约定

语法

sp_update_job
    [ [ @job_id = ] 'job_id' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @new_name = ] N'new_name' ]
    [ , [ @enabled = ] enabled ]
    [ , [ @description = ] N'description' ]
    [ , [ @start_step_id = ] start_step_id ]
    [ , [ @category_name = ] N'category_name' ]
    [ , [ @owner_login_name = ] N'owner_login_name' ]
    [ , [ @notify_level_eventlog = ] notify_level_eventlog ]
    [ , [ @notify_level_email = ] notify_level_email ]
    [ , [ @notify_level_netsend = ] notify_level_netsend ]
    [ , [ @notify_level_page = ] notify_level_page ]
    [ , [ @notify_email_operator_name = ] N'notify_email_operator_name' ]
    [ , [ @notify_netsend_operator_name = ] N'notify_netsend_operator_name' ]
    [ , [ @notify_page_operator_name = ] N'notify_page_operator_name' ]
    [ , [ @delete_level = ] delete_level ]
    [ , [ @automatic_post = ] automatic_post ]
[ ; ]

参数

[ @job_id = ] 'job_id'

要更新的作业的标识号。 @job_id是 uniqueidentifier，默认值为 NULL.

必须指定@job_id或@job_name，但不能指定这两者。

[ @job_name = ] N'job_name'

作业的名称。 @job_name为 sysname，默认值为 NULL.

必须指定@job_id或@job_name，但不能指定这两者。

[ @new_name = ] N'new_name'

作业的新名称。 @new_name为 sysname，默认值为 NULL.

[ @enabled = ] enabled

指定是启用作业（1）还是未启用（0）。 @enabled为 tinyint，默认值为 NULL.

[ @description = ] N'description'

作业的说明。 @description为 nvarchar（512），默认值为 NULL.

[ @start_step_id = ] start_step_id

作业中要执行的第一个步骤的标识号。 @start_step_id为 int，默认值为 NULL.

[ @category_name = ] N'category_name'

作业的类别。 @category_name为 sysname，默认值为 NULL.

[ @owner_login_name = ] N'owner_login_name'

拥有该作业的登录的名称。 @owner_login_name为 sysname，默认值为 NULL. 只有 sysadmin 固定服务器角色的成员才能更改作业所有权。

[ @notify_level_eventlog = ] notify_level_eventlog

指定何时将该作业的项放入 Microsoft Windows 应用程序日志。 @notify_level_eventlog为 int，可以是其中一个值。

值 说明（操作）
0 从不
1 成功时
2 在失败的情况下
3 始终

[ @notify_level_email = ] notify_level_email

指定在该作业完成后发送电子邮件的时间。 @notify_level_email为 int，默认值为 NULL. @notify_level_email使用与@notify_level_eventlog相同的值。

[ @notify_level_netsend = ] notify_level_netsend

指定在该作业完成后发送网络消息的时间。 @notify_level_netsend为 int，默认值为 NULL. @notify_level_netsend使用与@notify_level_eventlog相同的值。

[ @notify_level_page = ] notify_level_page

指定在该作业完成后发送页的时间。 @notify_level_page为 int，默认值为 NULL. @notify_level_page使用与@notify_level_eventlog相同的值。

[ @notify_email_operator_name = ] N'notify_email_operator_name'

到达email_level时向其发送电子邮件的操作员的名称。 @notify_email_operator_name为 sysname，默认值为 NULL.

[ @notify_netsend_operator_name = ] N'notify_netsend_operator_name'

向其发送网络消息的操作员的名称。 @notify_netsend_operator_name为 sysname，默认值为 NULL.

[ @notify_page_operator_name = ] N'notify_page_operator_name'

向其发送页的操作员的名称。 @notify_page_operator_name为 sysname，默认值为 NULL.

[ @delete_level = ] delete_level

指定删除作业的时间。 @delete_level为 int，默认值为 NULL. @delete_level使用与@notify_level_eventlog相同的值。

[ @automatic_post = ] automatic_post

标识为仅供参考。 不支持。 不保证以后的兼容性。

返回代码值

0（成功）或 1（失败）。

注解

sp_update_job 必须从 msdb 数据库运行。

sp_update_job 仅更改提供参数值的那些设置。 如果省略某一参数，则保留其当前设置。

此存储过程与用于Azure SQL 数据库的 Azure 弹性作业服务的类似对象共享名称sp_update_job。 有关弹性作业版本的信息，请参阅jobs.sp_update_job（Azure 弹性作业）（Transact-SQL）。

权限

此存储过程由 db_owner 角色拥有。 你可以为任何用户授予 EXECUTE 权限，但这些权限可能会在 SQL Server 升级期间被重写。

其他用户必须被授予数据库中以下SQL Server 代理固定数据库角色msdb之一：

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

有关这些角色的权限的详细信息，请参阅 SQL Server 代理固定数据库角色。

只有 sysadmin 的成员才能使用此存储过程编辑其他用户拥有的作业的属性。

示例

以下示例更改作业 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

相关内容