Application - List
Список всех приложений, доступных в указанной учетной записи.
Эта операция возвращает только приложения и версии, доступные для использования на вычислительных узлах; то есть, который можно использовать в ссылке на пакет. Для получения сведений администратора о приложениях и версиях, которые еще не доступны для вычислительных узлов, используйте портал Azure или API Resource Manager Azure.
GET {batchUrl}/applications?api-version=2023-11-01.18.0
GET {batchUrl}/applications?maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех пакетная служба Azure запросов на обслуживание. |
api-version
|
query | True |
string |
Версия API клиента. |
maxresults
|
query |
integer int32 |
Максимальное количество элементов, возвращаемых в ответе. Можно вернуть не более 1000 приложений. |
|
timeout
|
query |
integer int32 |
Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 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 |
Ответ, содержащий список приложений. Headers
|
|
Other Status Codes |
Ошибка из пакетной службы. |
Безопасность
azure_auth
поток кода проверки подлинности Microsoft Entra OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | Олицетворение учетной записи пользователя |
Authorization
Type:
apiKey
In:
header
Примеры
List applications
Sample Request
GET account.region.batch.azure.com/applications?api-version=2023-11-01.18.0
Sample Response
{
"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 |
Текст сообщения. |