BatchClient class

パッケージ:: @azure/batch

Client class for accessing Azure Batch service.

コンストラクター

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

メソッド

createJob(BatchJobCreateOptions, CreateJobOptionalParams)	バッチサービスは、ジョブの一部として行われる作業を制御する2つの方法をサポートしています。最初の方法では、ユーザーがジョブマネージャータスクを指定します。バッチサービスはジョブ開始の準備ができたときにこのタスクを起動します。ジョブマネージャータスクは、タスクAPIを使ってこのジョブの下で実行されるすべてのタスクを制御します。 2つ目のアプローチでは、ユーザーがタスクAPIを使ってアクティブなジョブ下でのタスクの実行を直接制御します。また、ジョブ名を付ける際は、ユーザー名や秘密のプロジェクト名などの機密情報を含めるのは避けてください。この情報は、Microsoft サポートエンジニアがアクセスできるテレメトリログに表示される場合があります。
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)	指定されたアカウントにジョブスケジュールを作成します。
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)	ユーザーアカウントは、コンピュートノードがアイドルまたは実行中の状態の場合にのみ追加できます。コンピュートノードにリモートでログインする前に、SSHとRDP用のアクセスポートを設定する必要があります。詳細については、https://learn.microsoft.com/azure/batch/pool-endpoint-configuration を参照してください。
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)	プールに名前を付ける場合は、ユーザー名やシークレットプロジェクト名などの機密情報を含めないでください。この情報は、Microsoft サポートエンジニアがアクセスできるテレメトリログに表示される場合があります。
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)	タスクの追加から完了までの最大寿命は180日です。タスクが追加されてから180日以内に完了しなかった場合、バッチサービスによって終了され、その時点での状態のまま残されます。
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)	各タスクは一意のIDを持つ必要があることに注意してください。バッチサービスは、このリクエストで提出されたタスクと同じ順序で各タスクの結果を返すことはできません。サーバーがタイムアウトしたり、リクエスト中に接続が閉じられた場合、リクエストは部分的または完全に処理された場合、あるいは全く処理されていない可能性があります。その場合、ユーザーは再度リクエストを発行すべきです。リクエストを再発行する際に、失敗を正しく処理するのはユーザー自身の責任です。例えば、再試行時に同じタスクIDを使うと、前の操作が成功した場合、予期せず追加のタスクが作成されないようにしましょう。もしレスポンスに追加に失敗したタスクが含まれていれば、クライアントはリクエストを再試行できます。再試行では、追加できなかったタスクのみを再提出し、最初の試みで成功裏に追加されたタスクは省略するのが最も効率的です。タスクの追加から完了までの最大寿命は180日です。タスクが追加されてから180日以内に完了しなかった場合、バッチサービスによって終了され、その時点での状態のまま残されます。
deallocateNode(string, string, DeallocateNodeOptionalParams)	コンピューティングノードの割り当てを解除できるのは、アイドル状態または実行中の状態の場合のみです。
deleteJob(string, DeleteJobOptionalParams)	ジョブを削除すると、そのジョブに含まれるすべてのタスクやジョブ統計も削除されます。これによりタスクデータの保持期間も上書きされます。つまり、ジョブにComputeノード上に保持されているタスクが含まれている場合、バッチサービスはそれらの作業ディレクトリとそのすべての内容を削除します。 Delete Jobリクエストが受信されると、バッチサービスはジョブを削除状態に設定します。削除状態にあるジョブに対するすべての更新操作は、ステータスコード409(コンフリクト)で失敗し、ジョブが削除されていることを示す追加情報が表示されます。
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)	ジョブスケジュールを削除すると、そのスケジュール下のすべてのジョブとタスクも削除されます。タスクが削除されると、コンピュートノード上の作業ディレクトリ内のすべてのファイルも削除されます(保持期間は無視されます)。ジョブスケジュールの統計は、ジョブスケジュールを削除するとアクセスできなくなりますが、アカウントのライフタイム統計には引き続きカウントされます。
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)	指定されたファイルをCompute Nodeから削除します。
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)	ユーザーアカウントは、アイドル状態または実行中の状態でのみコンピュートノードのアカウントを削除できます。コンピュートノードにリモートでログインする前に、SSHとRDP用のアクセスポートを設定する必要があります。詳細については、https://learn.microsoft.com/azure/batch/pool-endpoint-configuration を参照してください。
deletePool(string, DeletePoolOptionalParams)	プールの削除を要求すると、プールの状態が削除に設定されているアクションが発生します。プールで進行中のサイズ変更操作は停止されます。Batch サービスは、プールのサイズを 0 個のコンピューティングノードに変更し始めます。既存のコンピューティングノードで実行されているタスクはすべて終了して再キューされます (既定の requeue オプションを使用してプールのサイズ変更操作が要求された場合と同様)。最後に、プールがシステムから削除されます。実行中のタスクは再キューされるため、ユーザーはジョブを更新して別のプールをターゲットにすることで、これらのタスクを再実行できます。その後、タスクは新しいプールで実行できます。再キューの動作をオーバーライドする場合は、プールを削除する前に、サイズ変更プールを明示的に呼び出してプールを 0 サイズに縮小する必要があります。削除中の状態のプールで Update、Patch、または Delete API を呼び出すと、エラーコード PoolBeingDeleted で HTTP 状態コード 409 で失敗します。
deleteTask(string, string, DeleteTaskOptionalParams)	タスクが削除されると、そのタスクが実行されたComputeノードのディレクトリ内のすべてのファイルも(保持期間に関係なく)削除されます。マルチインスタンスタスクの場合、削除タスク操作は主タスクに同期的に適用されます。その後、サブタスクとそのファイルはバックグラウンドで非同期で削除されます。
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)	タスクが実行されたCompute Nodeから指定されたタスクファイルを削除します。
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)	バッチサービスは即座にジョブを無効化状態に移行します。 BatchはdisableTasksパラメータを用いて、ジョブの現在実行中のタスクをどう処理するかを決定します。ジョブは無効化操作が完了し、すべてのタスクがdisableTasksオプションに従って処理されるまで無効化状態のままです。その後、ジョブは障害者状態に移ります。ジョブがアクティブ状態に戻るまでは新しいタスクは開始されません。アクティブ、無効化、無効化以外のジョブを無効化しようとすると、ステータスコード409でリクエストが失敗します。
disableJobSchedule(string, DisableJobScheduleOptionalParams)	ジョブスケジュールが再び有効になるまでは新しいジョブは作成されません。
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)	現在のスケジューリング状態が有効である場合にのみ、Compute Nodeのタスクスケジューリングを無効にできます。
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)	プールの自動スケーリングを無効にします。
enableJob(string, EnableJobOptionalParams)	このAPIを呼び出すと、バッチサービスは無効化されたジョブを有効状態に設定します。この操作が完了するとジョブはアクティブ状態に移行し、ジョブの下で新しいタスクのスケジューリングが再開されます。バッチサービスでは、タスクが180日以上アクティブ状態にとどまることはできません。したがって、180日以上前に追加されたアクティブなタスクを含むジョブを有効にすると、それらのタスクは実行されません。
enableJobSchedule(string, EnableJobScheduleOptionalParams)	仕事のスケジュールを促す。
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)	現在のスケジューリング状態が無効化された場合にのみ、Compute Nodeでタスクスケジューリングを有効にできます
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)	プールでサイズ変更操作が進行中の場合、プールで自動スケーリングを有効にすることはできません。プールの自動スケーリングが現在無効になっている場合は、要求の一部として有効な自動スケール式を指定する必要があります。プールの自動スケーリングが既に有効になっている場合は、新しい自動スケール式または新しい評価間隔を指定できます。同じプールに対してこの API を 30 秒ごとに複数回呼び出すことはできません。
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)	この API は、プールに数式を適用せずに結果を返すだけなので、主に自動スケール式を検証するための API です。数式を評価するには、プールで自動スケーリングが有効になっている必要があります。
getApplication(string, GetApplicationOptionalParams)	この操作は、コンピュートノードで利用可能なアプリケーションおよびバージョンのみを返します。つまり、パッケージ参照に使用できるものである。まだCompute Nodesに提供されていないアプリケーションやバージョンに関する管理者情報については、AzureポータルまたはAzure Resource Manager APIをご利用ください。
getJob(string, GetJobOptionalParams)	指定された仕事に関する情報を得る。
getJobSchedule(string, GetJobScheduleOptionalParams)	指定されたジョブスケジュールに関する情報を取得します。
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)	タスクカウントは、アクティブ、実行中、完了したタスクの状態ごとのタスク数と、成功または失敗したタスクの数を提供します。準備中の状態のタスクは、実行中としてカウントされます。返される数値が常に最新であるとは限りません。正確なタスク数が必要ならリストクエリを使いましょう。
getNode(string, string, GetNodeOptionalParams)	指定されたCompute Nodeに関する情報を取得します。
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)	指定されたCompute Node Extensionに関する情報を取得します。
getNodeFile(string, string, string, GetNodeFileOptionalParams)	指定されたCompute Nodeファイルの内容を返します。
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)	指定されたCompute Nodeファイルのプロパティを取得します。
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)	リモートログイン設定を使ってCompute Nodeにリモートログインする前に、Compute Nodeでユーザーアカウントを作成し、SSHとRDP用のアクセスポートを設定する必要があります。詳細については、https://learn.microsoft.com/azure/batch/pool-endpoint-configuration を参照してください。
getPool(string, GetPoolOptionalParams)	指定したプールに関する情報を取得します。
getTask(string, string, GetTaskOptionalParams)	マルチインスタンスタスクの場合、affinityId、executionInfo、nodeInfoなどの情報はプライマリタスクを指します。リストサブタスクAPIを使ってサブタスクに関する情報を取得してください。
getTaskFile(string, string, string, GetTaskFileOptionalParams)	指定されたタスクファイルの内容を返します。
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)	指定されたタスクファイルのプロパティを取得します。
jobScheduleExists(string, JobScheduleExistsOptionalParams)	指定されたジョブスケジュールが存在するか確認します。
listApplications(ListApplicationsOptionalParams)	この操作は、コンピュートノードで利用可能なアプリケーションおよびバージョンのみを返します。つまり、パッケージ参照に使用できるものである。 Compute Nodesにまだ利用できないアプリケーションやバージョンに関する管理者情報については、AzureポータルまたはAzure Resource Manager APIを使用してください。
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)	このAPIは、ジョブ準備またはジョブリリースタスクを実行したすべてのコンピュートノードに対してジョブプレプレゼンションおよびジョブリリースタスクの状態を返します。これには、現在プールから削除されたコンピュートノードも含まれます。このAPIがジョブプレプレジメントまたはジョブリリースタスクがないジョブで呼び出された場合、バッチサービスはHTTPステータスコード409(コンフリクト)を返し、エラーコードはJobPreparationTaskNotSpecifiedとなります。
listJobs(ListJobsOptionalParams)	指定されたアカウント内のすべてのジョブを一覧にします。
listJobSchedules(ListJobSchedulesOptionalParams)	指定されたアカウント内のすべてのジョブスケジュールを一覧にします。
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)	指定されたジョブスケジュールの下で作成されたジョブ一覧です。
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)	指定されたプール内の計算ノード拡張を一覧にします。
listNodeFiles(string, string, ListNodeFilesOptionalParams)	指定されたCompute Node上のタスクディレクトリ内のすべてのファイルを一覧にします。
listNodes(string, ListNodesOptionalParams)	指定されたプール内の計算ノードを一覧にします。
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)	プールごとにグループ化された、各状態のコンピューティングノードの数を取得します。返される数値が常に最新であるとは限りません。正確なノード数が必要な場合は、リストクエリを使用します。
listPools(ListPoolsOptionalParams)	指定したアカウント内のすべてのプールを一覧表示します。
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)	poolId を含む$filter句を指定しない場合、応答には、返された集計間隔の時間範囲内のアカウントに存在していたすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは、現在使用可能な最後の集計間隔の開始時刻と終了時刻に既定で設定されます。つまり、最後の集計間隔のみが返されます。
listSubTasks(string, string, ListSubTasksOptionalParams)	タスクがマルチインスタンスタスクでない場合、空のコレクションを返します。
listSupportedImages(ListSupportedImagesOptionalParams)	Azure Batch サービスでサポートされているすべての仮想マシンイメージを一覧表示します。
listTaskFiles(string, string, ListTaskFilesOptionalParams)	タスクのCompute Node上のディレクトリにあるファイル一覧。
listTasks(string, ListTasksOptionalParams)	マルチインスタンスタスクの場合、affinityId、executionInfo、nodeInfoなどの情報はプライマリタスクを指します。リストサブタスクAPIを使ってサブタスクに関する情報を取得してください。
poolExists(string, PoolExistsOptionalParams)	プールの基本的な性質を得ます。
reactivateTask(string, string, ReactivateTaskOptionalParams)	再発動すると、タスクは最大リトライ回数まで再挑戦可能になります。タスクの状態はアクティブに変更されます。タスクが完了状態にないため、再起動後は以前の終了コードや失敗情報は利用できません。タスクが再活性化されるたびに、その再試行回数は0にリセットされます。完了していないタスクや以前に成功裏に完了したタスク(終了コードが0の場合)では再アクティベーションは失敗します。さらに、ジョブが完了している(または終了・削除中)には失敗します。
rebootNode(string, string, RebootNodeOptionalParams)	コンピューティングノードは、アイドル状態または実行中の状態の場合にのみ再起動できます。
reimageNode(string, string, ReimageNodeOptionalParams)	オペレーティングシステムは、アイドル状態または実行中の状態の場合にのみ、コンピューティングノードに再インストールできます。このAPIは、クラウドサービス設定プロパティで作成されたプールでのみ呼び出せます。
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)	この操作は、プールの割り当て状態が安定している場合にのみ実行できます。この操作を実行すると、割り当ての状態が安定状態からサイズ変更に変わります。各要求では、最大 100 個のノードを削除できます。
replaceJob(string, BatchJob, ReplaceJobOptionalParams)	これによりジョブの更新可能なプロパティはすべて置き換えられます。例えば、ジョブに制約が関連付けられていて、この要求で制約が指定されていなければ、バッチサービスは既存の制約を削除します。
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)	これにより、ジョブスケジュールのすべての更新可能なプロパティが完全に置き換えられます。例えば、このリクエストでスケジュールプロパティが指定されていない場合、バッチサービスは既存のスケジュールを削除します。ジョブスケジュールの変更は、更新後にスケジュールによって作成されたジョブにのみ影響します。現在稼働中のジョブは影響を受けていません。
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)	この操作はアカウントのすべての更新可能なプロパティを置き換えます。例えば、expiryTime要素が指定されていない場合、現在の値はデフォルト値に置き換えられ、変更せずに残されません。ユーザーアカウントは、コンピュートノードがアイドルまたは実行中の状態にある場合にのみ更新できます。
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)	これにより、プールの更新可能なプロパティはすべて置き換えられます。例えば、プールにStartTaskが関連付けられていて、このリクエストでStartTaskが指定されていない場合、バッチサービスは既存のStartTaskを削除します。
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)	指定されたタスクのプロパティを更新します。
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)	プールのサイズを変更できるのは、その割り当て状態が安定している場合のみです。プールのサイズが既に変更されている場合、要求は状態コード 409 で失敗します。プールのサイズを変更すると、プールの割り当ての状態が安定した状態からサイズ変更に変わります。自動スケーリング用に構成されているプールのサイズを変更することはできません。これを行おうとすると、Batch サービスからエラー 409 が返されます。プールのサイズを下方向に変更すると、削除するコンピューティングノードが Batch サービスによって選択されます。特定のコンピューティングノードを削除するには、代わりにプールのコンピューティングノードの削除 API を使用します。
startNode(string, string, StartNodeOptionalParams)	コンピュートノードは、デロケーションされている場合にのみ起動可能です。
stopPoolResize(string, StopPoolResizeOptionalParams)	これにより、リサイズ操作前のプールの状態に戻るわけではなく、今後の変更が停止され、プールは現在の状態を維持します。停止後、プールは停止操作時の計算ノード数で安定します。停止操作中、プール割り当て状態はまず停止状態、次に安定状態に変化します。リサイズ操作は明示的なリサイズプール要求である必要はありません。このAPIは、プールの作成時に初期サイズ化を停止するためにも使用できます。
terminateJob(string, TerminateJobOptionalParams)	Terminate Jobリクエストが受信されると、バッチサービスはジョブを終了状態に設定します。バッチサービスはその後、ジョブに関連付けられた実行中のタスクを終了し、必要なジョブリリースタスクを実行します。その後、ジョブは完成状態に移行します。もしジョブにアクティブな状態にあるタスクがあれば、それらはアクティブな状態のままです。ジョブが終了すると、新しいタスクを追加できず、残っているアクティブなタスクもスケジュールされません。
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)	仕事のスケジュールを終了します。
terminateTask(string, string, TerminateTaskOptionalParams)	タスクが終了すると、完了状態に移行します。マルチインスタンスタスクの場合、終了タスク操作は主タスクに同期的に適用されます。その後、サブタスクはバックグラウンドで非同期で終了されます。
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)	これはリクエストで指定されたジョブプロパティのみを置き換えます。例えば、ジョブに制約があり、要求が制約要素を指定していない場合、ジョブは既存の制約を保持します。
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)	これにより、リクエストで指定されたジョブスケジュールプロパティのみが置き換えられます。例えば、このリクエストでスケジュールプロパティが指定されていない場合、バッチサービスは既存のスケジュールを保持します。ジョブスケジュールの変更は、更新後にスケジュールによって作成されたジョブにのみ影響します。現在稼働中のジョブは影響を受けていません。
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)	これはリクエストで指定されたプールプロパティのみを置き換えます。例えば、プールにStartTaskが関連付けられていて、リクエストがStartTask要素を指定していない場合、プールは既存のStartTaskを保持します。
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)	これは、エラーが発生しAzureサポートにエスカレーションしたい場合は、Compute NodesからAzure Batchサービスのログファイルを自動化して収集するためのものです。 Batch サービスに関する問題のデバッグを支援するために、Azure Batch サービスのログファイルを Azure サポートと共有する必要があります。

コンストラクターの詳細

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)

パラメーター

endpointParam: string

credential: TokenCredential | AzureNamedKeyCredential

options: BatchClientOptionalParams

メソッドの詳細

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

バッチサービスは、ジョブの一部として行われる作業を制御する2つの方法をサポートしています。最初の方法では、ユーザーがジョブマネージャータスクを指定します。バッチサービスはジョブ開始の準備ができたときにこのタスクを起動します。ジョブマネージャータスクは、タスクAPIを使ってこのジョブの下で実行されるすべてのタスクを制御します。 2つ目のアプローチでは、ユーザーがタスクAPIを使ってアクティブなジョブ下でのタスクの実行を直接制御します。また、ジョブ名を付ける際は、ユーザー名や秘密のプロジェクト名などの機密情報を含めるのは避けてください。この情報は、Microsoft サポートエンジニアがアクセスできるテレメトリログに表示される場合があります。

function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>

パラメーター

job: BatchJobCreateOptions

options: CreateJobOptionalParams

戻り値

Promise<void>

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

指定されたアカウントにジョブスケジュールを作成します。

function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>

パラメーター

jobSchedule: BatchJobScheduleCreateOptions

options: CreateJobScheduleOptionalParams

戻り値

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

ユーザーアカウントは、コンピュートノードがアイドルまたは実行中の状態の場合にのみ追加できます。コンピュートノードにリモートでログインする前に、SSHとRDP用のアクセスポートを設定する必要があります。詳細については、https://learn.microsoft.com/azure/batch/pool-endpoint-configuration を参照してください。

function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>

パラメーター

poolId: string

nodeId: string

user: BatchNodeUserCreateOptions

options: CreateNodeUserOptionalParams

戻り値

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

プールに名前を付ける場合は、ユーザー名やシークレットプロジェクト名などの機密情報を含めないでください。この情報は、Microsoft サポートエンジニアがアクセスできるテレメトリログに表示される場合があります。

function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>

パラメーター

pool: BatchPoolCreateOptions

options: CreatePoolOptionalParams

戻り値

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

タスクの追加から完了までの最大寿命は180日です。タスクが追加されてから180日以内に完了しなかった場合、バッチサービスによって終了され、その時点での状態のまま残されます。

function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>

パラメーター

jobId: string

task: BatchTaskCreateOptions

options: CreateTaskOptionalParams

戻り値

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

各タスクは一意のIDを持つ必要があることに注意してください。バッチサービスは、このリクエストで提出されたタスクと同じ順序で各タスクの結果を返すことはできません。サーバーがタイムアウトしたり、リクエスト中に接続が閉じられた場合、リクエストは部分的または完全に処理された場合、あるいは全く処理されていない可能性があります。その場合、ユーザーは再度リクエストを発行すべきです。リクエストを再発行する際に、失敗を正しく処理するのはユーザー自身の責任です。例えば、再試行時に同じタスクIDを使うと、前の操作が成功した場合、予期せず追加のタスクが作成されないようにしましょう。もしレスポンスに追加に失敗したタスクが含まれていれば、クライアントはリクエストを再試行できます。再試行では、追加できなかったタスクのみを再提出し、最初の試みで成功裏に追加されたタスクは省略するのが最も効率的です。タスクの追加から完了までの最大寿命は180日です。タスクが追加されてから180日以内に完了しなかった場合、バッチサービスによって終了され、その時点での状態のまま残されます。

function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>

パラメーター

jobId: string

taskCollection: BatchTaskGroup

options: CreateTaskCollectionOptionalParams

戻り値

Promise<BatchCreateTaskCollectionResult>

deallocateNode(string, string, DeallocateNodeOptionalParams)

コンピューティングノードの割り当てを解除できるのは、アイドル状態または実行中の状態の場合のみです。

function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

poolId: string

nodeId: string

options: DeallocateNodeOptionalParams

戻り値

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

ジョブを削除すると、そのジョブに含まれるすべてのタスクやジョブ統計も削除されます。これによりタスクデータの保持期間も上書きされます。つまり、ジョブにComputeノード上に保持されているタスクが含まれている場合、バッチサービスはそれらの作業ディレクトリとそのすべての内容を削除します。 Delete Jobリクエストが受信されると、バッチサービスはジョブを削除状態に設定します。削除状態にあるジョブに対するすべての更新操作は、ステータスコード409(コンフリクト)で失敗し、ジョブが削除されていることを示す追加情報が表示されます。

function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

jobId: string

options: DeleteJobOptionalParams

戻り値

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

ジョブスケジュールを削除すると、そのスケジュール下のすべてのジョブとタスクも削除されます。タスクが削除されると、コンピュートノード上の作業ディレクトリ内のすべてのファイルも削除されます(保持期間は無視されます)。ジョブスケジュールの統計は、ジョブスケジュールを削除するとアクセスできなくなりますが、アカウントのライフタイム統計には引き続きカウントされます。

function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

jobScheduleId: string

options: DeleteJobScheduleOptionalParams

戻り値

PollerLike<OperationState<void>, void>

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

指定されたファイルをCompute Nodeから削除します。

function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>

パラメーター

poolId: string

nodeId: string

filePath: string

options: DeleteNodeFileOptionalParams

戻り値

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

ユーザーアカウントは、アイドル状態または実行中の状態でのみコンピュートノードのアカウントを削除できます。コンピュートノードにリモートでログインする前に、SSHとRDP用のアクセスポートを設定する必要があります。詳細については、https://learn.microsoft.com/azure/batch/pool-endpoint-configuration を参照してください。

function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>

パラメーター

poolId: string

nodeId: string

userName: string

options: DeleteNodeUserOptionalParams

戻り値

Promise<void>

deletePool(string, DeletePoolOptionalParams)

プールの削除を要求すると、プールの状態が削除に設定されているアクションが発生します。プールで進行中のサイズ変更操作は停止されます。Batch サービスは、プールのサイズを 0 個のコンピューティングノードに変更し始めます。既存のコンピューティングノードで実行されているタスクはすべて終了して再キューされます (既定の requeue オプションを使用してプールのサイズ変更操作が要求された場合と同様)。最後に、プールがシステムから削除されます。実行中のタスクは再キューされるため、ユーザーはジョブを更新して別のプールをターゲットにすることで、これらのタスクを再実行できます。その後、タスクは新しいプールで実行できます。再キューの動作をオーバーライドする場合は、プールを削除する前に、サイズ変更プールを明示的に呼び出してプールを 0 サイズに縮小する必要があります。削除中の状態のプールで Update、Patch、または Delete API を呼び出すと、エラーコード PoolBeingDeleted で HTTP 状態コード 409 で失敗します。

function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

poolId: string

options: DeletePoolOptionalParams

戻り値

PollerLike<OperationState<void>, void>

deleteTask(string, string, DeleteTaskOptionalParams)

タスクが削除されると、そのタスクが実行されたComputeノードのディレクトリ内のすべてのファイルも(保持期間に関係なく)削除されます。マルチインスタンスタスクの場合、削除タスク操作は主タスクに同期的に適用されます。その後、サブタスクとそのファイルはバックグラウンドで非同期で削除されます。

function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>

パラメーター

jobId: string

taskId: string

options: DeleteTaskOptionalParams

戻り値

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

タスクが実行されたCompute Nodeから指定されたタスクファイルを削除します。

function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>

パラメーター

jobId: string

taskId: string

filePath: string

options: DeleteTaskFileOptionalParams

戻り値

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

バッチサービスは即座にジョブを無効化状態に移行します。 BatchはdisableTasksパラメータを用いて、ジョブの現在実行中のタスクをどう処理するかを決定します。ジョブは無効化操作が完了し、すべてのタスクがdisableTasksオプションに従って処理されるまで無効化状態のままです。その後、ジョブは障害者状態に移ります。ジョブがアクティブ状態に戻るまでは新しいタスクは開始されません。アクティブ、無効化、無効化以外のジョブを無効化しようとすると、ステータスコード409でリクエストが失敗します。

function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

jobId: string

disableOptions: BatchJobDisableOptions

options: DisableJobOptionalParams

戻り値

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

ジョブスケジュールが再び有効になるまでは新しいジョブは作成されません。

function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>

パラメーター

jobScheduleId: string

options: DisableJobScheduleOptionalParams

戻り値

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

現在のスケジューリング状態が有効である場合にのみ、Compute Nodeのタスクスケジューリングを無効にできます。

function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>

パラメーター

poolId: string

nodeId: string

options: DisableNodeSchedulingOptionalParams

戻り値

Promise<void>

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

プールの自動スケーリングを無効にします。

function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>

パラメーター

poolId: string

options: DisablePoolAutoScaleOptionalParams

戻り値

Promise<void>

enableJob(string, EnableJobOptionalParams)

このAPIを呼び出すと、バッチサービスは無効化されたジョブを有効状態に設定します。この操作が完了するとジョブはアクティブ状態に移行し、ジョブの下で新しいタスクのスケジューリングが再開されます。バッチサービスでは、タスクが180日以上アクティブ状態にとどまることはできません。したがって、180日以上前に追加されたアクティブなタスクを含むジョブを有効にすると、それらのタスクは実行されません。

function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

jobId: string

options: EnableJobOptionalParams

戻り値

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

仕事のスケジュールを促す。

function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>

パラメーター

jobScheduleId: string

options: EnableJobScheduleOptionalParams

戻り値

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

現在のスケジューリング状態が無効化された場合にのみ、Compute Nodeでタスクスケジューリングを有効にできます

function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>

パラメーター

poolId: string

nodeId: string

options: EnableNodeSchedulingOptionalParams

戻り値

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

プールでサイズ変更操作が進行中の場合、プールで自動スケーリングを有効にすることはできません。プールの自動スケーリングが現在無効になっている場合は、要求の一部として有効な自動スケール式を指定する必要があります。プールの自動スケーリングが既に有効になっている場合は、新しい自動スケール式または新しい評価間隔を指定できます。同じプールに対してこの API を 30 秒ごとに複数回呼び出すことはできません。

function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>

パラメーター

poolId: string

enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions

options: EnablePoolAutoScaleOptionalParams

戻り値

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

この API は、プールに数式を適用せずに結果を返すだけなので、主に自動スケール式を検証するための API です。数式を評価するには、プールで自動スケーリングが有効になっている必要があります。

function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>

パラメーター

poolId: string

evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions

options: EvaluatePoolAutoScaleOptionalParams

戻り値

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

この操作は、コンピュートノードで利用可能なアプリケーションおよびバージョンのみを返します。つまり、パッケージ参照に使用できるものである。まだCompute Nodesに提供されていないアプリケーションやバージョンに関する管理者情報については、AzureポータルまたはAzure Resource Manager APIをご利用ください。

function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>

パラメーター

applicationId: string

options: GetApplicationOptionalParams

戻り値

Promise<BatchApplication>

getJob(string, GetJobOptionalParams)

指定された仕事に関する情報を得る。

function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>

パラメーター

jobId: string

options: GetJobOptionalParams

戻り値

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

指定されたジョブスケジュールに関する情報を取得します。

function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>

パラメーター

jobScheduleId: string

options: GetJobScheduleOptionalParams

戻り値

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

タスクカウントは、アクティブ、実行中、完了したタスクの状態ごとのタスク数と、成功または失敗したタスクの数を提供します。準備中の状態のタスクは、実行中としてカウントされます。返される数値が常に最新であるとは限りません。正確なタスク数が必要ならリストクエリを使いましょう。

function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>

パラメーター

jobId: string

options: GetJobTaskCountsOptionalParams

戻り値

Promise<BatchTaskCountsResult>

getNode(string, string, GetNodeOptionalParams)

指定されたCompute Nodeに関する情報を取得します。

function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>

パラメーター

poolId: string

nodeId: string

options: GetNodeOptionalParams

戻り値

Promise<BatchNode>

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

指定されたCompute Node Extensionに関する情報を取得します。

function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>

パラメーター

poolId: string

nodeId: string

extensionName: string

options: GetNodeExtensionOptionalParams

戻り値

Promise<BatchNodeVMExtension>

getNodeFile(string, string, string, GetNodeFileOptionalParams)

指定されたCompute Nodeファイルの内容を返します。

function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>

パラメーター

poolId: string

nodeId: string

filePath: string

options: GetNodeFileOptionalParams

戻り値

Promise<Uint8Array>

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

指定されたCompute Nodeファイルのプロパティを取得します。

function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>

パラメーター

poolId: string

nodeId: string

filePath: string

options: GetNodeFilePropertiesOptionalParams

戻り値

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

リモートログイン設定を使ってCompute Nodeにリモートログインする前に、Compute Nodeでユーザーアカウントを作成し、SSHとRDP用のアクセスポートを設定する必要があります。詳細については、https://learn.microsoft.com/azure/batch/pool-endpoint-configuration を参照してください。

function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>

パラメーター

poolId: string

nodeId: string

options: GetNodeRemoteLoginSettingsOptionalParams

戻り値

Promise<BatchNodeRemoteLoginSettings>

getPool(string, GetPoolOptionalParams)

指定したプールに関する情報を取得します。

function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>

パラメーター

poolId: string

options: GetPoolOptionalParams

戻り値

Promise<BatchPool>

getTask(string, string, GetTaskOptionalParams)

マルチインスタンスタスクの場合、affinityId、executionInfo、nodeInfoなどの情報はプライマリタスクを指します。リストサブタスクAPIを使ってサブタスクに関する情報を取得してください。

function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>

パラメーター

jobId: string

taskId: string

options: GetTaskOptionalParams

戻り値

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

指定されたタスクファイルの内容を返します。

function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>

パラメーター

jobId: string

taskId: string

filePath: string

options: GetTaskFileOptionalParams

戻り値

Promise<Uint8Array>

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

指定されたタスクファイルのプロパティを取得します。

function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>

パラメーター

jobId: string

taskId: string

filePath: string

options: GetTaskFilePropertiesOptionalParams

戻り値

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

指定されたジョブスケジュールが存在するか確認します。

function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>

パラメーター

jobScheduleId: string

options: JobScheduleExistsOptionalParams

戻り値

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

この操作は、コンピュートノードで利用可能なアプリケーションおよびバージョンのみを返します。つまり、パッケージ参照に使用できるものである。 Compute Nodesにまだ利用できないアプリケーションやバージョンに関する管理者情報については、AzureポータルまたはAzure Resource Manager APIを使用してください。

function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

パラメーター

options: ListApplicationsOptionalParams

戻り値

PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

このAPIは、ジョブ準備またはジョブリリースタスクを実行したすべてのコンピュートノードに対してジョブプレプレゼンションおよびジョブリリースタスクの状態を返します。これには、現在プールから削除されたコンピュートノードも含まれます。このAPIがジョブプレプレジメントまたはジョブリリースタスクがないジョブで呼び出された場合、バッチサービスはHTTPステータスコード409(コンフリクト)を返し、エラーコードはJobPreparationTaskNotSpecifiedとなります。

function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

パラメーター

jobId: string

options: ListJobPreparationAndReleaseTaskStatusOptionalParams

戻り値

PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

listJobs(ListJobsOptionalParams)

指定されたアカウント内のすべてのジョブを一覧にします。

function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

パラメーター

options: ListJobsOptionalParams

戻り値

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listJobSchedules(ListJobSchedulesOptionalParams)

指定されたアカウント内のすべてのジョブスケジュールを一覧にします。

function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

パラメーター

options: ListJobSchedulesOptionalParams

戻り値

PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

指定されたジョブスケジュールの下で作成されたジョブ一覧です。

function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

パラメーター

jobScheduleId: string

options: ListJobsFromScheduleOptionalParams

戻り値

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

指定されたプール内の計算ノード拡張を一覧にします。

function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

パラメーター

poolId: string

nodeId: string

options: ListNodeExtensionsOptionalParams

戻り値

PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

listNodeFiles(string, string, ListNodeFilesOptionalParams)

指定されたCompute Node上のタスクディレクトリ内のすべてのファイルを一覧にします。

function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

パラメーター

poolId: string

nodeId: string

options: ListNodeFilesOptionalParams

戻り値

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listNodes(string, ListNodesOptionalParams)

指定されたプール内の計算ノードを一覧にします。

function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

パラメーター

poolId: string

options: ListNodesOptionalParams

戻り値

PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

プールごとにグループ化された、各状態のコンピューティングノードの数を取得します。返される数値が常に最新であるとは限りません。正確なノード数が必要な場合は、リストクエリを使用します。

function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

パラメーター

options: ListPoolNodeCountsOptionalParams

戻り値

PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

listPools(ListPoolsOptionalParams)

指定したアカウント内のすべてのプールを一覧表示します。

function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

パラメーター

options: ListPoolsOptionalParams

戻り値

PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

poolId を含む$filter句を指定しない場合、応答には、返された集計間隔の時間範囲内のアカウントに存在していたすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは、現在使用可能な最後の集計間隔の開始時刻と終了時刻に既定で設定されます。つまり、最後の集計間隔のみが返されます。

function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

パラメーター

options: ListPoolUsageMetricsOptionalParams

戻り値

PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

listSubTasks(string, string, ListSubTasksOptionalParams)

タスクがマルチインスタンスタスクでない場合、空のコレクションを返します。

function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

パラメーター

jobId: string

taskId: string

options: ListSubTasksOptionalParams

戻り値

PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

listSupportedImages(ListSupportedImagesOptionalParams)

Azure Batch サービスでサポートされているすべての仮想マシンイメージを一覧表示します。

function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

パラメーター

options: ListSupportedImagesOptionalParams

戻り値

PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

listTaskFiles(string, string, ListTaskFilesOptionalParams)

タスクのCompute Node上のディレクトリにあるファイル一覧。

function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

パラメーター

jobId: string

taskId: string

options: ListTaskFilesOptionalParams

戻り値

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listTasks(string, ListTasksOptionalParams)

function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

パラメーター

jobId: string

options: ListTasksOptionalParams

戻り値

PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

poolExists(string, PoolExistsOptionalParams)

プールの基本的な性質を得ます。

function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>

パラメーター

poolId: string

options: PoolExistsOptionalParams

戻り値

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

再発動すると、タスクは最大リトライ回数まで再挑戦可能になります。タスクの状態はアクティブに変更されます。タスクが完了状態にないため、再起動後は以前の終了コードや失敗情報は利用できません。タスクが再活性化されるたびに、その再試行回数は0にリセットされます。完了していないタスクや以前に成功裏に完了したタスク(終了コードが0の場合)では再アクティベーションは失敗します。さらに、ジョブが完了している(または終了・削除中)には失敗します。

function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>

パラメーター

jobId: string

taskId: string

options: ReactivateTaskOptionalParams

戻り値

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

コンピューティングノードは、アイドル状態または実行中の状態の場合にのみ再起動できます。

function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

poolId: string

nodeId: string

options: RebootNodeOptionalParams

戻り値

PollerLike<OperationState<void>, void>

reimageNode(string, string, ReimageNodeOptionalParams)

オペレーティングシステムは、アイドル状態または実行中の状態の場合にのみ、コンピューティングノードに再インストールできます。このAPIは、クラウドサービス設定プロパティで作成されたプールでのみ呼び出せます。

function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

poolId: string

nodeId: string

options: ReimageNodeOptionalParams

戻り値

PollerLike<OperationState<void>, void>

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

この操作は、プールの割り当て状態が安定している場合にのみ実行できます。この操作を実行すると、割り当ての状態が安定状態からサイズ変更に変わります。各要求では、最大 100 個のノードを削除できます。

function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

poolId: string

removeOptions: BatchNodeRemoveOptions

options: RemoveNodesOptionalParams

戻り値

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

これによりジョブの更新可能なプロパティはすべて置き換えられます。例えば、ジョブに制約が関連付けられていて、この要求で制約が指定されていなければ、バッチサービスは既存の制約を削除します。

function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>

パラメーター

jobId: string

job: BatchJob

options: ReplaceJobOptionalParams

戻り値

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

これにより、ジョブスケジュールのすべての更新可能なプロパティが完全に置き換えられます。例えば、このリクエストでスケジュールプロパティが指定されていない場合、バッチサービスは既存のスケジュールを削除します。ジョブスケジュールの変更は、更新後にスケジュールによって作成されたジョブにのみ影響します。現在稼働中のジョブは影響を受けていません。

function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>

パラメーター

jobScheduleId: string

jobSchedule: BatchJobSchedule

options: ReplaceJobScheduleOptionalParams

戻り値

Promise<void>

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

この操作はアカウントのすべての更新可能なプロパティを置き換えます。例えば、expiryTime要素が指定されていない場合、現在の値はデフォルト値に置き換えられ、変更せずに残されません。ユーザーアカウントは、コンピュートノードがアイドルまたは実行中の状態にある場合にのみ更新できます。

function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>

パラメーター

poolId: string

nodeId: string

userName: string

updateOptions: BatchNodeUserUpdateOptions

options: ReplaceNodeUserOptionalParams

戻り値

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

これにより、プールの更新可能なプロパティはすべて置き換えられます。例えば、プールにStartTaskが関連付けられていて、このリクエストでStartTaskが指定されていない場合、バッチサービスは既存のStartTaskを削除します。

function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>

パラメーター

poolId: string

pool: BatchPoolReplaceOptions

options: ReplacePoolPropertiesOptionalParams

戻り値

Promise<void>

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

指定されたタスクのプロパティを更新します。

function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>

パラメーター

jobId: string

taskId: string

task: BatchTask

options: ReplaceTaskOptionalParams

戻り値

Promise<void>

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

プールのサイズを変更できるのは、その割り当て状態が安定している場合のみです。プールのサイズが既に変更されている場合、要求は状態コード 409 で失敗します。プールのサイズを変更すると、プールの割り当ての状態が安定した状態からサイズ変更に変わります。自動スケーリング用に構成されているプールのサイズを変更することはできません。これを行おうとすると、Batch サービスからエラー 409 が返されます。プールのサイズを下方向に変更すると、削除するコンピューティングノードが Batch サービスによって選択されます。特定のコンピューティングノードを削除するには、代わりにプールのコンピューティングノードの削除 API を使用します。

function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

poolId: string

resizeOptions: BatchPoolResizeOptions

options: ResizePoolOptionalParams

戻り値

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

コンピュートノードは、デロケーションされている場合にのみ起動可能です。

function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

poolId: string

nodeId: string

options: StartNodeOptionalParams

戻り値

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

これにより、リサイズ操作前のプールの状態に戻るわけではなく、今後の変更が停止され、プールは現在の状態を維持します。停止後、プールは停止操作時の計算ノード数で安定します。停止操作中、プール割り当て状態はまず停止状態、次に安定状態に変化します。リサイズ操作は明示的なリサイズプール要求である必要はありません。このAPIは、プールの作成時に初期サイズ化を停止するためにも使用できます。

function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

poolId: string

options: StopPoolResizeOptionalParams

戻り値

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

Terminate Jobリクエストが受信されると、バッチサービスはジョブを終了状態に設定します。バッチサービスはその後、ジョブに関連付けられた実行中のタスクを終了し、必要なジョブリリースタスクを実行します。その後、ジョブは完成状態に移行します。もしジョブにアクティブな状態にあるタスクがあれば、それらはアクティブな状態のままです。ジョブが終了すると、新しいタスクを追加できず、残っているアクティブなタスクもスケジュールされません。

function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

jobId: string

options: TerminateJobOptionalParams

戻り値

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

仕事のスケジュールを終了します。

function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

パラメーター

jobScheduleId: string

options: TerminateJobScheduleOptionalParams

戻り値

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

タスクが終了すると、完了状態に移行します。マルチインスタンスタスクの場合、終了タスク操作は主タスクに同期的に適用されます。その後、サブタスクはバックグラウンドで非同期で終了されます。

function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>

パラメーター

jobId: string

taskId: string

options: TerminateTaskOptionalParams

戻り値

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

これはリクエストで指定されたジョブプロパティのみを置き換えます。例えば、ジョブに制約があり、要求が制約要素を指定していない場合、ジョブは既存の制約を保持します。

function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>

パラメーター

jobId: string

job: BatchJobUpdateOptions

options: UpdateJobOptionalParams

戻り値

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

これにより、リクエストで指定されたジョブスケジュールプロパティのみが置き換えられます。例えば、このリクエストでスケジュールプロパティが指定されていない場合、バッチサービスは既存のスケジュールを保持します。ジョブスケジュールの変更は、更新後にスケジュールによって作成されたジョブにのみ影響します。現在稼働中のジョブは影響を受けていません。

function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>

パラメーター

jobScheduleId: string

jobSchedule: BatchJobScheduleUpdateOptions

options: UpdateJobScheduleOptionalParams

戻り値

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

これはリクエストで指定されたプールプロパティのみを置き換えます。例えば、プールにStartTaskが関連付けられていて、リクエストがStartTask要素を指定していない場合、プールは既存のStartTaskを保持します。

function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>

パラメーター

poolId: string

pool: BatchPoolUpdateOptions

options: UpdatePoolOptionalParams

戻り値

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

これは、エラーが発生しAzureサポートにエスカレーションしたい場合は、Compute NodesからAzure Batchサービスのログファイルを自動化して収集するためのものです。 Batch サービスに関する問題のデバッグを支援するために、Azure Batch サービスのログファイルを Azure サポートと共有する必要があります。

function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>

パラメーター

poolId: string

nodeId: string

uploadOptions: UploadBatchServiceLogsOptions

options: UploadNodeLogsOptionalParams

戻り値

Promise<UploadBatchServiceLogsResult>

フィードバック

このページはお役に立ちましたか?

次の方法で共有

BatchClient class

コンストラクター

メソッド

コンストラクターの詳細

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

パラメーター

メソッドの詳細

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

パラメーター

戻り値

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

パラメーター

戻り値

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

パラメーター

戻り値

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

パラメーター

戻り値

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

パラメーター

戻り値

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

パラメーター

戻り値

deallocateNode(string, string, DeallocateNodeOptionalParams)

パラメーター

戻り値

deleteJob(string, DeleteJobOptionalParams)

パラメーター

戻り値

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

パラメーター

戻り値

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

パラメーター

戻り値

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

パラメーター

戻り値

deletePool(string, DeletePoolOptionalParams)

パラメーター

戻り値

deleteTask(string, string, DeleteTaskOptionalParams)

パラメーター

戻り値

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

パラメーター

戻り値

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

パラメーター

戻り値

disableJobSchedule(string, DisableJobScheduleOptionalParams)

パラメーター

戻り値

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

パラメーター

戻り値

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

パラメーター

戻り値

enableJob(string, EnableJobOptionalParams)

パラメーター

戻り値

enableJobSchedule(string, EnableJobScheduleOptionalParams)

パラメーター

戻り値

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

パラメーター

戻り値

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

パラメーター

戻り値

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

パラメーター

戻り値

getApplication(string, GetApplicationOptionalParams)

パラメーター

戻り値