Nodes - Disable Node Scheduling

サービス:: Batch Service

API バージョン:: 2025-06-01

指定されたコンピュートノードでのタスクスケジューリングを無効化します。
現在のスケジューリング状態が有効である場合にのみ、Compute Nodeのタスクスケジューリングを無効にできます。

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/disablescheduling?api-version=2025-06-01

省略可能なパラメーターを含む:

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/disablescheduling?api-version=2025-06-01&timeOut={timeOut}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	Batch アカウントエンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。
nodeId	path	True	string	タスクスケジューリングを無効にしたいComputeノードのIDです。
poolId	path	True	string	コンピューティングノードを含むプールの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
timeOut	query		integer (int32)	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。値が30より大きい場合は、デフォルトが使われます。」

要求ヘッダー

Media Types: "application/json; odata=minimalmetadata"

名前	型	説明
client-request-id	string	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id	boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date	string (date-time-rfc7231)	要求が発行された時刻。通常、クライアントライブラリはこれを現在のシステムクロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

要求本文

Media Types: "application/json; odata=minimalmetadata"

名前	型	説明
nodeDisableSchedulingOption	BatchNodeDisableSchedulingOption	Compute Nodeでタスクスケジューリングを無効にした場合、現在タスクを実行している場合にどうすればよいでしょうか。既定値は requeue です。

応答

名前	型	説明
200 OK		要求は成功しました。ヘッダー DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	予期しないエラー応答。

名前

型

説明

200 OK

要求は成功しました。

ヘッダー

DataServiceId: string
ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://batch.core.windows.net//.default

例

Node disable scheduling

要求のサンプル

HTTP

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/disablescheduling?api-version=2025-06-01

応答のサンプル

状態コード:: 200

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
BatchNodeDisableSchedulingOption	BatchNodeDisableSchedulingOption enums
BatchNodeDisableSchedulingOptions	Azure Batch コンピューティングノードでスケジュールを無効にするためのパラメーター。

BatchError

Object

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
message	BatchErrorMessage	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Object

Azure Batch エラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

BatchErrorMessage

Object

Azure Batch エラー応答で受信したエラーメッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード。
value	string	メッセージのテキスト。

BatchNodeDisableSchedulingOption

列挙

BatchNodeDisableSchedulingOption enums

値	説明
requeue	実行中のタスクプロセスを終了し、タスクを再キューします。タスクは他のコンピュートノードで再実行されるか、このコンピュートノードでタスクスケジューリングが再有効化された際に実行されることがあります。タスクが終了したらすぐにオフライン状態に入ります。
terminate	実行中のタスクを終了します。タスクは、終了されたことを示す failureInfo で完了し、もう一度実行されません。タスクが終了したらすぐにオフライン状態に入ります。
taskcompletion	現在実行中のタスクの完了を許可します。待機中に新しいタスクをスケジュールしません。すべてのタスクが完了したらオフライン状態に入ります。

BatchNodeDisableSchedulingOptions

Object

Azure Batch コンピューティングノードでスケジュールを無効にするためのパラメーター。

名前	型	説明
nodeDisableSchedulingOption	BatchNodeDisableSchedulingOption	Compute Nodeでタスクスケジューリングを無効にした場合、現在タスクを実行している場合にどうすればよいでしょうか。既定値は requeue です。