Application - List

リファレンス

Service:: Batch Service

API Version:: 2023-11-01.18.0

指定したアカウントで使用可能なすべてのアプリケーションを一覧表示します。
この操作は、コンピューティングノードで使用できるアプリケーションとバージョンのみを返します。つまり、パッケージ参照で使用できます。コンピューティングノードでまだ使用できないアプリケーションとバージョンに関する管理者情報については、Azure portalまたは Azure Resource Manager API を使用してください。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべてのAzure Batchサービス要求のベース URL。
api-version	query	True	string	クライアント API のバージョン。
maxresults	query		integer int32	応答で返される項目の最大数。最大 1,000 個のアプリケーションを返すことができます。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。

要求ヘッダー

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

名前	型	説明
client-request-id	string uuid	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id	boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date	string date-time-rfc1123	要求が発行された時刻。クライアントライブラリは通常、これを現在のシステムクロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
200 OK	ApplicationListResult	アプリケーションの一覧を含む応答。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

200 OK

ApplicationListResult

アプリケーションの一覧を含む応答。

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

例

List applications

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

定義

名前	説明
ApplicationListResult	アカウントで使用可能なアプリケーションを一覧表示した結果。
ApplicationSummary	Azure Batch アカウント内のアプリケーションに関する情報が含まれます。
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
ErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。