你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Application - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

获取有关指定应用程序的信息。
此操作仅返回可用于计算节点上的应用程序和版本;也就是说，可以在包引用中使用。 有关尚不适用于计算节点的应用程序和版本的管理员信息，请使用 Azure 门户 或 Azure 资源管理器 API。

GET {batchUrl}/applications/{applicationId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/applications/{applicationId}?timeout={timeout}&api-version=2023-11-01.18.0

URI 参数

名称	在	必需	类型	说明
applicationId	path	True	string	应用程序的 ID。
batchUrl	path	True	string	所有Azure Batch服务请求的基 URL。
api-version	query	True	string	客户端 API 版本。
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	ApplicationSummary	包含应用程序的响应。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服务中的错误。

安全性

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

示例

Get applications

Sample Request

HTTP

GET account.region.batch.azure.com/applications/my_application_id?api-version=2023-11-01.18.0

Sample Response

Status code:

200

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

定义

名称	说明
ApplicationSummary	包含有关 Azure Batch 帐户中的应用程序的信息。
BatchError	从Azure Batch服务收到的错误响应。
BatchErrorDetail	Azure Batch错误响应中包含的其他信息项。
ErrorMessage	Azure Batch错误响应中收到的错误消息。

ApplicationSummary

包含有关 Azure Batch 帐户中的应用程序的信息。

名称	类型	说明
displayName	string	应用程序的显示名称。
id	string	唯一标识帐户中的应用程序的字符串。
versions	string[]	应用程序的可用版本列表。

BatchError

从Azure Batch服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
message	ErrorMessage	描述错误的消息，该消息适用于在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的其他详细信息的键值对的集合。

BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。

名称	类型	说明
key	string	指定 Value 属性含义的标识符。
value	string	错误响应附带的其他信息。

ErrorMessage

Azure Batch错误响应中收到的错误消息。

名称	类型	说明
lang	string	错误消息的语言代码
value	string	消息的文本。