Account - List Supported Images

Ссылка

Служба:: Batch Service

Версия API:: 2024-07-01.20.0

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

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов пакетной службы Azure.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
$filter	query		string	Предложение OData $filter. Дополнительные сведения о создании этого фильтра см. в https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	Максимальное количество элементов, возвращаемых в ответе. Возвращается не более 1000 результатов.
timeout	query		integer int32	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию.

Заголовок запроса

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

Имя	Тип	Описание
client-request-id	string uuid	Удостоверение запроса, созданное вызывающим пользователем, в виде 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	Ответ, содержащий список поддерживаемых образов виртуальных машин. Заголовки client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

Имя

Тип

Описание

200 OK

AccountListSupportedImagesResult

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

Заголовки

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

Other Status Codes

BatchError

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

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

azure_auth

Поток кода проверки подлинности Microsoft Entra OAuth 2.0

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

Области

Имя	Описание
user_impersonation	Олицетворения учетной записи пользователя

Authorization

Тип: apiKey
В: header

Примеры

Account list node agent skus

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

HTTP

GET account.region.batch.azure.com/supportedimages?api-version=2024-07-01.20.0

Пример ответа

Код состояния:: 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.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
ImageInformation	Ссылка на образ Azure Virtual Machines Marketplace и дополнительные сведения об образе.
ImageReference	Ссылка на образ Azure Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы Azure Marketplace, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых образов".
OSType	Тип операционной системы (например, Windows или Linux) образа.
VerificationType	Будет ли служба пакетной службы Azure активно проверять совместимость образа с соответствующим номером SKU агента вычислений.

AccountListSupportedImagesResult

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

Имя	Тип	Описание
odata.nextLink	string	URL-адрес для получения следующего набора результатов.
value	ImageInformation[]	Список поддерживаемых образов виртуальных машин.

BatchError

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

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	ErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

ErrorMessage

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

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке
value	string	Текст сообщения.

ImageInformation

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

Имя	Тип	Описание
batchSupportEndOfLife	string	Время, когда служба пакетной службы Azure перестанет принимать запросы на создание пула для образа.
capabilities	string[]	Возможности или функции, поддерживаемые изображением. Не все возможности образа перечислены. Возможности в этом списке считаются особыми и обычно связаны с интеграцией с другими функциями в пакетной службе Azure.
imageReference	ImageReference	Ссылка на образ Marketplace виртуальной машины Azure.
nodeAgentSKUId	string	Идентификатор номера SKU агента вычислительного узла, который поддерживает образ.
osType	OSType	Тип операционной системы (например, Windows или Linux) образа.
verificationType	VerificationType	Будет ли служба пакетной службы Azure активно проверять совместимость образа с соответствующим номером SKU агента вычислений.

ImageReference

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

Имя	Тип	Описание
communityGalleryImageId	string	Уникальный идентификатор образа коллекции сообщества Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET коллекции сообщества.
exactVersion	string	Конкретная версия образа платформы или образа Marketplace, используемая для создания узла. Это поле только для чтения отличается от "версии" только в том случае, если значение, указанное для "версии", когда пул был создан, был "последняя".
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. Чтобы выбрать последнюю версию образа, можно указать значение "последняя". Если опущено, значение по умолчанию — "последняя".
virtualMachineImageId	string	Идентификатор ресурса ARM образа коллекции вычислений Azure. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Это форма /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} для постоянного использования последней версии образа. Это свойство является взаимоисключающим с другими свойствами ImageReference. Образ коллекции вычислений Azure должен иметь реплики в том же регионе и должен находиться в той же подписке, что и учетная запись пакетной службы Azure. Если версия образа не указана в imageId, будет использоваться последняя версия. Сведения о параметрах брандмауэра для агента пакетного вычислительного узла для взаимодействия со службой пакетной службы см. в https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

OSType

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

Имя	Тип	Описание
linux	string	Операционная система Linux.
windows	string	Операционная система Windows.

VerificationType

Будет ли служба пакетной службы Azure активно проверять совместимость образа с соответствующим номером SKU агента вычислений.

Имя	Тип	Описание
unverified	string	Связанный номер SKU агента вычислительного узла должен иметь двоичную совместимость с образом, но определенные функциональные возможности не были проверены.
verified	string	Образ гарантированно совместим с соответствующим номером SKU агента вычислений, и все функции пакетной службы были подтверждены для работы должным образом.

Поделиться через

Account - List Supported Images

Параметры URI

Заголовок запроса

Ответы

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

azure_auth

Области

Authorization

Примеры

Account list node agent skus

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

Пример ответа

Определения

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Дополнительные ресурсы