Microsoft Azure Batch Service Client
The Microsoft Azure Batch Service Client is a cloud-based service that allows developers to efficiently run large-scale parallel and high-performance computing (HPC) workloads in the Azure cloud.
OpenAPI Specification
swagger: '2.0'
info:
title: Microsoft Azure BatchServiceClient
version: 2024-02-01.19.0
description: A client for issuing REST requests to the Azure Batch service.
x-ms-parameterized-host:
hostTemplate: '{batchUrl}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/batchUrl'
schemes:
- https
consumes:
- application/json; odata=minimalmetadata
produces:
- application/json
security:
- azure_auth:
- user_impersonation
- api_key: []
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Microsoft Entra OAuth 2.0 auth code flow
scopes:
user_impersonation: Impersonate your user account
api_key:
type: apiKey
name: Authorization
in: header
paths:
/applications:
get:
tags:
- Applications
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureApplicationList
x-ms-examples:
List applications:
$ref: ./examples/ApplicationList.json
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 use on Compute Nodes; that is, that can be used in an Package
reference. For administrator information about applications and versions
that are not yet available to Compute Nodes, use the Azure portal or the
Azure Resource Manager API.
x-ms-request-id: request-id
parameters:
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 applications can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
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.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
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.
type: string
format: uuid
request-id:
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.
type: string
format: uuid
ETag:
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.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of applications.
schema:
$ref: '#/definitions/ApplicationListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/applications/{applicationId}:
get:
tags:
- Applications
operationId: microsoftAzureApplicationGet
x-ms-examples:
Get applications:
$ref: ./examples/ApplicationGet.json
summary: 'Microsoft Azure Gets Information About The Specified Application'
description: >-
This 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 administrator information about Applications and versions
that are not yet available to Compute Nodes, use the Azure portal or the
Azure Resource Manager API.
x-ms-request-id: request-id
parameters:
- name: applicationId
in: path
required: true
type: string
description: The ID of the Application.
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
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.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
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.
type: string
format: uuid
request-id:
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.
type: string
format: uuid
ETag:
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.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the application.
schema:
$ref: '#/definitions/ApplicationSummary'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/poolusagemetrics:
get:
tags:
- Pools
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzurePoolListusagemetrics
x-ms-examples:
Pool list usage metrics:
$ref: ./examples/PoolListUsageMetrics.json
summary: >-
Microsoft Azure Lists The Usage Metrics, Aggregated By Pool Across Individual Time Intervals, For The Specified Account
description: >-
If 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 aggregation intervals. If you do not specify a $filter clause
including a startTime or endTime these filters default to the start and
end times of the last aggregation interval currently available; that is,
only the last aggregation interval is returned.
x-ms-request-id: request-id
parameters:
- name: starttime
x-ms-client-name: startTime
in: query
required: false
type: string
format: date-time
description: >-
The earliest time from which to include metrics. This must be at
least two and a half hours before the current time. If not specified
this defaults to the start time of the last aggregation interval
currently available.
x-ms-parameter-grouping:
postfix: Options
- name: endtime
x-ms-client-name: endTime
in: query
required: false
type: string
format: date-time
description: >-
The latest time from which to include metrics. This must be at least
two hours before the current time. If not specified this defaults to
the end time of the last aggregation interval currently available.
x-ms-parameter-grouping:
postfix: Options
- name: $filter
in: query
required: false
type: string
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-account-usage-metrics.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 results will be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
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.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
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.
type: string
format: uuid
request-id:
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.
type: string
format: uuid
ETag:
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.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of Pool usage details.
schema:
$ref: '#/definitions/PoolListUsageMetricsResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
/supportedimages:
get:
tags:
- Accounts
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureAccountListsupportedimages
x-ms-examples:
Account list node agent skus:
$ref: ./examples/AccountListSupportedImages.json
summary: 'Microsoft Azure Lists All Virtual Machine Images Supported By The Azure Batch Service'
x-ms-request-id: request-id
parameters:
- name: $filter
in: query
required: false
type: string
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-support-images.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 results will be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
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.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
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.
type: string
format: uuid
request-id:
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.
type: string
format: uuid
ETag:
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.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
description: A response containing the list of supported Virtual Machine Images.
schema:
$ref: '#/definitions/AccountListSupportedImagesResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
description: Needs a more full description created.
/nodecounts:
get:
x-ms-pageable:
nextLinkName: odata.nextLink
tags:
- Accounts
operationId: microsoftAzureAccountListpoolnodecounts
description: >-
Gets 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, use a list query.
x-ms-examples:
NodeCountsPayload:
$ref: ./examples/AccountListPoolNodeCounts.json
parameters:
- name: $filter
in: query
required: false
type: string
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.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 10
minimum: 1
maximum: 10
in: query
required: false
type: integer
format: int32
description: The maximum number of items to return in the response.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
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.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
headers:
client-request-id:
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.
type: string
format: uuid
request-id:
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.
type: string
format: uuid
description: >-
The response contains the number of Compute Nodes in each Compute
Node state, grouped by Pool.
schema:
$ref: '#/definitions/PoolNodeCountsListResult'
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
summary: Microsoft Azure Get Nodecounts
/certificates:
post:
deprecated: true
tags:
- Certificates
operationId: microsoftAzureCertificateAdd
x-ms-examples:
Certificate add:
$ref: ./examples/CertificateAdd.json
summary: 'Microsoft Azure Adds A Certificate To The Specified Account'
description: >-
Warning: This operation is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
x-ms-request-id: request-id
parameters:
- name: certificate
in: body
description: The Certificate to be added.
required: true
schema:
$ref: '#/definitions/CertificateAddParameter'
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
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.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
in: header
required: false
type: boolean
description: >-
Whether the server should return the client-request-id in the
response.
x-ms-parameter-grouping:
postfix: Options
- name: ocp-date
in: header
required: false
type: string
format: date-time-rfc1123
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.
x-ms-parameter-grouping:
postfix: Options
- $ref: '#/parameters/ApiVersionParameter'
responses:
'201':
headers:
client-request-id:
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.
type: string
format: uuid
request-id:
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.
type: string
format: uuid
ETag:
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.
type: string
Last-Modified:
description: The time at which the resource was last modified.
type: string
format: date-time-rfc1123
DataServiceId:
description: The OData ID of the resource to which the request applied.
type: string
description: The request to the Batch service was successful.
default:
description: The error from the Batch service.
schema:
$ref: '#/definitions/BatchError'
get:
deprecated: true
tags:
- Certificates
x-ms-pageable:
nextLinkName: odata.nextLink
operationId: microsoftAzureCertificateList
x-ms-examples:
Certificate list:
$ref: ./examples/CertificateList.json
summary: >-
Microsoft Azure Lists All Of The Certificates That Have Been Added To The Specified Account
description: >-
Warning: This operation is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
x-ms-request-id: request-id
parameters:
- name: $filter
in: query
required: false
type: string
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.
x-ms-parameter-grouping:
postfix: Options
- name: $select
in: query
required: false
type: string
description: An OData $select clause.
x-ms-parameter-grouping:
postfix: Options
- name: maxresults
x-ms-client-name: maxResults
default: 1000
minimum: 1
maximum: 1000
in: query
required: false
type: integer
format: int32
description: >-
The maximum number of items to return in the response. A maximum of
1000 Certificates can be returned.
x-ms-parameter-grouping:
postfix: Options
- name: timeout
in: query
required: false
type: integer
format: int32
default: 30
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.
x-ms-parameter-grouping:
postfix: Options
- name: client-request-id
in: header
required: false
type: string
format: uuid
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.
x-ms-parameter-grouping:
postfix: Options
x-ms-client-request-id: true
- name: return-client-request-id
default: false
# --- truncated at 32 KB (744 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/batchserviceclient-openapi-original.yml