Application - List

服務:

Batch Service

API 版本:

2024-07-01.20.0

列出指定帳戶中所有可用的應用程式。
此作業只會傳回可用於計算節點上的應用程式和版本;也就是說，可用於套件參考。 如需尚未可供計算節點使用之應用程式和版本的系統管理員資訊，請使用 Azure 入口網站或 Azure Resource Manager API。

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 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
api-version	query	True	string	用戶端 API 版本。
maxresults	query		integer (int32) minimum: 1 maximum: 1000	回應中要傳回的項目數目上限。 最多可以傳回1000個應用程式。
timeout	query		integer (int32)	伺服器可以花費數秒處理要求的時間上限。 預設值為30秒。 如果值大於 30，則會改用預設值。

要求標頭

Media Types: "application/json; odata=minimalmetadata"

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

回應

名稱	類型	Description
200 OK	ApplicationListResult	包含應用程式清單的回應。 標題 client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服務的錯誤。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

Authorization

類型: apiKey
位於: header

範例

List applications

範例要求

HTTP

GET account.region.batch.azure.com/applications?api-version=2024-07-01.20.0

範例回覆

狀態碼:

200

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

定義

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

ApplicationListResult

Object

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

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

ApplicationSummary

Object

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

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

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

ErrorMessage

Object

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

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