Microsoft Azure Batch is a cloud-based service designed to help developers and scientists run large-scale parallel and high-performance compute jobs efficiently. It enables users to easily schedule, manage, and run a large number of compute-intensive tasks across a pool of virtual machines, allowing for quick and cost-effective processing of demanding workloads.
swagger: '2.0'
info:
title: Microsoft Azure Azure Batch
version: 2024-02-01.19.0
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: Certificates
- name: certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
- name: Jobs
- name: Jobschedules
- name: Nodecounts
- name: Pools
- name: Poolusagemetrics
- name: Supportedimages
paths:
/applications:
get:
operationId: microsoftAzureBatchListapplications
summary: 'Microsoft Azure Lists All Of The Applications Available In The Specified Account'
description: >-
This operation returns only Applications and versions that are available
for<br>use on Compute Nodes; that is, that can be used in an Package
reference. For<br>administrator information about applications and
versions that are not yet<br>available to Compute Nodes, use the Azure
portal or the Azure Resource Manager<br>API.
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
default: 30
- name: client-request-id
in: header
description: >-
The caller-generated request identity, in the form of a GUID with no
decoration
such 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
current system clock time; set it explicitly if you are calling the
REST API
directly.
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
applications 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/ApplicationList.json
x-ms-pageable:
nextLinkName: odata.nextLink
tags:
- Applications
/applications/{applicationId}:
get:
operationId: microsoftAzureBatchGetapplication
summary: 'Microsoft Azure Gets Information About The Specified Application'
description: >-
This operation returns only Applications and versions that are available
for<br>use on Compute Nodes; that is, that can be used in an Package
reference. For<br>administrator information about Applications and
versions that are not yet<br>available to Compute Nodes, use the Azure
portal or the Azure Resource Manager<br>API.
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
default: 30
- name: client-request-id
in: header
description: >-
The caller-generated request identity, in the form of a GUID with no
decoration
such 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
current system clock time; set it explicitly if you are calling the
REST API
directly.
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/ApplicationGet.json
tags:
- Applications
/certificates:
get:
operationId: microsoftAzureBatchListcertificates
summary: >-
Microsoft Azure Lists All Of The Certificates That Have Been Added To The Specified Account
description: >-
Lists all of the Certificates that have been added to 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
default: 30
- name: client-request-id
in: header
description: >-
The caller-generated request identity, in the form of a GUID with no
decoration
such 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
current system clock time; set it explicitly if you are calling the
REST API
directly.
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
applications 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
https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.
required: false
type: string
- name: $select
in: query
description: An OData $select clause.
required: false
type: array
items:
type: string
collectionFormat: csv
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/BatchCertificateListResult'
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'
deprecated: true
x-ms-examples:
Certificate list:
$ref: ./examples/CertificateList.json
x-ms-pageable:
nextLinkName: odata.nextLink
tags:
- Certificates
post:
operationId: microsoftAzureBatchCreatecertificate
summary: 'Microsoft Azure Creates A Certificate To The Specified Account'
description: Creates a Certificate to the specified Account.
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
default: 30
- name: client-request-id
in: header
description: >-
The caller-generated request identity, in the form of a GUID with no
decoration
such 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
current system clock time; set it explicitly if you are calling the
REST API
directly.
required: false
type: string
format: date-time-rfc7231
x-ms-client-name: ocpdate
- name: certificate
in: body
description: The Certificate to be created.
required: true
schema:
$ref: '#/definitions/BatchCertificate'
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'
deprecated: true
x-ms-examples:
Certificate create:
$ref: ./examples/CertificateCreate.json
tags:
- Certificates
/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}):
get:
operationId: microsoftAzureBatchGetcertificate
description: Gets information about the specified Certificate.
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
default: 30
- name: client-request-id
in: header
description: >-
The caller-generated request identity, in the form of a GUID with no
decoration
such 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
current system clock time; set it explicitly if you are calling the
REST API
directly.
required: false
type: string
format: date-time-rfc7231
x-ms-client-name: ocpdate
- name: thumbprintAlgorithm
in: path
description: >-
The algorithm used to derive the thumbprint parameter. This must be
sha1.
required: true
type: string
- name: thumbprint
in: path
description: The thumbprint of the Certificate to get.
required: true
type: string
- name: $select
in: query
description: An OData $select clause.
required: false
type: array
items:
type: string
collectionFormat: csv
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/BatchCertificate'
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'
deprecated: true
x-ms-examples:
Certificate get:
$ref: ./examples/CertificateGet.json
summary: >-
Microsoft Azure Get Certificates Thumbprintalgorithm Thumbprintalgorithm,thumbprint Thumbprint
tags:
- certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
delete:
operationId: microsoftAzureBatchDeletecertificate
summary: 'Microsoft Azure Deletes A Certificate From The Specified Account'
description: >-
You cannot delete a Certificate if a resource (Pool or Compute Node) is
using<br>it. Before you can delete a Certificate, you must therefore
make sure that the<br>Certificate is not associated with any existing
Pools, the Certificate is not<br>installed on any Nodes (even if you
remove a Certificate from a Pool, it is not<br>removed from existing
Compute Nodes in that Pool until they restart), and no<br>running Tasks
depend on the Certificate. If you try to delete a Certificate<br>that is
in use, the deletion fails. The Certificate status changes
to<br>deleteFailed. You can use Cancel Delete Certificate to set the
status back to<br>active if you decide that you want to continue using
the Certificate.
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
default: 30
- name: client-request-id
in: header
description: >-
The caller-generated request identity, in the form of a GUID with no
decoration
such 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
current system clock time; set it explicitly if you are calling the
REST API
directly.
required: false
type: string
format: date-time-rfc7231
x-ms-client-name: ocpdate
- name: thumbprintAlgorithm
in: path
description: >-
The algorithm used to derive the thumbprint parameter. This must be
sha1.
required: true
type: string
- name: thumbprint
in: path
description: The thumbprint of the Certificate to be deleted.
required: true
type: string
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
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'
deprecated: true
x-ms-examples:
Certificate delete:
$ref: ./examples/CertificateDelete.json
tags:
- certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete:
post:
operationId: microsoftAzureBatchCancelcertificatedeletion
summary: 'Microsoft Azure Cancels A Failed Deletion Of A Certificate From The Specified Account'
description: >-
If you try to delete a Certificate that is being used by a Pool or
Compute<br>Node, the status of the Certificate changes to deleteFailed.
If you decide that<br>you want to continue using the Certificate, you
can use this operation to set<br>the status of the Certificate back to
active. If you intend to delete the<br>Certificate, you do not need to
run this operation after the deletion failed.<br>You must make sure that
the Certificate is not being used by any resources, and<br>then you can
try again to delete the Certificate.
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
default: 30
- name: client-request-id
in: header
description: >-
The caller-generated request identity, in the form of a GUID with no
decoration
such 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
current system clock time; set it explicitly if you are calling the
REST API
directly.
required: false
type: string
format: date-time-rfc7231
x-ms-client-name: ocpdate
- name: thumbprintAlgorithm
in: path
description: >-
The algorithm used to derive the thumbprint parameter. This must be
sha1.
required: true
type: string
- name: thumbprint
in: path
description: The thumbprint of the Certificate being deleted.
required: true
type: string
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
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
# --- truncated at 32 KB (796 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-batch-openapi-original.yml