Microsoft Azure

Azure Batch

Azure Batch provides Cloud-scale job scheduling and compute management.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Batch provides Cloud-scale job scheduling and compute management.

Endpoints 71

Applications

  • GETLists all of the applications available in the specified Account./applications?api-version=string&timeOut=0&maxresults=1000This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For…
  • GETGets information about the specified Application./applications/:applicationId?api-version=string&timeOut=0This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For…

Pools

  • GETPools_ListPoolNodeCounts/nodecounts?api-version=string&timeOut=0&maxresults=1000&$filter=stringGets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts,…
  • GETLists all of the Pools in the specified Account./pools?api-version=string&timeOut=0&maxresults=1000&$filter=string&$select=string&$expand=stringLists all of the Pools in the specified Account.
  • POSTCreates a Pool to the specified Account./pools?api-version=string&timeOut=0When naming Pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible…
  • GETPools_GetPool/pools/:poolId?api-version=string&timeOut=0&$select=string&$expand=stringGets information about the specified Pool.
  • DELETEDeletes a Pool from the specified Account./pools/:poolId?api-version=string&timeOut=0When you request that a Pool be deleted, the following actions occur: the Pool state is set to deleting; any ongoing resize operation on the Pool are stopped;…
  • HEADPools_PoolExists/pools/:poolId?api-version=string&timeOut=0Gets basic properties of a Pool.
  • PATCHUpdates the properties of the specified Pool./pools/:poolId?api-version=string&timeOut=0This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a…
  • POSTDisables automatic scaling for a Pool./pools/:poolId/disableautoscale?api-version=string&timeOut=0Disables automatic scaling for a Pool.
  • POSTEnables automatic scaling for a Pool./pools/:poolId/enableautoscale?api-version=string&timeOut=0You cannot enable automatic scaling on a Pool if a resize operation is in progress on the Pool. If automatic scaling of the Pool is currently disabled, you…
  • POSTGets the result of evaluating an automatic scaling formula on the Pool./pools/:poolId/evaluateautoscale?api-version=string&timeOut=0This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto…
  • POSTRemoves Compute Nodes from the specified Pool./pools/:poolId/removenodes?api-version=string&timeOut=0This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing.…
  • POSTChanges the number of Compute Nodes that are assigned to a Pool./pools/:poolId/resize?api-version=string&timeOut=0You can only resize a Pool when its allocation state is steady. If the Pool is already resizing, the request fails with status code 409. When you resize a…
  • POSTStops an ongoing resize operation on the Pool./pools/:poolId/stopresize?api-version=string&timeOut=0This does not restore the Pool to its previous state before the resize operation: it only stops any further changes being made, and the Pool maintains its…
  • POSTUpdates the properties of the specified Pool./pools/:poolId/updateproperties?api-version=string&timeOut=0This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified…
  • GETLists all Virtual Machine Images supported by the Azure Batch service./supportedimages?api-version=string&timeOut=0&maxresults=1000&$filter=stringLists all Virtual Machine Images supported by the Azure Batch service.

Jobs

  • GETLists all of the Jobs in the specified Account./jobs?api-version=string&timeOut=0&maxresults=1000&$filter=string&$select=string&$expand=stringLists all of the Jobs in the specified Account.
  • POSTCreates a Job to the specified Account./jobs?api-version=string&timeOut=0The Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service…
  • GETGets information about the specified Job./jobs/:jobId?api-version=string&timeOut=0&$select=string&$expand=stringGets information about the specified Job.
  • PUTUpdates the properties of the specified Job./jobs/:jobId?api-version=string&timeOut=0This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified…
  • DELETEDeletes a Job./jobs/:jobId?api-version=string&timeOut=0&force=trueDeleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if…
  • PATCHUpdates the properties of the specified Job./jobs/:jobId?api-version=string&timeOut=0This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints…
  • POSTDisables the specified Job, preventing new Tasks from running./jobs/:jobId/disable?api-version=string&timeOut=0The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently…
  • POSTEnables the specified Job, allowing new Tasks to run./jobs/:jobId/enable?api-version=string&timeOut=0When you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state,…
  • GETLists the execution status of the Job Preparation and Job Release Task for the specified Job across the Compute Nodes where the Job has run./jobs/:jobId/jobpreparationandreleasetaskstatus?api-version=string&timeOut=0&maxresults=1000&$filter=string&$select=stringThis API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes…
  • GETGets the Task counts for the specified Job./jobs/:jobId/taskcounts?api-version=string&timeOut=0Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing…
  • POSTTerminates the specified Job, marking it as completed./jobs/:jobId/terminate?api-version=string&timeOut=0&force=trueWhen a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks…
  • GETLists the Jobs that have been created under the specified Job Schedule./jobschedules/:jobScheduleId/jobs?api-version=string&timeOut=0&maxresults=1000&$filter=string&$select=string&$expand=stringLists the Jobs that have been created under the specified Job Schedule.

Job Schedules

  • GETLists all of the Job Schedules in the specified Account./jobschedules?api-version=string&timeOut=0&maxresults=1000&$filter=string&$select=string&$expand=stringLists all of the Job Schedules in the specified Account.
  • POSTCreates a Job Schedule to the specified Account./jobschedules?api-version=string&timeOut=0Creates a Job Schedule to the specified Account.
  • GETJobSchedules_GetJobSchedule/jobschedules/:jobScheduleId?api-version=string&timeOut=0&$select=string&$expand=stringGets information about the specified Job Schedule.
  • PUTUpdates the properties of the specified Job Schedule./jobschedules/:jobScheduleId?api-version=string&timeOut=0This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch…
  • DELETEDeletes a Job Schedule from the specified Account./jobschedules/:jobScheduleId?api-version=string&timeOut=0&force=trueWhen you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories…
  • HEADChecks the specified Job Schedule exists./jobschedules/:jobScheduleId?api-version=string&timeOut=0Checks the specified Job Schedule exists.
  • PATCHUpdates the properties of the specified Job Schedule./jobschedules/:jobScheduleId?api-version=string&timeOut=0This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the…
  • POSTDisables a Job Schedule./jobschedules/:jobScheduleId/disable?api-version=string&timeOut=0No new Jobs will be created until the Job Schedule is enabled again.
  • POSTEnables a Job Schedule./jobschedules/:jobScheduleId/enable?api-version=string&timeOut=0Enables a Job Schedule.
  • POSTTerminates a Job Schedule./jobschedules/:jobScheduleId/terminate?api-version=string&timeOut=0&force=trueTerminates a Job Schedule.

Tasks

  • POSTAdds a collection of Tasks to the specified Job./jobs/:jobId/addtaskcollection?api-version=string&timeOut=0Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this…
  • GETLists all of the Tasks that are associated with the specified Job./jobs/:jobId/tasks?api-version=string&timeOut=0&maxresults=1000&$filter=string&$select=string&$expand=stringFor multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve…
  • POSTCreates a Task to the specified Job./jobs/:jobId/tasks?api-version=string&timeOut=0The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by…
  • GETGets information about the specified Task./jobs/:jobId/tasks/:taskId?api-version=string&timeOut=0&$select=string&$expand=stringFor multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve…
  • PUTTasks_ReplaceTask/jobs/:jobId/tasks/:taskId?api-version=string&timeOut=0Updates the properties of the specified Task.
  • DELETEDeletes a Task from the specified Job./jobs/:jobId/tasks/:taskId?api-version=string&timeOut=0When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For…
  • GETLists the files in a Task's directory on its Compute Node./jobs/:jobId/tasks/:taskId/files?api-version=string&timeOut=0&maxresults=1000&$filter=string&recursive=trueLists the files in a Task's directory on its Compute Node.
  • GETTasks_GetTaskFile/jobs/:jobId/tasks/:taskId/files/:filePath?api-version=string&timeOut=0Returns the content of the specified Task file.
  • DELETEDeletes the specified Task file from the Compute Node where the Task ran./jobs/:jobId/tasks/:taskId/files/:filePath?api-version=string&timeOut=0&recursive=trueDeletes the specified Task file from the Compute Node where the Task ran.
  • HEADTasks_GetTaskFileProperties/jobs/:jobId/tasks/:taskId/files/:filePath?api-version=string&timeOut=0Gets the properties of the specified Task file.
  • POSTReactivates a Task, allowing it to run again even if its retry count has been exhausted./jobs/:jobId/tasks/:taskId/reactivate?api-version=string&timeOut=0Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the…
  • GETLists all of the subtasks that are associated with the specified multi-instance Task./jobs/:jobId/tasks/:taskId/subtasksinfo?api-version=string&timeOut=0&$select=stringIf the Task is not a multi-instance Task then this returns an empty collection.
  • POSTTerminates the specified Task./jobs/:jobId/tasks/:taskId/terminate?api-version=string&timeOut=0When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the…

Nodes

  • GETLists the Compute Nodes in the specified Pool./pools/:poolId/nodes?api-version=string&timeOut=0&maxresults=1000&$filter=string&$select=stringLists the Compute Nodes in the specified Pool.
  • GETGets information about the specified Compute Node./pools/:poolId/nodes/:nodeId?api-version=string&timeOut=0&$select=stringGets information about the specified Compute Node.
  • POSTDeallocates the specified Compute Node./pools/:poolId/nodes/:nodeId/deallocate?api-version=string&timeOut=0You can deallocate a Compute Node only if it is in an idle or running state.
  • POSTDisables Task scheduling on the specified Compute Node./pools/:poolId/nodes/:nodeId/disablescheduling?api-version=string&timeOut=0You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.
  • POSTEnables Task scheduling on the specified Compute Node./pools/:poolId/nodes/:nodeId/enablescheduling?api-version=string&timeOut=0You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled
  • GETLists the Compute Nodes Extensions in the specified Pool./pools/:poolId/nodes/:nodeId/extensions?api-version=string&timeOut=0&maxresults=1000&$select=stringLists the Compute Nodes Extensions in the specified Pool.
  • GETGets information about the specified Compute Node Extension./pools/:poolId/nodes/:nodeId/extensions/:extensionName?api-version=string&timeOut=0&$select=stringGets information about the specified Compute Node Extension.
  • GETLists all of the files in Task directories on the specified Compute Node./pools/:poolId/nodes/:nodeId/files?api-version=string&timeOut=0&maxresults=1000&$filter=string&recursive=trueLists all of the files in Task directories on the specified Compute Node.
  • GETNodes_GetNodeFile/pools/:poolId/nodes/:nodeId/files/:filePath?api-version=string&timeOut=0Returns the content of the specified Compute Node file.
  • DELETEDeletes the specified file from the Compute Node./pools/:poolId/nodes/:nodeId/files/:filePath?api-version=string&timeOut=0&recursive=trueDeletes the specified file from the Compute Node.
  • HEADNodes_GetNodeFileProperties/pools/:poolId/nodes/:nodeId/files/:filePath?api-version=string&timeOut=0Gets the properties of the specified Compute Node file.
  • POSTRestarts the specified Compute Node./pools/:poolId/nodes/:nodeId/reboot?api-version=string&timeOut=0You can restart a Compute Node only if it is in an idle or running state.
  • POSTReinstalls the operating system on the specified Compute Node./pools/:poolId/nodes/:nodeId/reimage?api-version=string&timeOut=0You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the…
  • GETGets the settings required for remote login to a Compute Node./pools/:poolId/nodes/:nodeId/remoteloginsettings?api-version=string&timeOut=0Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node and configure access ports…
  • POSTStarts the specified Compute Node./pools/:poolId/nodes/:nodeId/start?api-version=string&timeOut=0You can start a Compute Node only if it has been deallocated.
  • POSTUpload Azure Batch service log files from the specified Compute Node to Azure Blob Storage./pools/:poolId/nodes/:nodeId/uploadbatchservicelogs?api-version=string&timeOut=0This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure…
  • POSTAdds a user Account to the specified Compute Node./pools/:poolId/nodes/:nodeId/users?api-version=string&timeOut=0You can add a user Account to a Compute Node only when it is in the idle or running state. Before you can remotely login to a Compute Node you must configure…
  • PUTUpdates the password and expiration time of a user Account on the specified Compute Node./pools/:poolId/nodes/:nodeId/users/:userName?api-version=string&timeOut=0This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced…
  • DELETEDeletes a user Account from the specified Compute Node./pools/:poolId/nodes/:nodeId/users/:userName?api-version=string&timeOut=0You can delete a user Account to a Compute Node only when it is in the idle or running state. Before you can remotely login to a Compute Node you must…

API details

Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
71 operations on 50 pathsPOST 28GET 25DELETE 7PUT 4HEAD 4PATCH 3
Main resources
Nodes 19Pools 15Tasks 13Jobs 12Job Schedules 10Applications 2
Response formats
application/json
Description format
Swagger 2.0, API version 2026-10-01

How to test the Azure Batch in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Batch collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists all of the applications available in the specified Account.” (GET /applications?api-version=string&timeOut=0&maxresults=1000), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Batch?

Azure Batch provides Cloud-scale job scheduling and compute management. It is listed under Developer tools and has 71 endpoints.

Who publishes the Azure Batch?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Batch?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Batch have?

71 operations on 50 paths (28 POST, 25 GET, 7 DELETE, 4 PUT, 4 HEAD, 3 PATCH). The largest groups are Nodes, Pools, Tasks, Jobs.

Is forking the Azure Batch free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.