Every API here is available over the APIs.io API and to AI agents over MCP.
{
"swagger": "2.0",
"info": {
"title": "Azure Batch",
"version": "2025-06-01",
"description": "Azure Batch provides Cloud-scale job scheduling and compute management.",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"x-ms-parameterized-host": {
"hostTemplate": "{endpoint}",
"useSchemePrefix": false,
"parameters": [
{
"name": "endpoint",
"in": "path",
"description": "Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).",
"required": true,
"type": "string",
"format": "uri",
"x-ms-skip-url-encoding": true
}
]
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"OAuth2Auth": [
"https://batch.core.windows.net//.default"
]
}
],
"securityDefinitions": {
"OAuth2Auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
"scopes": {
"https://batch.core.windows.net//.default": ""
}
}
},
"tags": [
{
"name": "Applications"
},
{
"name": "Pools"
},
{
"name": "Jobs"
},
{
"name": "Job Schedules"
},
{
"name": "Tasks"
},
{
"name": "Nodes"
}
],
"paths": {
"/applications": {
"get": {
"operationId": "Applications_ListApplications",
"tags": [
"Applications"
],
"summary": "Lists all of the applications available in the specified Account.",
"description": "This operation returns only Applications and versions that are available for\nuse on Compute Nodes; that is, that can be used in an Package reference. For\nadministrator information about applications and versions that are not yet\navailable to Compute Nodes, use the Azure portal or the Azure Resource Manager\nAPI.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "timeOut",
"in": "query",
"description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "client-request-id",
"in": "header",
"description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.",
"required": false,
"type": "string",
"x-ms-client-name": "clientRequestId"
},
{
"name": "return-client-request-id",
"in": "header",
"description": "Whether the server should return the client-request-id in the response.",
"required": false,
"type": "boolean",
"default": false,
"x-ms-client-name": "returnClientRequestId"
},
{
"name": "ocp-date",
"in": "header",
"description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ocpdate"
},
{
"name": "maxresults",
"in": "query",
"description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.",
"required": false,
"type": "integer",
"format": "int32",
"default": 1000,
"minimum": 1,
"maximum": 1000
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchApplicationListResult"
},
"headers": {
"ETag": {
"type": "string",
"description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time at which the resource was last modified."
},
"client-request-id": {
"type": "string",
"description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true."
},
"request-id": {
"type": "string",
"description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/BatchError"
}
}
},
"x-ms-examples": {
"List applications": {
"$ref": "./examples/Applications_ListApplications.json"
}
},
"x-ms-pageable": {
"nextLinkName": "odata.nextLink"
}
}
},
"/applications/{applicationId}": {
"get": {
"operationId": "Applications_GetApplication",
"tags": [
"Applications"
],
"summary": "Gets information about the specified Application.",
"description": "This operation returns only Applications and versions that are available for\nuse on Compute Nodes; that is, that can be used in an Package reference. For\nadministrator information about Applications and versions that are not yet\navailable to Compute Nodes, use the Azure portal or the Azure Resource Manager\nAPI.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "timeOut",
"in": "query",
"description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "client-request-id",
"in": "header",
"description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.",
"required": false,
"type": "string",
"x-ms-client-name": "clientRequestId"
},
{
"name": "return-client-request-id",
"in": "header",
"description": "Whether the server should return the client-request-id in the response.",
"required": false,
"type": "boolean",
"default": false,
"x-ms-client-name": "returnClientRequestId"
},
{
"name": "ocp-date",
"in": "header",
"description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ocpdate"
},
{
"name": "applicationId",
"in": "path",
"description": "The ID of the Application",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchApplication"
},
"headers": {
"ETag": {
"type": "string",
"description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time at which the resource was last modified."
},
"client-request-id": {
"type": "string",
"description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true."
},
"request-id": {
"type": "string",
"description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/BatchError"
}
}
},
"x-ms-examples": {
"Get applications": {
"$ref": "./examples/Applications_GetApplication.json"
}
}
}
},
"/jobs": {
"get": {
"operationId": "Jobs_ListJobs",
"tags": [
"Jobs"
],
"summary": "Lists all of the Jobs in the specified Account.",
"description": "Lists all of the Jobs in the specified Account.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "timeOut",
"in": "query",
"description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "client-request-id",
"in": "header",
"description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.",
"required": false,
"type": "string",
"x-ms-client-name": "clientRequestId"
},
{
"name": "return-client-request-id",
"in": "header",
"description": "Whether the server should return the client-request-id in the response.",
"required": false,
"type": "boolean",
"default": false,
"x-ms-client-name": "returnClientRequestId"
},
{
"name": "ocp-date",
"in": "header",
"description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ocpdate"
},
{
"name": "maxresults",
"in": "query",
"description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.",
"required": false,
"type": "integer",
"format": "int32",
"default": 1000,
"minimum": 1,
"maximum": 1000
},
{
"name": "$filter",
"in": "query",
"description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs.",
"required": false,
"type": "string"
},
{
"name": "$select",
"in": "query",
"description": "An OData $select clause.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
},
{
"name": "$expand",
"in": "query",
"description": "An OData $expand clause.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchJobListResult"
},
"headers": {
"ETag": {
"type": "string",
"description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time at which the resource was last modified."
},
"client-request-id": {
"type": "string",
"description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true."
},
"request-id": {
"type": "string",
"description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/BatchError"
}
}
},
"x-ms-examples": {
"Job list": {
"$ref": "./examples/Jobs_ListJobs.json"
}
},
"x-ms-pageable": {
"nextLinkName": "odata.nextLink"
}
},
"post": {
"operationId": "Jobs_CreateJob",
"tags": [
"Jobs"
],
"summary": "Creates a Job to the specified Account.",
"description": "The Batch service supports two ways to control the work done as part of a Job.\nIn the first approach, the user specifies a Job Manager Task. The Batch service\nlaunches this Task when it is ready to start the Job. The Job Manager Task\ncontrols all other Tasks that run under this Job, by using the Task APIs. In\nthe second approach, the user directly controls the execution of Tasks under an\nactive Job, by using the Task APIs. Also note: when naming Jobs, avoid\nincluding sensitive information such as user names or secret project names.\nThis information may appear in telemetry logs accessible to Microsoft Support\nengineers.",
"consumes": [
"application/json; odata=minimalmetadata"
],
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "timeOut",
"in": "query",
"description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "client-request-id",
"in": "header",
"description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.",
"required": false,
"type": "string",
"x-ms-client-name": "clientRequestId"
},
{
"name": "return-client-request-id",
"in": "header",
"description": "Whether the server should return the client-request-id in the response.",
"required": false,
"type": "boolean",
"default": false,
"x-ms-client-name": "returnClientRequestId"
},
{
"name": "ocp-date",
"in": "header",
"description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ocpdate"
},
{
"name": "job",
"in": "body",
"description": "The Job to be created.",
"required": true,
"schema": {
"$ref": "#/definitions/BatchJobCreateOptions"
}
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"DataServiceId": {
"type": "string",
"description": "The OData ID of the resource to which the request applied."
},
"ETag": {
"type": "string",
"description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time at which the resource was last modified."
},
"client-request-id": {
"type": "string",
"description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true."
},
"request-id": {
"type": "string",
"description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/BatchError"
}
}
},
"x-ms-examples": {
"Creates a basic job": {
"$ref": "./examples/Jobs_CreateJob_Basic.json"
},
"Creates a complex job": {
"$ref": "./examples/Jobs_CreateJob_Complex.json"
}
}
}
},
"/jobs/{jobId}": {
"get": {
"operationId": "Jobs_GetJob",
"tags": [
"Jobs"
],
"summary": "Gets information about the specified Job.",
"description": "Gets information about the specified Job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "timeOut",
"in": "query",
"description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "client-request-id",
"in": "header",
"description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.",
"required": false,
"type": "string",
"x-ms-client-name": "clientRequestId"
},
{
"name": "return-client-request-id",
"in": "header",
"description": "Whether the server should return the client-request-id in the response.",
"required": false,
"type": "boolean",
"default": false,
"x-ms-client-name": "returnClientRequestId"
},
{
"name": "ocp-date",
"in": "header",
"description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ocpdate"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-Match",
"in": "header",
"description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "If-None-Match",
"in": "header",
"description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "jobId",
"in": "path",
"description": "The ID of the Job.",
"required": true,
"type": "string"
},
{
"name": "$select",
"in": "query",
"description": "An OData $select clause.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
},
{
"name": "$expand",
"in": "query",
"description": "An OData $expand clause.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchJob"
},
"headers": {
"ETag": {
"type": "string",
"description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers."
},
"Last-Modified": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time at which the resource was last modified."
},
"client-request-id": {
"type": "string",
"description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true."
},
"request-id": {
"type": "string",
"description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/BatchError"
}
}
},
"x-ms-examples": {
"Job get": {
"$ref": "./examples/Jobs_GetJob.json"
}
}
},
"put": {
"operationId": "Jobs_ReplaceJob",
"tags": [
"Jobs"
],
"summary": "Updates the properties of the specified Job.",
"description": "This fully replaces all the updatable properties of the Job. For example, if\nthe Job has constraints associated with it and if constraints is not specified\nwith this request, then the Batch service will remove the existing constraints.",
"consumes": [
"application/json; odata=minimalmetadata"
],
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "timeOut",
"in": "query",
"description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "client-request-id",
"in": "header",
"description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.",
"required": false,
"type": "string",
"x-ms-client-name": "clientRequestId"
},
{
"name": "return-client-request-id",
"in": "header",
"description": "Whether the server should return the client-request-id in the response.",
"required": false,
"type": "boolean",
"default": false,
"x-ms-client-name": "returnClientRequestId"
},
{
"name": "ocp-date",
"in": "header",
"description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ocpdate"
},
{
"name": "If-Modified-Since",
"in": "header",
"description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifModifiedSince"
},
{
"name": "If-Unmodified-Since",
"in": "header",
"description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.",
"required": false,
"type": "string",
"format": "date-time-rfc7231",
"x-ms-client-name": "ifUnmodifiedSince"
},
{
"name": "If-Match",
"in": "header",
"description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.",
"required": false,
"type": "string",
"x-ms-client-name": "ifMatch"
},
{
"name": "If-None-Match",
"in": "header",
"description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.",
"required": false,
"type": "string",
"x-ms-client-name": "ifNoneMatch"
},
{
"name": "jobId",
"in": "path",
"description": "The ID of the Job whose properties you want to update.",
"required": true,
"type": "string"
},
{
"name": "job",
"in": "body",
"description": "A job with updated properties",
"required": true,
"schema": {
"$ref": "#/definitions/BatchJob"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"DataServiceId": {
"type": "string",
"description": "The OData ID of the resource to which the request applied."
},
"ETag": {
"type": "string",
"description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers."
},
"Last-Modified"
# --- truncated at 32 KB (814 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure-batch/refs/heads/main/openapi/_original/microsoft-azure-batch-batch-service-openapi.json