Pools - List Supported Images

Служба:
Batch Service
Версия API:
2025-06-01

Выводит список всех образов виртуальных машин, поддерживаемых пакетной службой Azure.

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)

Конечная точка учетной записи пакетной службы (например, 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

Удостоверение запроса, созданное вызывающим пользователем, в виде 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

Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя Описание
https://batch.core.windows.net//.default

Примеры

Account list node agent skus

Образец запроса

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.
BatchErrorDetail

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchSupportedImage

Ссылка на образ Azure Virtual Machines Marketplace и дополнительные сведения об образе.
BatchVmImageReference

Ссылка на образ Azure Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы Azure Marketplace, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых образов".
ImageVerificationType

Enums ImageVerificationType
OSType

OSType enums

BatchAccountListSupportedImagesResult

Объект

Результат перечисления поддерживаемых образов виртуальных машин.

Имя Тип Описание
odata.nextLink

string (uri)

URL-адрес для получения следующего набора результатов.
value

BatchSupportedImage[]

Список поддерживаемых образов виртуальных машин.

BatchError

Объект

Ответ об ошибке, полученный из пакетной службы Azure.

Имя Тип Описание
code

string

Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message

BatchErrorMessage

Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values

BatchErrorDetail[]

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя Тип Описание
key

string

Идентификатор, указывающий значение свойства Value.
value

string

Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя Тип Описание
lang

string

Языковой код сообщения об ошибке.
value

string

Текст сообщения.

BatchSupportedImage

Объект

Ссылка на образ Azure Virtual Machines Marketplace и дополнительные сведения об образе.

Имя Тип Описание
batchSupportEndOfLife

string (date-time)

Время, когда сервис Azure Batch перестанет принимать запросы на создание пула для образа.
capabilities

string[]

Возможности или функции, которые поддерживает изображение. Не все возможности изображения перечислены. Возможности в этом списке считаются особым интересом и обычно связаны с интеграцией с другими функциями в сервисе Azure Batch.
imageReference

BatchVmImageReference

Ссылка на образ рынка виртуальной машины Azure Virtual Machine.
nodeAgentSKUId

string

ID SKU агента Compute Node, который поддерживает Image.
osType

OSType

Тип операционной системы (например, Windows или Linux) образа.
verificationType

ImageVerificationType

Проверяет ли сервис Azure Batch активно совместимость образа с соответствующим SKU агента Compute Node.

BatchVmImageReference

Объект

Ссылка на образ Azure Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы Azure Marketplace, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых образов".

Имя Тип Описание
communityGalleryImageId

string

Уникальный идентификатор изображения в галерее сообщества. Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET коллекции сообщества.
exactVersion

string

Конкретная версия изображения платформы или изображения маркетплейса, используемая для создания узла. Это поле только для чтения отличается от 'version' только в том случае, если значение 'version', указанное при создании пула, было 'последним'.
offer

string

Тип предложения изображения Azure Virtual Machines Marketplace. Например, UbuntuServer или WindowsServer.
publisher

string

Издатель изображения Azure Virtual Machines Marketplace. Например, Canonical или MicrosoftWindowsServer.
sharedGalleryImageId

string

Уникальный идентификатор изображения общей галереи. Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET образа общей коллекции.
sku

string

SKU изображения Azure Virtual Machines Marketplace. Например, 18.04-LTS или 2019-Datacenter.
version

string

Версия изображения Azure Virtual Machines Marketplace. Для выбора последней версии изображения можно задать значение 'lastest'. Если опущено, значение по умолчанию — "последняя".
virtualMachineImageId

string (arm-id)

Идентификатор ресурса ARM образа коллекции вычислений Azure. Вычислительные узлы в пуле будут созданы с использованием этого идентификатора изображения. Это в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroup/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} для постоянного выбора последней версии изображения. Это свойство взаимоисключается с другими свойствами ImageReference. Образ вычислительной галереи Azure должен иметь реплики в том же регионе и находиться в той же подписке, что и аккаунт Azure Batch. Если версия изображения не указана в imageId, будет использована последняя версия. Для получения информации о настройках межсетевого экрана для агента Batch Compute Node для взаимодействия с сервисом Batch см. https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ImageVerificationType

Перечисление

Enums ImageVerificationType

Значение Описание
verified

Образ гарантированно совместим с соответствующим SKU агента Compute Node, и все функции пакетного режима подтверждены как работают как ожидается.
unverified

Соответствующий SKU агента Compute Node должен иметь бинарную совместимость с изображением, но конкретная функциональность не подтверждена.

OSType

Перечисление

OSType enums

Значение Описание
linux

Операционная система Linux.
windows

Операционная система Windows.