Pools - List Supported Images

サービス:: Batch Service

API バージョン:: 2025-06-01

Azure Batch サービスでサポートされているすべての仮想マシンイメージを一覧表示します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	Batch アカウントエンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$filter	query		string	OData $filter 句。このフィルターの構築についての詳細は https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-imagesを参照してください。
maxresults	query		integer (int32) minimum: 1 maximum: 1000	応答で返される項目の最大数。最大1000件の申請書を返送できます。
timeOut	query		integer (int32)	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。値が30より大きい場合は、デフォルトが使われます。」

要求ヘッダー

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

応答

名前	型	説明
200 OK	BatchAccountListSupportedImagesResult	要求は成功しました。ヘッダー ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	予期しないエラー応答。

名前

型

説明

200 OK

BatchAccountListSupportedImagesResult

要求は成功しました。

ヘッダー

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://batch.core.windows.net//.default

例

Account list node agent skus

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "nodeAgentSKUId": "batch.node.centos 7",
      "imageReference": {
        "publisher": "OpenLogic",
        "offer": "CentOS",
        "sku": "7.2",
        "version": "latest"
      },
      "verificationType": "verified",
      "capabilities": [
        "DockerCompatible",
        "NvidiaTeslaDriverInstalled"
      ],
      "osType": "linux"
    },
    {
      "nodeAgentSKUId": "batch.node.centos 7",
      "imageReference": {
        "publisher": "OpenLogic",
        "offer": "CentOS",
        "sku": "7.1",
        "version": "latest"
      },
      "verificationType": "unverified",
      "osType": "linux",
      "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z"
    },
    {
      "nodeAgentSKUId": "batch.node.debian 8",
      "imageReference": {
        "publisher": "Credativ",
        "offer": "Debian",
        "sku": "8",
        "version": "latest"
      },
      "verificationType": "verified",
      "osType": "linux"
    },
    {
      "nodeAgentSKUId": "batch.node.windows amd64",
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-R2-Datacenter",
        "version": "latest"
      },
      "verificationType": "verified",
      "osType": "windows"
    },
    {
      "nodeAgentSKUId": "batch.node.windows amd64",
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-Datacenter",
        "version": "latest"
      },
      "verificationType": "verified",
      "osType": "windows"
    }
  ]
}

定義

名前	説明
BatchAccountListSupportedImagesResult	サポートされている仮想マシンイメージを一覧表示した結果。
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
BatchSupportedImage	Azure Virtual Machines Marketplace イメージへの参照と、イメージに関する追加情報。
BatchVmImageReference	Azure Virtual Machines Marketplace イメージまたは Azure コンピューティングギャラリーイメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。
ImageVerificationType	ImageVerificationType 列挙
OSType	OSTypeの列挙

BatchAccountListSupportedImagesResult

Object

サポートされている仮想マシンイメージを一覧表示した結果。

名前	型	説明
odata.nextLink	string (uri)	次の結果セットを取得するための URL。
value	BatchSupportedImage[]	サポートされている仮想マシンイメージの一覧。

BatchError

Object

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
message	BatchErrorMessage	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Object

Azure Batch エラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

BatchErrorMessage

Object

Azure Batch エラー応答で受信したエラーメッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード。
value	string	メッセージのテキスト。

BatchSupportedImage

Object

Azure Virtual Machines Marketplace イメージへの参照と、イメージに関する追加情報。

名前	型	説明
batchSupportEndOfLife	string (date-time)	Azure Batchサービスがイメージのプール作成リクエストを受け入れなくなる時間点です。
capabilities	string[]	イメージがサポートする機能や特徴。画像のすべての機能が一覧に記載されているわけではありません。このリストの機能は特に注目されており、一般的にAzure Batchサービスの他の機能との統合に関連しています。
imageReference	BatchVmImageReference	Azure 仮想マシンのマーケットプレイスイメージへの言及です。
nodeAgentSKUId	string	イメージがサポートするCompute NodeエージェントSKUのID。
osType	OSType	イメージのオペレーティングシステムの種類(例:WindowsまたはLinux)。
verificationType	ImageVerificationType	Azure Batchサービスが、関連するCompute NodeエージェントSKUとイメージが互換性があることを積極的に検証しているかどうか。

BatchVmImageReference

Object

Azure Virtual Machines Marketplace イメージまたは Azure コンピューティングギャラリーイメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

名前	型	説明
communityGalleryImageId	string	コミュニティギャラリーの画像ユニーク識別子。このプロパティは他のプロパティと相互に排他的であり、コミュニティギャラリーイメージの GET 呼び出しからフェッチできます。
exactVersion	string	ノード作成に使われたプラットフォーム画像やマーケットプレイス画像の特定のバージョン。この読み取り専用フィールドは、プール作成時に指定された「バージョン」の値が「最新」である場合にのみ「バージョン」と異なります。
offer	string	Azure Virtual Machines Marketplace Imageのオファータイプ。たとえば、UbuntuServer や WindowsServer などです。
publisher	string	Azure Virtual Machines Marketplace Imageの発行者。たとえば、Canonical または MicrosoftWindowsServer です。
sharedGalleryImageId	string	共有ギャラリー画像のユニーク識別子。このプロパティは他のプロパティと相互に排他的であり、共有ギャラリーイメージの GET 呼び出しからフェッチできます。
sku	string	Azure Virtual Machines Marketplace ImageのSKUです。たとえば、18.04-LTS や 2019-Datacenter などです。
version	string	Azure Virtual Machines Marketplace Imageのバージョンです。最新の画像を選択するために「最新」の値を指定できます。省略した場合、既定値は 'latest' です。
virtualMachineImageId	string (arm-id)	Azure コンピューティングギャラリーイメージの ARM リソース識別子。プール内の計算ノードはこのイメージIDを使って作成されます。これは、常に最新の画像バージョンをデフォルトで設定するために、/subscriptions/{subscriptionId}/resourceGroups/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} の形で、常に最新の画像バージョンをデフォルトで使用します。この性質は他のImageReferenceプロパティとは相反します。 Azure Compute Gallery Imageは、同じリージョン内のレプリカを持ち、Azure Batchアカウントと同じサブスクリプションに属している必要があります。 imageIdに画像バージョンが指定されていない場合は、最新バージョンが使用されます。バッチコンピュートノードエージェントがバッチサービスと通信するためのファイアウォール設定については https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configurationを参照してください。

ImageVerificationType

列挙

ImageVerificationType 列挙

値	説明
verified	このイメージは関連するCompute NodeエージェントSKUとの互換性が保証されており、すべてのバッチ機能は期待通りに動作することが確認されています。
unverified	関連するCompute NodeエージェントのSKUはイメージとのバイナリ互換性を持つはずですが、具体的な機能は検証されていません。

OSType

列挙

OSTypeの列挙

値	説明
linux	Linuxオペレーティングシステム。
windows	Windows オペレーティングシステム。

次の方法で共有

Pools - List Supported Images

URI パラメーター

要求ヘッダー

応答

セキュリティ

OAuth2Auth

スコープ

例

Account list node agent skus

要求のサンプル

応答のサンプル

定義

BatchAccountListSupportedImagesResult

BatchError

BatchErrorDetail

BatchErrorMessage

BatchSupportedImage

BatchVmImageReference

ImageVerificationType

OSType