Job - Disable

リファレンス

サービス:: Batch Service

API バージョン:: 2024-07-01.20.0

指定したジョブを無効にして、新しいタスクが実行されないようにします。
Batch サービスは、ジョブをすぐに無効化状態に移動します。次に、Batch は disableTasks パラメーターを使用して、ジョブの現在実行中のタスクの処理を決定します。無効化操作が完了し、disableTasks オプションに従ってすべてのタスクが処理されるまで、ジョブは無効化状態のままになります。その後、ジョブは無効な状態に移行します。アクティブな状態に戻るまで、ジョブの下で新しいタスクは開始されません。アクティブ、無効化、または無効以外の状態のジョブを無効にしようとすると、要求は状態コード 409 で失敗します。

POST {batchUrl}/jobs/{jobId}/disable?api-version=2024-07-01.20.0

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

POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2024-07-01.20.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべての Azure Batch サービス要求のベース URL。
jobId	path	True	string	無効にするジョブの ID。
api-version	query	True	string	クライアント API のバージョン。
timeout	query		integer (int32)	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。値が 30 より大きい場合は、代わりに既定値が使用されます。

要求ヘッダー

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

名前	型	説明
client-request-id	string (uuid)	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id	boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date	string (date-time-rfc1123)	要求が発行された時刻。通常、クライアントライブラリはこれを現在のシステムクロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。
If-Match	string	クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と正確に一致する場合にのみ実行されます。
If-None-Match	string	クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と一致しない場合にのみ実行されます。
If-Modified-Since	string (date-time-rfc1123)	クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。この操作は、サービス上のリソースが指定された時刻以降に変更された場合にのみ実行されます。
If-Unmodified-Since	string (date-time-rfc1123)	クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。この操作は、指定した時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。

要求本文

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

名前	必須	型	説明
disableTasks	True	DisableJobOption	ジョブに関連付けられているアクティブなタスクの操作。

応答

名前	型	説明
202 Accepted		Batch サービスへの要求が成功しました。ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

202 Accepted

Batch サービスへの要求が成功しました。

ヘッダー

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

Other Status Codes

BatchError

Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コードフロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

Authorization

型: apiKey
/: header

例

Job disable

要求のサンプル

HTTP

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2024-07-01.20.0



{
  "disableTasks": "terminate"
}

応答のサンプル

状態コード:: 202

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
DisableJobOption	ジョブに関連付けられているアクティブなタスクの操作。
ErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
JobDisableParameter	ジョブを無効にする場合のオプション。

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

DisableJobOption

列挙

ジョブに関連付けられているアクティブなタスクの操作。

値	説明
requeue	実行中のタスクを終了し、それらを再キューします。ジョブが有効になると、タスクが再度実行されます。
terminate	実行中のタスクを終了します。タスクは、終了されたことを示す failureInfo で完了し、もう一度実行されません。
wait	現在実行中のタスクの完了を許可します。

ErrorMessage

Object

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

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

JobDisableParameter

Object

ジョブを無効にする場合のオプション。

名前	型	説明
disableTasks	DisableJobOption	ジョブに関連付けられているアクティブなタスクの操作。

次の方法で共有

Job - Disable

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

Authorization

例

Job disable

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

DisableJobOption

ErrorMessage

JobDisableParameter