Application - List
Выводит список всех приложений, доступных в указанной учетной записи.
Эта операция возвращает только приложения и версии, доступные для использования на вычислительных узлах; т. е. это можно использовать в справочнике по пакету. Сведения администратора о приложениях и версиях, которые еще не доступны вычислительным узлам, используйте портал Azure или API Azure Resource Manager.
GET {batchUrl}/applications?api-version=2024-07-01.20.0
GET {batchUrl}/applications?maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов пакетной службы Azure. |
api-version
|
query | True |
string |
Версия КЛИЕНТСКОго API. |
maxresults
|
query |
integer (int32) minimum: 1maximum: 1000 |
Максимальное количество элементов, возвращаемых в ответе. Можно вернуть не более 1000 приложений. |
|
timeout
|
query |
integer (int32) |
Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию. |
Заголовок запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
client-request-id |
string (uuid) |
Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Должен ли сервер возвращать идентификатор client-request-id в ответе. |
|
ocp-date |
string (date-time-rfc1123) |
Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Ответ, содержащий список приложений. Заголовки
|
|
Other Status Codes |
Ошибка из пакетной службы. |
Безопасность
azure_auth
Поток кода проверки подлинности Microsoft Entra OAuth 2.0
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | Олицетворения учетной записи пользователя |
Authorization
Тип:
apiKey
В:
header
Примеры
List applications
Образец запроса
GET account.region.batch.azure.com/applications?api-version=2024-07-01.20.0
Пример ответа
{
"value": [
{
"id": "my_application_id",
"versions": [
"v1.0"
],
"displayName": "my_display_name"
}
]
}
Определения
Имя | Описание |
---|---|
Application |
Результат перечисления приложений, доступных в учетной записи. |
Application |
Содержит сведения о приложении в учетной записи пакетной службы Azure. |
Batch |
Ответ об ошибке, полученный из пакетной службы Azure. |
Batch |
Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure. |
Error |
Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure. |
ApplicationListResult
Результат перечисления приложений, доступных в учетной записи.
Имя | Тип | Описание |
---|---|---|
odata.nextLink |
string |
URL-адрес для получения следующего набора результатов. |
value |
Список приложений, доступных в учетной записи. |
ApplicationSummary
Содержит сведения о приложении в учетной записи пакетной службы Azure.
Имя | Тип | Описание |
---|---|---|
displayName |
string |
Отображаемое имя приложения. |
id |
string |
Строка, которая однозначно идентифицирует приложение в учетной записи. |
versions |
string[] |
Список доступных версий приложения. |
BatchError
Ответ об ошибке, полученный из пакетной службы Azure.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования. |
message |
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе. |
|
values |
Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке. |
BatchErrorDetail
Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
Имя | Тип | Описание |
---|---|---|
key |
string |
Идентификатор, указывающий значение свойства Value. |
value |
string |
Дополнительные сведения, включенные в ответ на ошибку. |
ErrorMessage
Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
Имя | Тип | Описание |
---|---|---|
lang |
string |
Языковой код сообщения об ошибке |
value |
string |
Текст сообщения. |