Share via

Applications - List Applications

Service:
Batch Service
API Version:
2025-06-01

Lists all of the applications available in the specified Account.
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.

GET {endpoint}/applications?api-version=2025-06-01
With optional parameters: 
GET {endpoint}/applications?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).
api-version
 query True

string

minLength: 1

The API version to use for this operation.
maxresults
 query

integer (int32)

minimum: 1
maximum: 1000

The maximum number of items to return in the response. A maximum of 1000 applications can be returned.
timeOut
 query

integer (int32)

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.".

Request Header

Name Required Type Description
client-request-id

string

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.
return-client-request-id

boolean

Whether the server should return the client-request-id in the response.
ocp-date

string (date-time-rfc7231)

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.

Responses

Name Type Description
200 OK

BatchApplicationListResult

The request has succeeded.

Headers

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name Description
https://batch.core.windows.net//.default

Examples

List applications

Sample request

GET {endpoint}/applications?api-version=2025-06-01

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "my_application_id",
      "versions": [
        "v1.0"
      ],
      "displayName": "my_display_name"
    }
  ]
}

Definitions

Name Description
BatchApplication

Contains information about an application in an Azure Batch Account.
BatchApplicationListResult

The result of listing the applications available in an Account.
BatchError

An error response received from the Azure Batch service.
BatchErrorDetail

An item of additional information included in an Azure Batch error response.
BatchErrorMessage

An error message received in an Azure Batch error response.

BatchApplication

Object

Contains information about an application in an Azure Batch Account.

Name Type Description
displayName

string

The display name for the application.
id

string

A string that uniquely identifies the application within the Account.
versions

string[]

The list of available versions of the application.

BatchApplicationListResult

Object

The result of listing the applications available in an Account.

Name Type Description
odata.nextLink

string (uri)

The URL to get the next set of results.
value

BatchApplication[]

The list of applications available in the Account.

BatchError

Object

An error response received from the Azure Batch service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message

BatchErrorMessage

A message describing the error, intended to be suitable for display in a user interface.
values

BatchErrorDetail[]

A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

Object

An item of additional information included in an Azure Batch error response.

Name Type Description
key

string

An identifier specifying the meaning of the Value property.
value

string

The additional information included with the error response.

BatchErrorMessage

Object

An error message received in an Azure Batch error response.

Name Type Description
lang

string

The language code of the error message.
value

string

The text of the message.