Account - List Supported Images

Reference

Service:: Batch Service

API Version:: 2024-07-01.20.0

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

GET {batchUrl}/supportedimages?api-version=2024-07-01.20.0

With optional parameters:

GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI Parameters

Name	In	Required	Type	Description
batchUrl	path	True	string	The base URL for all Azure Batch service requests.
api-version	query	True	string	Client API Version.
$filter	query		string	An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	The maximum number of items to return in the response. A maximum of 1000 results will be returned.
timeout	query		integer int32	The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.

Request Header

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

Name	Type	Description
client-request-id	string uuid	The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Whether the server should return the client-request-id in the response.
ocp-date	string date-time-rfc1123	The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Responses

Name	Type	Description
200 OK	AccountListSupportedImagesResult	A response containing the list of supported Virtual Machine Images. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	The error from the Batch service.

Name

Type

Description

200 OK

AccountListSupportedImagesResult

A response containing the list of supported Virtual Machine Images.

Headers

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

Other Status Codes

BatchError

The error from the Batch service.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Authorization

Type: apiKey
In: header

Examples

Account list node agent skus

Sample request

HTTP

GET account.region.batch.azure.com/supportedimages?api-version=2024-07-01.20.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"
    }
  ]
}

Definitions

Name	Description
AccountListSupportedImagesResult	The result of listing the supported Virtual Machine Images.
BatchError	An error response received from the Azure Batch service.
BatchErrorDetail	An item of additional information included in an Azure Batch error response.
ErrorMessage	An error message received in an Azure Batch error response.
ImageInformation	A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image.
ImageReference	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.
OSType	The type of operating system (e.g. Windows or Linux) of the Image.
VerificationType	Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU.

AccountListSupportedImagesResult

The result of listing the supported Virtual Machine Images.

Name	Type	Description
odata.nextLink	string	The URL to get the next set of results.
value	ImageInformation[]	The list of supported Virtual Machine Images.

BatchError

An error response received from the Azure Batch service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	ErrorMessage	A message describing the error, intended to be suitable for display in a user interface.
values	BatchErrorDetail[]	A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

Name	Type	Description
key	string	An identifier specifying the meaning of the Value property.
value	string	The additional information included with the error response.

ErrorMessage

An error message received in an Azure Batch error response.

Name	Type	Description
lang	string	The language code of the error message
value	string	The text of the message.

ImageInformation

A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image.

Name	Type	Description
batchSupportEndOfLife	string	The time when the Azure Batch service will stop accepting create Pool requests for the Image.
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.
imageReference	ImageReference	The reference to the Azure Virtual Machine's Marketplace Image.
nodeAgentSKUId	string	The ID of the Compute Node agent SKU which the Image supports.
osType	OSType	The type of operating system (e.g. Windows or Linux) of the Image.
verificationType	VerificationType	Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU.

ImageReference

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.

Name	Type	Description
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.
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'.
offer	string	The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer.
publisher	string	The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer.
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.
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	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://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

OSType

The type of operating system (e.g. Windows or Linux) of the Image.

Name	Type	Description
linux	string	The Linux operating system.
windows	string	The Windows operating system.

VerificationType

Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU.

Name	Type	Description
unverified	string	The associated Compute Node agent SKU should have binary compatibility with the Image, but specific functionality has not been verified.
verified	string	The Image is guaranteed to be compatible with the associated Compute Node agent SKU and all Batch features have been confirmed to work as expected.

Share via

Account - List Supported Images

URI Parameters

Request Header

Responses

Security

azure_auth

Scopes

Authorization

Examples

Account list node agent skus

Sample request

Sample response

Definitions

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Additional resources