Applications - List Applications

服務:

Batch Service

API 版本:

2025-06-01

列出指定帳號中所有可用的應用程式。
此操作僅回傳可用於運算節點的應用程式與版本;也就是說，可以用於套件參考。 如需管理員關於尚未提供給運算節點的應用程式與版本資訊，請使用 Azure 入口網站或 Azure 資源管理器 API。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	Batch 帳戶端點 （例如：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，則會使用預設值。」

要求標頭

名稱	必要	類型	Description
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，請明確設定它。

回應

名稱	類型	Description
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

範圍

名稱	Description
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"
    }
  ]
}

定義

名稱	Description
BatchApplication	包含 Azure Batch 帳戶中應用程式的相關信息。
BatchApplicationListResult	列出帳戶中可用的應用程式結果。
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
BatchErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。

BatchApplication

Object

包含 Azure Batch 帳戶中應用程式的相關信息。

名稱	類型	Description
displayName	string	應用程式的顯示名稱。
id	string	一個字串，能在帳戶中唯一識別該應用程式。
versions	string[]	應用程式可用版本清單。

BatchApplicationListResult

Object

列出帳戶中可用的應用程式結果。

名稱	類型	Description
odata.nextLink	string (uri)	取得下一組結果的 URL。
value	BatchApplication[]	帳戶中可用的應用程式清單。

BatchError

Object

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message	BatchErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Object

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應隨附的其他資訊。

BatchErrorMessage

Object

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼。
value	string	訊息的文字。