Account - List Supported Images

リファレンス

Service:: Batch Service

API Version:: 2023-11-01.18.0

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

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

With optional parameters:

GET {batchUrl}/supportedimages?$filter={$filter}&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 のバージョン。
$filter	query		string	OData $filter 句。このフィルターの構築の詳細については、「」を参照してください https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images。
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	AccountListSupportedImagesResult	サポートされている仮想マシンイメージの一覧を含む応答。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

200 OK

AccountListSupportedImagesResult

サポートされている仮想マシンイメージの一覧を含む応答。

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

例

Account list node agent skus

Sample Request

HTTP

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

Sample Response

Status code:: 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"
    }
  ]
}

定義

名前	説明
AccountListSupportedImagesResult	サポートされている仮想マシンイメージを一覧表示した結果。
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
ErrorMessage	Azure Batchエラー応答で受信したエラーメッセージ。
ImageInformation	Azure Virtual Machines Marketplace イメージへの参照と、イメージに関する追加情報。
ImageReference	Azure Virtual Machines Marketplace イメージまたは Azure Compute Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。
OSType	イメージのオペレーティングシステム (Windows や Linux など) の種類。
VerificationType	Azure Batch サービスが、イメージが関連付けられているコンピューティングノードエージェント SKU と互換性があることをアクティブに検証するかどうか。

AccountListSupportedImagesResult

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

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

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

ImageInformation

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

名前	型	説明
batchSupportEndOfLife	string	Azure Batch サービスがイメージに対するプールの作成要求の受け入れを停止する時刻。
capabilities	string[]	Image がサポートする機能。イメージのすべての機能が一覧表示されるわけではありません。この一覧の機能は特別な関心事と見なされ、一般にAzure Batch サービスの他の機能との統合に関連しています。
imageReference	ImageReference	Azure 仮想マシンの Marketplace イメージへの参照。
nodeAgentSKUId	string	イメージがサポートするコンピューティングノードエージェント SKU の ID。
osType	OSType	イメージのオペレーティングシステム (Windows や Linux など) の種類。
verificationType	VerificationType	Azure Batch サービスが、イメージが関連付けられているコンピューティングノードエージェント SKU と互換性があることをアクティブに検証するかどうか。

ImageReference

Azure Virtual Machines Marketplace イメージまたは Azure Compute Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

名前	型	説明
exactVersion	string	ノードの作成に使用されるプラットフォームイメージまたはマーケットプレースイメージの特定のバージョン。この読み取り専用フィールドは、プールの作成時に 'version' に指定された値が 'latest' の場合にのみ、'version' と異なります。
offer	string	Azure Virtual Machines Marketplace イメージのオファーの種類。たとえば、UbuntuServer や WindowsServer などです。
publisher	string	Azure Virtual Machines Marketplace イメージの発行元。たとえば、Canonical や MicrosoftWindowsServer などです。
sku	string	Azure Virtual Machines Marketplace イメージの SKU。たとえば、18.04-LTS や 2019-Datacenter などです。
version	string	Azure Virtual Machines Marketplace イメージのバージョン。 'latest' の値を指定して、最新バージョンの Image を選択できます。省略した場合、既定値は 'latest' です。
virtualMachineImageId	string	Azure Compute Gallery イメージの ARM リソース識別子。プール内のコンピューティングノードは、このイメージ ID を使用して作成されます。これは、常に最新のイメージバージョンに既定値を設定するための /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallery/galleryName}/images/{imageDefinitionName} の形式です。このプロパティは、他の ImageReference プロパティと相互に排他的です。 Azure Compute Gallery イメージは、同じリージョンにレプリカを持ち、Azure Batch アカウントと同じサブスクリプションに存在する必要があります。 imageId でイメージバージョンが指定されていない場合は、最新バージョンが使用されます。 Batch サービスと通信する Batch コンピューティングノードエージェントのファイアウォール設定の詳細については、「」を参照してください https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration。

OSType

イメージのオペレーティングシステム (Windows や Linux など) の種類。

名前	型	説明
linux	string	Linux オペレーティングシステム。
windows	string	Windows オペレーティングシステム。

VerificationType

Azure Batch サービスが、イメージが関連付けられているコンピューティングノードエージェント SKU と互換性があることをアクティブに検証するかどうか。

名前	型	説明
unverified	string	関連付けられているコンピューティングノードエージェント SKU は、イメージとのバイナリ互換性を持っている必要がありますが、特定の機能は検証されていません。
verified	string	イメージは、関連付けられているコンピューティングノードエージェント SKU と互換性が保証されており、すべての Batch 機能が期待どおりに動作することが確認されています。

Account - List Supported Images

URI パラメーター

要求ヘッダー

応答

セキュリティ

azure_auth

Scopes

Authorization

例

Account list node agent skus

Sample Request

Sample Response

定義

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

その他のリソース