jobs.sp_add_job (Azure 弹性作业) (Transact-SQL)

适用于:Azure SQL 数据库

Azure 弹性作业服务中添加Azure SQL 数据库的新作业。

此存储过程与 SQL Server 中用于SQL Server 代理服务的类似对象共享名称sp_add_job。 有关SQL Server 代理版本的信息,请参阅sp_add_job(Transact-SQL)。

Transact-SQL 语法约定

语法

[jobs].sp_add_job [ @job_name = ] 'job_name'  
  [ , [ @description = ] 'description' ]
  [ , [ @enabled = ] enabled ]
  [ , [ @schedule_interval_type = ] schedule_interval_type ]  
  [ , [ @schedule_interval_count = ] schedule_interval_count ]
  [ , [ @schedule_start_time = ] schedule_start_time ]
  [ , [ @schedule_end_time = ] schedule_end_time ]
  [ , [ @job_id = ] job_id OUTPUT ]

参数

@job_name

作业的名称。 名称必须是唯一的,不能包含百分比 (%) 字符。 job_name 为 nvarchar(128),没有默认值。

@description

作业的说明。 description 为 nvarchar(512),默认值为 NULL. 如果 省略说明 ,则使用空字符串。

@enabled

指定是否启用作业的计划。 启用 为位,默认值为 0(已禁用)。 如果 0作业未启用且未按计划运行;但是,它可以手动运行。 如果 1作业按计划运行,也可以手动运行。

@schedule_interval_type

其值指示何时会执行作业。 schedule_interval_type为 nvarchar(50),默认值Once为 ,可以是下列值之一:

  • Once
  • Minutes
  • Hours
  • Days
  • Weeks
  • Months

@schedule_interval_count

每个作业执行之间要发生的schedule_interval_count周期数。 schedule_interval_count 为 int,默认值为 1. 该值必须大于或等于 1。

@schedule_start_time

可以开始执行作业的日期。 schedule_start_time DATETIME2,默认值为 0001-01-01 00:00:00.0000000。

弹性作业中的所有时间均处于 UTC 时区。

@schedule_end_time

可以停止执行作业的日期。 schedule_end_time是DATETIME2,默认值为 9999-12-31 11:59:59.00000000。

弹性作业中的所有时间均处于 UTC 时区。

@job_id

成功创建作业后分配给作业的作业标识号。 job_id 是 uniqueidentifier 类型的输出变量。

返回代码值

0(成功)或 1(失败)

注解

必须 jobs.sp_add_job 从创建作业代理时指定的作业代理数据库运行存储过程。

执行作业以添加作业后 jobs.sp_add_job可以使用jobs.sp_add_jobstep 添加执行作业活动的步骤。 作业的初始版本号是 0递增到 1 添加第一步时。

权限

默认情况下,只有 sysadmin 固定服务器角色的成员才可以执行此存储过程。 仅 sysadmin 的成员可以使用此存储过程来编辑其他用户拥有的作业的属性。