---
title: "Lists all Virtual Machine Images supported by the Azure Batch service."
method: GET
path: "/supportedimages"
tags: ["Pools"]
---

# Lists all Virtual Machine Images supported by the Azure Batch service.

`GET /supportedimages`

Lists all Virtual Machine Images supported by the Azure Batch service.

## Query parameters

- `api-version` string, required
- `timeOut` integer
- `maxresults` integer
- `$filter` string

## Headers

- `client-request-id` string
- `return-client-request-id` boolean
- `ocp-date` string, date-time-rfc7231

## Response `200`

The request has succeeded.

- BatchAccountListSupportedImagesResult — The result of listing the supported Virtual Machine Images.
  - `value` BatchSupportedImage[] — The list of supported Virtual Machine Images.
    - `nodeAgentSKUId` string, required — The ID of the Compute Node agent SKU which the Image supports.
    - `imageReference` BatchVmImageReference, required — A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the ' List Supported Images ' operation.
      - `publisher` string — The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer.
      - `offer` string — The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer.
      - `sku` string — The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter.
      - `version` string — The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'.
      - `virtualMachineImageId` string, arm-id — The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.
      - `exactVersion` string — The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'.
      - `sharedGalleryImageId` string — The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
      - `communityGalleryImageId` string — The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
    - `osType` 'linux' | 'windows', required — OSType enums
    - `capabilities` string[] — The capabilities or features which the Image supports. Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service.
    - `batchSupportEndOfLife` string, date-time — The time when the Azure Batch service will stop accepting create Pool requests for the Image.
    - `verificationType` 'verified' | 'unverified', required — ImageVerificationType enums
  - `odata.nextLink` string, uri — The URL to get the next set of results.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/batch-batch.md) · [All operations](https://skmtc.net/azure/apis/batch-batch/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/batch-batch/versions/8427acd8fd77/schema)