jobs.sp_add_job (Azure エラスティック ジョブ) (Transact-SQL)

適用対象: Azure SQL Database

Azure SQL Database Azure エラスティック ジョブ サービスに新しいジョブを追加します。

このストアド プロシージャは、SQL Server エージェント サービスの SQL Server の同様のオブジェクトとsp_add_jobの名前を共有します。 SQL Server エージェントバージョンの詳細については、sp_add_jobを参照してください。

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

ジョブのスケジュールを有効にするかどうかを指定します。 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.0000000 です。

エラスティック ジョブのすべての時間は、UTC タイム ゾーンが適用されます。

@job_id

正常に作成された場合にジョブに割り当てられるジョブ識別番号。 job_id は uniqueidentifier 型の出力変数です。

リターン コードの値

0 (成功) または 1 (失敗)。

解説

jobs.sp_add_jobストアド プロシージャは、ジョブ エージェントの作成時に指定されたジョブ エージェント データベースから実行する必要があります。

jobs.sp_add_jobを実行してジョブを追加した後、jobs.sp_add_jobstepを使用して、ジョブのアクティビティを実行するステップを追加できます。 ジョブの初期バージョン番号が 0され、最初のステップが追加されたときに 1 にインクリメントされます。

アクセス許可

既定では、このストアド プロシージャを実行できるのは、 sysadmin 固定サーバー ロールのメンバーです。 このストアド プロシージャを使って、他のユーザーが所有するジョブの属性を編集できるのは、sysadmin のメンバーだけです。