Account - List Supported Images
Список всех образов виртуальных машин, поддерживаемых службой пакетная служба Azure.
GET {batchUrl}/supportedimages?api-version=2023-11-01.18.0
GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure. |
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 |
Максимальное количество элементов, возвращаемых в ответе. Возвращается не более 1000 результатов. |
|
timeout
|
query |
integer int32 |
Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 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 |
Ответ, содержащий список поддерживаемых образов виртуальных машин. Headers
|
|
Other Status Codes |
Ошибка пакетной службы. |
Безопасность
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
GET account.region.batch.azure.com/supportedimages?api-version=2023-11-01.18.0
Sample Response
{
"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"
}
]
}
Определения
Имя | Описание |
---|---|
Account |
Результат перечисления поддерживаемых образов виртуальных машин. |
Batch |
Ответ об ошибке, полученный от службы пакетная служба Azure. |
Batch |
Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure. |
Error |
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure. |
Image |
Ссылка на образ Azure Виртуальные машины Marketplace и дополнительные сведения об этом образе. |
Image |
Ссылка на образ Azure Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов". |
OSType |
Тип операционной системы (например, Windows или Linux) образа. |
Verification |
Проверяет ли служба пакетная служба Azure, что образ совместим со связанным номером SKU агента вычислительного узла. |
AccountListSupportedImagesResult
Результат перечисления поддерживаемых образов виртуальных машин.
Имя | Тип | Описание |
---|---|---|
odata.nextLink |
string |
URL-адрес для получения следующего набора результатов. |
value |
Список поддерживаемых образов виртуальных машин. |
BatchError
Ответ об ошибке, полученный от службы пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды инвариантны и предназначены для программного использования. |
message |
Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе. |
|
values |
Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке. |
BatchErrorDetail
Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
key |
string |
Идентификатор, указывающий значение свойства Value. |
value |
string |
Дополнительные сведения, включенные в ответ об ошибке. |
ErrorMessage
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
lang |
string |
Код языка сообщения об ошибке |
value |
string |
Текст сообщения. |
ImageInformation
Ссылка на образ Azure Виртуальные машины Marketplace и дополнительные сведения об этом образе.
Имя | Тип | Описание |
---|---|---|
batchSupportEndOfLife |
string |
Время, когда служба пакетная служба Azure перестанет принимать запросы на создание пула для образа. |
capabilities |
string[] |
Возможности или функции, которые поддерживает образ. |
imageReference |
Ссылка на образ Marketplace виртуальной машины Azure. |
|
nodeAgentSKUId |
string |
Идентификатор SKU агента вычислительного узла, который поддерживает образ. |
osType |
Тип операционной системы (например, Windows или Linux) образа. |
|
verificationType |
Проверяет ли служба пакетная служба Azure, что образ совместим со связанным номером SKU агента вычислительного узла. |
ImageReference
Ссылка на образ Azure Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов".
Имя | Тип | Описание |
---|---|---|
exactVersion |
string |
Конкретная версия образа платформы или образа Marketplace, используемого для создания узла. Это поле, доступное только для чтения, отличается от "version" только в том случае, если для параметра version при создании пула было задано значение "latest". |
offer |
string |
Тип предложения образа Azure Виртуальные машины Marketplace. |
publisher |
string |
Издатель образа Azure Виртуальные машины Marketplace. |
sku |
string |
Номер SKU образа Azure Виртуальные машины Marketplace. |
version |
string |
Версия образа Azure Виртуальные машины 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/galleryName/images/{imageDefinitionName} для всегда используется последняя версия образа. |
OSType
Тип операционной системы (например, Windows или Linux) образа.
Имя | Тип | Описание |
---|---|---|
linux |
string |
Операционная система Linux. |
windows |
string |
Операционная система Windows. |
VerificationType
Проверяет ли служба пакетная служба Azure, что образ совместим со связанным номером SKU агента вычислительного узла.
Имя | Тип | Описание |
---|---|---|
unverified |
string |
Связанный номер SKU агента вычислительного узла должен иметь двоичную совместимость с образом, но определенные функциональные возможности не были проверены. |
verified |
string |
Образ гарантированно будет совместим с соответствующим номером SKU агента вычислительного узла, и все функции пакетной службы были подтверждены для правильной работы. |