Job class
ジョブを表すクラス。
コンストラクター
| Job(Batch |
ジョブを作成します。 |
メソッド
コンストラクターの詳細
Job(BatchServiceClientContext)
ジョブを作成します。
new Job(client: BatchServiceClientContext)パラメーター
- client
- BatchServiceClientContext
サービス クライアントへの参照。
メソッドの詳細
add(JobAddParameter, JobAddOptionalParams)
Batch サービスでは、ジョブの一部として実行される作業を制御する 2 つの方法がサポートされています。 最初の方法では、ユーザーはジョブ マネージャー タスクを指定します。 Batch サービスは、ジョブを開始する準備ができたら、このタスクを起動します。 ジョブ マネージャー タスクは、タスク API を使用して、このジョブで実行される他のすべてのタスクを制御します。 2 番目の方法では、ユーザーは、タスク API を使用して、アクティブなジョブの下でタスクの実行を直接制御します。 また、ジョブに名前を付ける場合は、ユーザー名やシークレット プロジェクト名などの機密情報を含めないでください。 この情報は、Microsoft サポート エンジニアがアクセスできるテレメトリ ログに表示される場合があります。
function add(job: JobAddParameter, options?: JobAddOptionalParams): Promise<JobAddResponse>パラメーター
- job
- JobAddParameter
追加するジョブ。
- options
- JobAddOptionalParams
省略可能なパラメーター
戻り値
Promise<JobAddResponse>
Promise<Models.JobAddResponse応答>
add(JobAddParameter, JobAddOptionalParams, ServiceCallback<void>)
function add(job: JobAddParameter, options: JobAddOptionalParams, callback: ServiceCallback<void>)パラメーター
- job
- JobAddParameter
追加するジョブ。
- options
- JobAddOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
add(JobAddParameter, ServiceCallback<void>)
function add(job: JobAddParameter, callback: ServiceCallback<void>)パラメーター
- job
- JobAddParameter
追加するジョブ。
- callback
-
ServiceCallback<void>
コールバック
deleteMethod(string, JobDeleteMethodOptionalParams)
ジョブを削除すると、そのジョブの一部であるすべてのタスクとすべてのジョブ統計も削除されます。 これにより、タスク データの保持期間もオーバーライドされます。つまり、コンピューティング ノードにまだ保持されているタスクがジョブに含まれている場合、Batch サービスはそれらのタスクの作業ディレクトリとそのすべての内容を削除します。 ジョブの削除要求を受信すると、Batch サービスはジョブを削除状態に設定します。 状態を削除中のジョブに対するすべての更新操作は、状態コード 409 (競合) で失敗し、ジョブが削除されていることを示す追加情報が表示されます。
function deleteMethod(jobId: string, options?: JobDeleteMethodOptionalParams): Promise<JobDeleteResponse>パラメーター
- jobId
-
string
削除するジョブの ID。
- options
- JobDeleteMethodOptionalParams
省略可能なパラメーター
戻り値
Promise<JobDeleteResponse>
Promise<Models.JobDeleteResponse>
deleteMethod(string, JobDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobId: string, options: JobDeleteMethodOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
削除するジョブの ID。
- options
- JobDeleteMethodOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(jobId: string, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
削除するジョブの ID。
- callback
-
ServiceCallback<void>
コールバック
disable(string, DisableJobOption, JobDisableOptionalParams)
Batch サービスは、ジョブをすぐに無効化状態に移動します。 次に、Batch は disableTasks パラメーターを使用して、ジョブの現在実行中のタスクの処理を決定します。 無効化操作が完了し、disableTasks オプションに従ってすべてのタスクが処理されるまで、ジョブは無効化状態のままになります。その後、ジョブは無効な状態に移行します。 アクティブな状態に戻るまで、ジョブの下で新しいタスクは開始されません。 アクティブ、無効化、または無効以外の状態のジョブを無効にしようとすると、要求は状態コード 409 で失敗します。
function disable(jobId: string, disableTasks: DisableJobOption, options?: JobDisableOptionalParams): Promise<JobDisableResponse>パラメーター
- jobId
-
string
無効にするジョブの ID。
- disableTasks
- DisableJobOption
ジョブに関連付けられているアクティブなタスクの操作。 使用可能な値は、'requeue'、'terminate'、'wait' です。
- options
- JobDisableOptionalParams
省略可能なパラメーター
戻り値
Promise<JobDisableResponse>
Promise<Models.JobDisableResponseです>
disable(string, DisableJobOption, JobDisableOptionalParams, ServiceCallback<void>)
function disable(jobId: string, disableTasks: DisableJobOption, options: JobDisableOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
無効にするジョブの ID。
- disableTasks
- DisableJobOption
ジョブに関連付けられているアクティブなタスクの操作。 使用可能な値は、'requeue'、'terminate'、'wait' です。
- options
- JobDisableOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
disable(string, DisableJobOption, ServiceCallback<void>)
function disable(jobId: string, disableTasks: DisableJobOption, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
無効にするジョブの ID。
- disableTasks
- DisableJobOption
ジョブに関連付けられているアクティブなタスクの操作。 使用可能な値は、'requeue'、'terminate'、'wait' です。
- callback
-
ServiceCallback<void>
コールバック
enable(string, JobEnableOptionalParams)
この API を呼び出すと、Batch サービスは無効なジョブを有効化状態に設定します。 この操作が完了すると、ジョブはアクティブな状態に移行し、ジョブの下の新しいタスクのスケジュールが再開されます。 Batch サービスでは、タスクを 180 日を超えてアクティブな状態を維持することはできません。 そのため、180 日以上前に追加されたアクティブなタスクを含むジョブを有効にした場合、それらのタスクは実行されません。
function enable(jobId: string, options?: JobEnableOptionalParams): Promise<JobEnableResponse>パラメーター
- jobId
-
string
有効にするジョブの ID。
- options
- JobEnableOptionalParams
省略可能なパラメーター
戻り値
Promise<JobEnableResponse>
Promise<Models.JobEnableResponseです。>
enable(string, JobEnableOptionalParams, ServiceCallback<void>)
function enable(jobId: string, options: JobEnableOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
有効にするジョブの ID。
- options
- JobEnableOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
enable(string, ServiceCallback<void>)
function enable(jobId: string, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
有効にするジョブの ID。
- callback
-
ServiceCallback<void>
コールバック
get(string, JobGetOptionalParams)
function get(jobId: string, options?: JobGetOptionalParams): Promise<JobGetResponse>パラメーター
- jobId
-
string
ジョブの ID。
- options
- JobGetOptionalParams
省略可能なパラメーター
戻り値
Promise<JobGetResponse>
Promise<Models.JobGetResponseです。>
get(string, JobGetOptionalParams, ServiceCallback<CloudJob>)
function get(jobId: string, options: JobGetOptionalParams, callback: ServiceCallback<CloudJob>)パラメーター
- jobId
-
string
ジョブの ID。
- options
- JobGetOptionalParams
省略可能なパラメーター
- callback
コールバック
get(string, ServiceCallback<CloudJob>)
function get(jobId: string, callback: ServiceCallback<CloudJob>)パラメーター
- jobId
-
string
ジョブの ID。
- callback
コールバック
getAllLifetimeStatistics(JobGetAllLifetimeStatisticsOptionalParams)
統計は、アカウントの作成から統計の最後の更新時刻まで、アカウントに存在したすべてのジョブで集計されます。 統計をすぐに使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。
function getAllLifetimeStatistics(options?: JobGetAllLifetimeStatisticsOptionalParams): Promise<JobGetAllLifetimeStatisticsResponse>パラメーター
省略可能なパラメーター
戻り値
Promise<JobGetAllLifetimeStatisticsResponse>
Promise<Models.JobGetAllLifetimeStatisticsResponse>
getAllLifetimeStatistics(JobGetAllLifetimeStatisticsOptionalParams, ServiceCallback<JobStatistics>)
function getAllLifetimeStatistics(options: JobGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<JobStatistics>)パラメーター
省略可能なパラメーター
- callback
コールバック
getAllLifetimeStatistics(ServiceCallback<JobStatistics>)
function getAllLifetimeStatistics(callback: ServiceCallback<JobStatistics>)パラメーター
- callback
コールバック
getTaskCounts(string, JobGetTaskCountsOptionalParams)
タスク数は、アクティブ、実行中、または完了したタスクの状態によるタスクの数と、成功または失敗したタスクの数を提供します。 準備中の状態のタスクは、実行中としてカウントされます。 返される数値が常に最新であるとは限りません。 正確なタスク数が必要な場合は、リスト クエリを使用します。
function getTaskCounts(jobId: string, options?: JobGetTaskCountsOptionalParams): Promise<JobGetTaskCountsResponse>パラメーター
- jobId
-
string
ジョブの ID。
- options
- JobGetTaskCountsOptionalParams
省略可能なパラメーター
戻り値
Promise<JobGetTaskCountsResponse>
Promise<Models.JobGetTaskCountsResponse>
getTaskCounts(string, JobGetTaskCountsOptionalParams, ServiceCallback<TaskCountsResult>)
function getTaskCounts(jobId: string, options: JobGetTaskCountsOptionalParams, callback: ServiceCallback<TaskCountsResult>)パラメーター
- jobId
-
string
ジョブの ID。
- options
- JobGetTaskCountsOptionalParams
省略可能なパラメーター
- callback
コールバック
getTaskCounts(string, ServiceCallback<TaskCountsResult>)
function getTaskCounts(jobId: string, callback: ServiceCallback<TaskCountsResult>)パラメーター
- jobId
-
string
ジョブの ID。
- callback
コールバック
list(JobListOptionalParams)
function list(options?: JobListOptionalParams): Promise<JobListResponse>パラメーター
- options
- JobListOptionalParams
省略可能なパラメーター
戻り値
Promise<JobListResponse>
Promise<Models.JobListResponse応答>
list(JobListOptionalParams, ServiceCallback<CloudJobListResult>)
function list(options: JobListOptionalParams, callback: ServiceCallback<CloudJobListResult>)パラメーター
- options
- JobListOptionalParams
省略可能なパラメーター
- callback
コールバック
list(ServiceCallback<CloudJobListResult>)
function list(callback: ServiceCallback<CloudJobListResult>)パラメーター
- callback
コールバック
listFromJobSchedule(string, JobListFromJobScheduleOptionalParams)
function listFromJobSchedule(jobScheduleId: string, options?: JobListFromJobScheduleOptionalParams): Promise<JobListFromJobScheduleResponse>パラメーター
- jobScheduleId
-
string
ジョブの一覧を取得するジョブ スケジュールの ID。
省略可能なパラメーター
戻り値
Promise<JobListFromJobScheduleResponse>
Promise<Models.JobListFromJobScheduleResponse>
listFromJobSchedule(string, JobListFromJobScheduleOptionalParams, ServiceCallback<CloudJobListResult>)
function listFromJobSchedule(jobScheduleId: string, options: JobListFromJobScheduleOptionalParams, callback: ServiceCallback<CloudJobListResult>)パラメーター
- jobScheduleId
-
string
ジョブの一覧を取得するジョブ スケジュールの ID。
省略可能なパラメーター
- callback
コールバック
listFromJobSchedule(string, ServiceCallback<CloudJobListResult>)
function listFromJobSchedule(jobScheduleId: string, callback: ServiceCallback<CloudJobListResult>)パラメーター
- jobScheduleId
-
string
ジョブの一覧を取得するジョブ スケジュールの ID。
- callback
コールバック
listFromJobScheduleNext(string, JobListFromJobScheduleNextOptionalParams)
function listFromJobScheduleNext(nextPageLink: string, options?: JobListFromJobScheduleNextOptionalParams): Promise<JobListFromJobScheduleResponse>パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
省略可能なパラメーター
戻り値
Promise<JobListFromJobScheduleResponse>
Promise<Models.JobListFromJobScheduleResponse>
listFromJobScheduleNext(string, JobListFromJobScheduleNextOptionalParams, ServiceCallback<CloudJobListResult>)
function listFromJobScheduleNext(nextPageLink: string, options: JobListFromJobScheduleNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
省略可能なパラメーター
- callback
コールバック
listFromJobScheduleNext(string, ServiceCallback<CloudJobListResult>)
function listFromJobScheduleNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
- callback
コールバック
listNext(string, JobListNextOptionalParams)
function listNext(nextPageLink: string, options?: JobListNextOptionalParams): Promise<JobListResponse>パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
- options
- JobListNextOptionalParams
省略可能なパラメーター
戻り値
Promise<JobListResponse>
Promise<Models.JobListResponse応答>
listNext(string, JobListNextOptionalParams, ServiceCallback<CloudJobListResult>)
function listNext(nextPageLink: string, options: JobListNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
- options
- JobListNextOptionalParams
省略可能なパラメーター
- callback
コールバック
listNext(string, ServiceCallback<CloudJobListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
- callback
コールバック
listPreparationAndReleaseTaskStatus(string, JobListPreparationAndReleaseTaskStatusOptionalParams)
この API は、ジョブ準備タスクまたはジョブ解放タスクを実行したすべてのコンピューティング ノードのジョブ準備タスクとジョブ解放タスクの状態を返します。 これには、プールから削除されたコンピューティング ノードが含まれます。 ジョブ準備タスクまたはジョブ解放タスクがないジョブでこの API が呼び出された場合、Batch サービスは HTTP 状態コード 409 (競合) を JobPreparationTaskNotSpecified のエラー コードと共に返します。
function listPreparationAndReleaseTaskStatus(jobId: string, options?: JobListPreparationAndReleaseTaskStatusOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>パラメーター
- jobId
-
string
ジョブの ID。
省略可能なパラメーター
戻り値
Promise<Models.JobListPreparationAndReleaseTaskStatusResponse>
listPreparationAndReleaseTaskStatus(string, JobListPreparationAndReleaseTaskStatusOptionalParams, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatus(jobId: string, options: JobListPreparationAndReleaseTaskStatusOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)パラメーター
- jobId
-
string
ジョブの ID。
省略可能なパラメーター
コールバック
listPreparationAndReleaseTaskStatus(string, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatus(jobId: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)パラメーター
- jobId
-
string
ジョブの ID。
コールバック
listPreparationAndReleaseTaskStatusNext(string, JobListPreparationAndReleaseTaskStatusNextOptionalParams)
この API は、ジョブ準備タスクまたはジョブ解放タスクを実行したすべてのコンピューティング ノードのジョブ準備タスクとジョブ解放タスクの状態を返します。 これには、プールから削除されたコンピューティング ノードが含まれます。 ジョブ準備タスクまたはジョブ解放タスクがないジョブでこの API が呼び出された場合、Batch サービスは HTTP 状態コード 409 (競合) を JobPreparationTaskNotSpecified のエラー コードと共に返します。
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options?: JobListPreparationAndReleaseTaskStatusNextOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
省略可能なパラメーター
戻り値
Promise<Models.JobListPreparationAndReleaseTaskStatusResponse>
listPreparationAndReleaseTaskStatusNext(string, JobListPreparationAndReleaseTaskStatusNextOptionalParams, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options: JobListPreparationAndReleaseTaskStatusNextOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
省略可能なパラメーター
コールバック
listPreparationAndReleaseTaskStatusNext(string, ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)
function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
コールバック
patch(string, JobPatchParameter, JobPatchOptionalParams)
これにより、要求で指定された Job プロパティのみが置き換えられます。 たとえば、ジョブに制約があり、要求で制約要素が指定されていない場合、ジョブは既存の制約を保持します。
function patch(jobId: string, jobPatchParameter: JobPatchParameter, options?: JobPatchOptionalParams): Promise<JobPatchResponse>パラメーター
- jobId
-
string
更新するプロパティを持つジョブの ID。
- jobPatchParameter
- JobPatchParameter
要求のパラメーター。
- options
- JobPatchOptionalParams
省略可能なパラメーター
戻り値
Promise<JobPatchResponse>
Promise<Models.JobPatchResponseです>
patch(string, JobPatchParameter, JobPatchOptionalParams, ServiceCallback<void>)
function patch(jobId: string, jobPatchParameter: JobPatchParameter, options: JobPatchOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
更新するプロパティを持つジョブの ID。
- jobPatchParameter
- JobPatchParameter
要求のパラメーター。
- options
- JobPatchOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
patch(string, JobPatchParameter, ServiceCallback<void>)
function patch(jobId: string, jobPatchParameter: JobPatchParameter, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
更新するプロパティを持つジョブの ID。
- jobPatchParameter
- JobPatchParameter
要求のパラメーター。
- callback
-
ServiceCallback<void>
コールバック
terminate(string, JobTerminateOptionalParams)
ジョブの終了要求を受信すると、Batch サービスによってジョブが終了状態に設定されます。 その後、Batch サービスは、ジョブに関連付けられている実行中のタスクを終了し、必要なジョブ 解放タスクを実行します。 その後、ジョブは完了状態に移行します。 ジョブにアクティブな状態のタスクがある場合、それらはアクティブな状態のままになります。 ジョブが終了すると、新しいタスクを追加できず、残りのアクティブなタスクはスケジュールされません。
function terminate(jobId: string, options?: JobTerminateOptionalParams): Promise<JobTerminateResponse>パラメーター
- jobId
-
string
終了するジョブの ID。
- options
- JobTerminateOptionalParams
省略可能なパラメーター
戻り値
Promise<JobTerminateResponse>
Promise<Models.JobTerminateResponse応答>
terminate(string, JobTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobId: string, options: JobTerminateOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
終了するジョブの ID。
- options
- JobTerminateOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
terminate(string, ServiceCallback<void>)
function terminate(jobId: string, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
終了するジョブの ID。
- callback
-
ServiceCallback<void>
コールバック
update(string, JobUpdateParameter, JobUpdateOptionalParams)
これにより、ジョブのすべての更新可能なプロパティが完全に置き換えられます。 たとえば、ジョブに関連付けられた制約があり、この要求で制約が指定されていない場合、Batch サービスは既存の制約を削除します。
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options?: JobUpdateOptionalParams): Promise<JobUpdateResponse>パラメーター
- jobId
-
string
更新するプロパティを持つジョブの ID。
- jobUpdateParameter
- JobUpdateParameter
要求のパラメーター。
- options
- JobUpdateOptionalParams
省略可能なパラメーター
戻り値
Promise<JobUpdateResponse>
Promise<Models.JobUpdateResponse応答>
update(string, JobUpdateParameter, JobUpdateOptionalParams, ServiceCallback<void>)
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options: JobUpdateOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
更新するプロパティを持つジョブの ID。
- jobUpdateParameter
- JobUpdateParameter
要求のパラメーター。
- options
- JobUpdateOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
update(string, JobUpdateParameter, ServiceCallback<void>)
function update(jobId: string, jobUpdateParameter: JobUpdateParameter, callback: ServiceCallback<void>)パラメーター
- jobId
-
string
更新するプロパティを持つジョブの ID。
- jobUpdateParameter
- JobUpdateParameter
要求のパラメーター。
- callback
-
ServiceCallback<void>
コールバック