jobs.sp_update_jobstep (Azure エラスティック ジョブ) (Transact-SQL)
適用対象: 
Azure SQL Database
Azure SQL Database の Azure エラスティック ジョブ サービスの既存のジョブのジョブ ステップを変更します。 ジョブステップをジョブに追加するには、 jobs.sp_add_jobstep を使用します。
このストアド プロシージャは、SQL Server エージェント サービスの SQL Server の同様のオブジェクトとsp_update_jobstepの名前を共有します。 SQL Server エージェントバージョンの詳細については、「sp_update_jobstep (Transact-SQL)」を参照してください。
構文
[jobs].sp_update_jobstep [ @job_name = ] 'job_name'
[ , [ @step_id = ] step_id ]
[ , [ @step_name = ] 'step_name' ]
[ , [ @new_id = ] new_id ]
[ , [ @new_name = ] 'new_name' ]
[ , [ @command_type = ] 'command_type' ]
[ , [ @command_source = ] 'command_source' ]
, [ @command = ] 'command'
[, [ @credential_name = ] 'credential_name' ]
, [ @target_group_name = ] 'target_group_name'
[ , [ @initial_retry_interval_seconds = ] initial_retry_interval_seconds ]
[ , [ @maximum_retry_interval_seconds = ] maximum_retry_interval_seconds ]
[ , [ @retry_interval_backoff_multiplier = ]retry_interval_backoff_multiplier ]
[ , [ @retry_attempts = ] retry_attempts ]
[ , [ @step_timeout_seconds = ] step_timeout_seconds ]
[ , [ @output_type = ] 'output_type' ]
[ , [ @output_credential_name = ] 'output_credential_name' ]
[ , [ @output_server_name = ] 'output_server_name' ]
[ , [ @output_database_name = ] 'output_database_name' ]
[ , [ @output_schema_name = ] 'output_schema_name' ]
[ , [ @output_table_name = ] 'output_table_name' ]
[ , [ @job_version = ] job_version OUTPUT ]
[ , [ @max_parallelism = ] max_parallelism ]
引数
@job_name
ステップが属するジョブの名前を指定します。 job_name は nvarchar(128) です。
@step_id
変更するジョブ ステップの ID 番号。 step_idまたはstep_nameを指定する必要があります。 step_id は int です。
@step_name
変更するステップの名前。 step_idまたはstep_nameを指定する必要があります。 step_name は nvarchar(128) です。
@new_id
ジョブ ステップの新しいシーケンス ID 番号。 ステップ ID 番号は 1 から始まり、隙間なく増加します。 ステップの順序を変更する場合、他のステップの番号は自動的に変更されます。
@new_name
ステップの新しい名前。 new_name は nvarchar(128) です。
@command_type
このジョブ ステップによって実行されるコマンドの種類。 command_type は nvarchar(50) で、既定値は TSql です。つまり、 @command_type パラメーターの値は T-SQL スクリプトです。
指定する場合、値は TSqlする必要があります。
@command_source
コマンドが格納される場所の種類。 command_source は nvarchar(50) で、既定値は Inline です。つまり、 @command パラメーターの値はコマンドのリテラル テキストです。
指定する場合、値は Inlineする必要があります。
@command
このジョブ ステップで実行される有効な T-SQL スクリプト。 command は nvarchar(max) で、既定値は NULL です。
@credential_name
このステップの実行時にターゲット グループ内の各ターゲット データベースに接続するために使用される、このジョブ 制御データベースに格納されているデータベース スコープの資格情報の名前。 credential_name は nvarchar(128) です。
Microsoft Entra 認証 (旧称 Azure Active Directory) を使用する場合は、 @credential_name パラメーターを省略します。これは、データベース スコープの資格情報を使用する場合にのみ指定する必要があります。
@target_group_name
ジョブ ステップが実行されるターゲット データベースを含むターゲット グループの名前。 target_group_name は nvarchar(128) です。
@initial_retry_interval_seconds
ジョブ ステップの最初の実行の試行が失敗した場合に、最初の再試行を試みるまでの遅延。 initial_retry_interval_seconds は int で、既定値は 1 です。
@maximum_retry_interval_seconds
再試行の間の最大遅延。 再試行の間の遅延がこの値より大きくなった場合は、この値に制限されます。 maximum_retry_interval_seconds は int で、既定値は 120 です。
@retry_interval_backoff_multiplier
ジョブ ステップの実行が複数回にわたり失敗した場合に、再試行の遅延に適用する乗数。 たとえば、最初の再試行の遅延が 5 秒で、バックオフ乗数が 2.0 の場合、2 回目の再試行の遅延は 10 秒、3 回目の再試行の遅延は 20 秒になります。 retry_interval_backoff_multiplier は real データ型で、既定値は 2.0 です。
@retry_attempts
最初の試行が失敗した場合に、実行を再試行する回数。 たとえば、 retry_attempts 値が 10 の場合、最初の試行は 1 回、再試行回数は 10 回になり、合計で 11 回の試行が行われます。 最後の再試行が失敗した場合、ジョブの実行はjobs.job_executionsに記録されたFailedのlifecycleで終了します。 retry_attempts は int で、既定値は 10 です。
@step_timeout_seconds
ステップの実行に許可されている最大時間。 この時間を超えた場合、ジョブの実行はjobs.job_executionsに記録されたTimedOutのlifecycleで終了します。 step_timeout_seconds は int で、既定値は 43,200 秒 (12 時間) です。
@output_type
NULLしない場合は、command の最初の結果セットの書き込み先の型。 output_typeの値をNULLにリセットするには、このパラメーターの値を '' (空の文字列) に設定します。 output_type は nvarchar(50) で、既定値は NULL です。
指定する場合、値は SqlDatabaseする必要があります。
@output_credential_name
NULLしない場合は、出力先データベースへの接続に使用されるデータベース スコープの資格情報の名前。 output_typeがSqlDatabaseと等しい場合は、指定する必要があります。 output_credential_nameの値を NULL にリセットするには、このパラメーターの値を '' (空の文字列) に設定します。 output_credential_name は nvarchar(128) で、既定値は NULL です。
Microsoft Entra 認証 (旧称 Azure Active Directory) を使用する場合は、 @output_credential_name パラメーターを省略します。これは、データベース スコープの資格情報を使用する場合にのみ指定する必要があります。
@output_server_name
NULLしない場合は、出力先データベースを含むサーバーの完全修飾 DNS 名 (例: @output_server_name = 'server1.database.windows.net')。 output_typeがSqlDatabaseと等しい場合は、指定する必要があります。 output_server_nameの値を NULLにリセットするには、このパラメーターの値を '' (空の文字列) に設定します。 output_server_name は nvarchar(256) で、既定値は NULL です。
@output_database_name
NULLされていない場合は、出力先テーブルを含むデータベースの名前。 output_typeがSqlDatabaseと等しい場合は、指定する必要があります。 output_database_nameの値をNULLにリセットするには、このパラメーターの値を '' (空の文字列) に設定します。 output_database_name は nvarchar(128) で、既定値は NULL です。
@output_schema_name
NULLしない場合は、出力先テーブルを含む SQL スキーマの名前。 output_typeSqlDatabaseと等しい場合、既定値はdbo。 output_schema_nameの値をNULLにリセットするには、このパラメーターの値を '' (空の文字列) に設定します。 output_schema_name は nvarchar(128) です。
@output_table_name
NULLしない場合は、command の最初の結果セットが書き込まれるテーブルの名前。 テーブルがまだ存在しない場合は、返される結果セットのスキーマに基づいて作成されます。 output_typeがSqlDatabaseと等しい場合は、指定する必要があります。 output_server_nameの値をNULLにリセットするには、このパラメーターの値を '' (空の文字列) に設定します。 output_table_name は nvarchar(128) で、既定値は NULL です。
output_table_nameを指定する場合は、ジョブ エージェント UMI またはデータベース スコープの資格情報に、CREATE TABLE と INSERT データに対する必要なアクセス許可をテーブルに付与する必要があります。
@job_version アウトプット
新しいジョブのバージョン番号が割り当てられる出力パラメーター。 job_version は int です。
@max_parallelism アウトプット
エラスティック プールあたりの並列処理の最大レベル。 設定した場合、ジョブ ステップはエラスティック プールあたり最大でもその指定数のデータベースでのみ実行するように制限されます。 これは、ターゲット グループに直接含まれる各エラスティック プール、またはターゲット グループに含まれるサーバー内に存在するエラスティック プールに適用されます。 max_parallelismの値を NULL にリセットするには、このパラメーターの値を -1 に設定します。 max_parallelism は int です。
リターン コードの値
0 (成功) または 1 (失敗)
解説
ジョブの進行中の実行には影響しません。 jobs.sp_update_jobstep成功すると、ジョブのバージョン番号がインクリメントされます。 次にジョブを実行するときは、新しいバージョンが使われます。
アクセス許可
既定では、このストアド プロシージャを実行できるのは、 sysadmin 固定サーバー ロールのメンバーです。 このストアド プロシージャを使って、他のユーザーが所有するジョブの属性を編集できるのは、sysadmin のメンバーだけです。
例
エラスティック ジョブ ステップの更新コマンド
このサンプルでは、既存のエラスティック ジョブ ステップの T-SQL コマンドを更新します。 T-SQL スクリプトは、テーブルが存在しない場合に作成するジョブ ステップを追加します。
--Connect to the job database specified when creating the elastic job agent
-- Add job step to create a table if it does not exist
EXEC jobs.sp_update_jobstep @job_name = 'CreateTableTest',
@command = N'IF NOT EXISTS (SELECT * FROM sys.tables WHERE object_id = object_id(''Test''))
CREATE TABLE [dbo].[Test]([TestId] [int] NOT NULL);',
@target_group_name = 'PoolGroup';
関連するコンテンツ
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示