Windows

BatchService

A client for issuing REST requests to the Azure Batch service.

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

A client for issuing REST requests to the Azure Batch service.

Endpoints 77

Applications

  • GETLists all of the applications available in the specified account./applications?maxresults=1000&timeout=30&api-version=stringThis operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package…
  • GETGets information about the specified application./applications/:applicationId?timeout=30&api-version=stringThis operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package…

Certificates

  • GETLists all of the certificates that have been added to the specified account./certificates?$filter=string&$select=string&maxresults=1000&timeout=30&api-version=string
  • POSTAdds a certificate to the specified account./certificates?timeout=30&api-version=string
  • GETCertificate_Get/certificates(thumbprintAlgorithm=:thumbprintAlgorithm,thumbprint=:thumbprint)?$select=string&timeout=30&api-version=stringGets information about the specified certificate.
  • DELETEDeletes a certificate from the specified account./certificates(thumbprintAlgorithm=:thumbprintAlgorithm,thumbprint=:thumbprint)?timeout=30&api-version=stringYou cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the…
  • POSTCancels a failed deletion of a certificate from the specified account./certificates(thumbprintAlgorithm=:thumbprintAlgorithm,thumbprint=:thumbprint)/canceldelete?timeout=30&api-version=stringIf you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you…

Jobs

  • GETLists all of the jobs in the specified account./jobs?$filter=string&$select=string&$expand=string&maxresults=1000&timeout=30&api-version=string
  • POSTAdds a job to the specified account./jobs?timeout=30&api-version=stringThe 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?$select=string&$expand=string&timeout=30&api-version=string
  • PUTUpdates the properties of the specified job./jobs/:jobId?timeout=30&api-version=stringThis 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?timeout=30&api-version=stringDeleting 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?timeout=30&api-version=stringThis 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?timeout=30&api-version=stringThe 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?timeout=30&api-version=stringWhen 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?$filter=string&$select=string&maxresults=1000&timeout=30&api-version=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?timeout=30&api-version=stringTask 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?timeout=30&api-version=stringWhen 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?$filter=string&$select=string&$expand=string&maxresults=1000&timeout=30&api-version=string
  • GETGets lifetime summary statistics for all of the jobs in the specified account./lifetimejobstats?timeout=30&api-version=stringStatistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The…

Tasks

  • POSTAdds a collection of tasks to the specified job./jobs/:jobId/addtaskcollection?timeout=30&api-version=stringNote 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?$filter=string&$select=string&$expand=string&maxresults=1000&timeout=30&api-version=stringFor multi-instance tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary task. Use the list subtasks API to retrieve…
  • POSTAdds a task to the specified job./jobs/:jobId/tasks?timeout=30&api-version=stringThe maximum lifetime of a task from addition to completion is 7 days. If a task has not completed within 7 days of being added it will be terminated by the…
  • GETGets information about the specified task./jobs/:jobId/tasks/:taskId?$select=string&$expand=string&timeout=30&api-version=stringFor multi-instance tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary task. Use the list subtasks API to retrieve…
  • PUTTask_Update/jobs/:jobId/tasks/:taskId?timeout=30&api-version=stringUpdates the properties of the specified task.
  • DELETEDeletes a task from the specified job./jobs/:jobId/tasks/:taskId?timeout=30&api-version=stringWhen 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…
  • POSTReactivates a task, allowing it to run again even if its retry count has been exhausted./jobs/:jobId/tasks/:taskId/reactivate?timeout=30&api-version=stringReactivation 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?$select=string&timeout=30&api-version=stringIf the task is not a multi-instance task then this returns an empty collection.
  • POSTTerminates the specified task./jobs/:jobId/tasks/:taskId/terminate?timeout=30&api-version=stringWhen the task has been terminated, it moves to the completed state. For multi-instance tasks, the terminate task operation applies synchronously to the…

Files

  • GETLists the files in a task's directory on its compute node./jobs/:jobId/tasks/:taskId/files?$filter=string&recursive=true&maxresults=1000&timeout=30&api-version=string
  • GETFile_GetFromTask/jobs/:jobId/tasks/:taskId/files/:filePath?timeout=30&api-version=stringReturns 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?recursive=true&timeout=30&api-version=string
  • HEADFile_GetPropertiesFromTask/jobs/:jobId/tasks/:taskId/files/:filePath?timeout=30&api-version=stringGets the properties of the specified task file.
  • GETLists all of the files in task directories on the specified compute node./pools/:poolId/nodes/:nodeId/files?$filter=string&recursive=true&maxresults=1000&timeout=30&api-version=string
  • GETFile_GetFromComputeNode/pools/:poolId/nodes/:nodeId/files/:filePath?timeout=30&api-version=stringReturns the content of the specified compute node file.
  • DELETEDeletes the specified file from the compute node./pools/:poolId/nodes/:nodeId/files/:filePath?recursive=true&timeout=30&api-version=string
  • HEADFile_GetPropertiesFromComputeNode/pools/:poolId/nodes/:nodeId/files/:filePath?timeout=30&api-version=stringGets the properties of the specified compute node file.

JobSchedules

  • GETLists all of the job schedules in the specified account./jobschedules?$filter=string&$select=string&$expand=string&maxresults=1000&timeout=30&api-version=string
  • POSTAdds a job schedule to the specified account./jobschedules?timeout=30&api-version=string
  • GETJobSchedule_Get/jobschedules/:jobScheduleId?$select=string&$expand=string&timeout=30&api-version=stringGets information about the specified job schedule.
  • PUTUpdates the properties of the specified job schedule./jobschedules/:jobScheduleId?timeout=30&api-version=stringThis 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?timeout=30&api-version=stringWhen 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?timeout=30&api-version=string
  • PATCHUpdates the properties of the specified job schedule./jobschedules/:jobScheduleId?timeout=30&api-version=stringThis 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?timeout=30&api-version=stringNo new jobs will be created until the job schedule is enabled again.
  • POSTEnables a job schedule./jobschedules/:jobScheduleId/enable?timeout=30&api-version=string
  • POSTTerminates a job schedule./jobschedules/:jobScheduleId/terminate?timeout=30&api-version=string

Pools

  • GETGets lifetime summary statistics for all of the pools in the specified account./lifetimepoolstats?timeout=30&api-version=stringStatistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The…
  • GETLists all of the pools in the specified account./pools?$filter=string&$select=string&$expand=string&maxresults=1000&timeout=30&api-version=string
  • POSTAdds a pool to the specified account./pools?timeout=30&api-version=stringWhen naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible…
  • GETPool_Get/pools/:poolId?$select=string&$expand=string&timeout=30&api-version=stringGets information about the specified pool.
  • DELETEDeletes a pool from the specified account./pools/:poolId?timeout=30&api-version=stringWhen 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;…
  • HEADPool_Exists/pools/:poolId?timeout=30&api-version=stringGets basic properties of a pool.
  • PATCHUpdates the properties of the specified pool./pools/:poolId?timeout=30&api-version=stringThis only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify…
  • POSTDisables automatic scaling for a pool./pools/:poolId/disableautoscale?timeout=30&api-version=string
  • POSTEnables automatic scaling for a pool./pools/:poolId/enableautoscale?timeout=30&api-version=stringYou 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?timeout=30&api-version=stringThis 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…
  • POSTChanges the number of compute nodes that are assigned to a pool./pools/:poolId/resize?timeout=30&api-version=stringYou 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?timeout=30&api-version=stringThis 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?timeout=30&api-version=stringThis fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified…
  • POSTUpgrades the operating system of the specified pool./pools/:poolId/upgradeos?timeout=30&api-version=stringDuring an upgrade, the Batch service upgrades each compute node in the pool. When a compute node is chosen for upgrade, any tasks running on that node are…
  • GETLists the usage metrics, aggregated by pool across individual time intervals, for the specified account./poolusagemetrics?starttime=2024-01-01T00:00:00Z&endtime=2024-01-01T00:00:00Z&$filter=string&maxresults=1000&timeout=30&api-version=stringIf you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned…

Accounts

  • GETLists all node agent SKUs supported by the Azure Batch service./nodeagentskus?$filter=string&maxresults=1000&timeout=30&api-version=string
  • GETAccount_ListPoolNodeCounts/nodecounts?$filter=string&maxresults=10&timeout=30&api-version=stringGets the number of nodes in each state, grouped by pool.

ComputeNodes

  • GETLists the compute nodes in the specified pool./pools/:poolId/nodes?$filter=string&$select=string&maxresults=1000&timeout=30&api-version=string
  • GETGets information about the specified compute node./pools/:poolId/nodes/:nodeId?$select=string&timeout=30&api-version=string
  • POSTDisables task scheduling on the specified compute node./pools/:poolId/nodes/:nodeId/disablescheduling?timeout=30&api-version=stringYou can disable task scheduling on a node only if its current scheduling state is enabled.
  • POSTEnables task scheduling on the specified compute node./pools/:poolId/nodes/:nodeId/enablescheduling?timeout=30&api-version=stringYou can enable task scheduling on a node only if its current scheduling state is disabled
  • GETGets the Remote Desktop Protocol file for the specified compute node./pools/:poolId/nodes/:nodeId/rdp?timeout=30&api-version=stringBefore you can access a node by using the RDP file, you must create a user account on the node. This API can only be invoked on pools created with a cloud…
  • POSTRestarts the specified compute node./pools/:poolId/nodes/:nodeId/reboot?timeout=30&api-version=stringYou can restart a 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?timeout=30&api-version=stringYou can reinstall the operating system on a node only if it is in an idle or running state. This API can be invoked only on pools created with the cloud…
  • GETGets the settings required for remote login to a compute node./pools/:poolId/nodes/:nodeId/remoteloginsettings?timeout=30&api-version=stringBefore you can remotely login to a node using the remote login settings, you must create a user account on the node. This API can be invoked only on pools…
  • POSTUpload Azure Batch service log files from the specified compute node to Azure Blob Storage./pools/:poolId/nodes/:nodeId/uploadbatchservicelogs?timeout=30&api-version=stringThis is for gathering Azure Batch service log files in an automated fashion from nodes if you are experiencing an error and wish to escalate to Azure support.…
  • POSTAdds a user account to the specified compute node./pools/:poolId/nodes/:nodeId/users?timeout=30&api-version=stringYou can add a user account to a node only when it is in the idle or running state.
  • PUTUpdates the password and expiration time of a user account on the specified compute node./pools/:poolId/nodes/:nodeId/users/:userName?timeout=30&api-version=stringThis 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?timeout=30&api-version=stringYou can delete a user account to a node only when it is in the idle or running state.
  • POSTRemoves compute nodes from the specified pool./pools/:poolId/removenodes?timeout=30&api-version=stringThis 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.

API details

Base URL
https://batch.core.windows.net
Authentication
None declared in the description
Operations
77 operations on 54 pathsGET 29POST 29DELETE 8PUT 4HEAD 4PATCH 3
Main resources
Pools 15ComputeNodes 13Jobs 13JobSchedules 10Tasks 9Files 8Certificates 5Accounts 2Applications 2
Response formats
application/json
Description format
Swagger 2.0, API version 2018-08-01.7.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the BatchService 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 BatchService collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Lists all of the applications available in the specified account.” (GET /applications?maxresults=1000&timeout=30&api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BatchService?

A client for issuing REST requests to the Azure Batch service. It is listed under Developer tools and has 77 endpoints.

Who publishes the BatchService?

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

What is the base URL of the BatchService?

Requests go to https://batch.core.windows.net. Endpoint paths are added to this base URL.

How do I authenticate with the BatchService?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the BatchService have?

77 operations on 54 paths (29 GET, 29 POST, 8 DELETE, 4 PUT, 4 HEAD, 3 PATCH). The largest groups are Pools, ComputeNodes, Jobs, JobSchedules.

Is forking the BatchService 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.