Applications - List Applications

Служба:: Batch Service

Версия API:: 2025-06-01

Перечисляет все приложения, доступные в указанном аккаунте.
Эта операция возвращает только приложения и версии, доступные для использования на вычислительных узлах; то есть это может быть использовано в ссылке на пакет. Для получения информации администратора о приложениях и версиях, которые пока недоступны для вычислительных узлов, используйте портал Azure или API Azure Resource Manager.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Максимальное количество элементов, возвращаемых в ответе. Максимум может быть возвращено 1000 заявок.
timeOut	query		integer (int32)	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

Заголовок запроса

Имя	Тип	Описание
client-request-id	string	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date	string (date-time-rfc7231)	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

Ответы

Имя	Тип	Описание
200 OK	BatchApplicationListResult	Запрос выполнен успешно. Заголовки ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

BatchApplicationListResult

Запрос выполнен успешно.

Заголовки

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://batch.core.windows.net//.default

Примеры

List applications

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
BatchApplication	Содержит сведения о приложении в учетной записи пакетной службы Azure.
BatchApplicationListResult	Результат перечисления приложений, доступных в учетной записи.
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

BatchApplication

Объект

Содержит сведения о приложении в учетной записи пакетной службы Azure.

Имя	Тип	Описание
displayName	string	Отображаемое имя приложения.
id	string	Строка, которая уникально идентифицирует приложение внутри аккаунта.
versions	string[]	Список доступных версий приложения.

BatchApplicationListResult

Объект

Результат перечисления приложений, доступных в учетной записи.

Имя	Тип	Описание
odata.nextLink	string (uri)	URL-адрес для получения следующего набора результатов.
value	BatchApplication[]	Список приложений, доступных в аккаунте.

BatchError

Объект

Ответ об ошибке, полученный из пакетной службы Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.