你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Account - List Supported Images

参考

Service:: Batch Service

API Version:: 2023-11-01.18.0

列出Azure Batch服务支持的所有虚拟机映像。

GET {batchUrl}/supportedimages?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI 参数

名称	在	必需	类型	说明
batchUrl	path	True	string	所有Azure Batch服务请求的基 URL。
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	AccountListSupportedImagesResult	包含支持的虚拟机映像列表的响应。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服务中的错误。

名称

类型

说明

200 OK

AccountListSupportedImagesResult

包含支持的虚拟机映像列表的响应。

Headers

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

Other Status Codes

BatchError

Batch 服务中的错误。

安全性

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

HTTP

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

定义

名称	说明
AccountListSupportedImagesResult	列出支持的虚拟机映像的结果。
BatchError	从Azure Batch服务收到的错误响应。
BatchErrorDetail	Azure Batch错误响应中包含的其他信息项。
ErrorMessage	Azure Batch错误响应中收到的错误消息。
ImageInformation	对 Azure 虚拟机市场映像的引用，以及有关映像的其他信息。
ImageReference	对 Azure 虚拟机市场映像或 Azure Compute Gallery 映像的引用。若要获取Azure Batch验证的所有Azure 市场图像引用的列表，请参阅“列出支持的映像”操作。
OSType	操作系统的类型 (例如映像的 Windows 或 Linux) 。
VerificationType	Azure Batch服务是否主动验证映像是否与关联的计算节点代理 SKU 兼容。

AccountListSupportedImagesResult

列出支持的虚拟机映像的结果。

名称	类型	说明
odata.nextLink	string	用于获取下一组结果的 URL。
value	ImageInformation[]	支持的虚拟机映像列表。

BatchError

从Azure Batch服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
message	ErrorMessage	描述错误的消息，该消息适用于在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的其他详细信息的键值对的集合。

BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。

名称	类型	说明
key	string	指定 Value 属性的含义的标识符。
value	string	错误响应附带的其他信息。

ErrorMessage

Azure Batch错误响应中收到的错误消息。

名称	类型	说明
lang	string	错误消息的语言代码
value	string	消息的文本。

ImageInformation

对 Azure 虚拟机市场映像的引用，以及有关映像的其他信息。

名称	类型	说明
batchSupportEndOfLife	string	Azure Batch服务停止接受映像的池创建请求的时间。
capabilities	string[]	映像支持的功能或特性。未列出映像的每个功能。此列表中的功能被视为特别感兴趣的功能，通常与Azure Batch服务中的其他功能的集成相关。
imageReference	ImageReference	对 Azure 虚拟机市场映像的引用。
nodeAgentSKUId	string	映像支持的计算节点代理 SKU 的 ID。
osType	OSType	操作系统的类型 (例如映像的 Windows 或 Linux) 。
verificationType	VerificationType	Azure Batch服务是否主动验证映像是否与关联的计算节点代理 SKU 兼容。

ImageReference

对 Azure 虚拟机市场映像或 Azure Compute Gallery 映像的引用。若要获取Azure Batch验证的所有Azure 市场图像引用的列表，请参阅“列出支持的映像”操作。

名称	类型	说明
exactVersion	string	用于创建节点的平台映像或市场映像的特定版本。仅当创建池时为“version”指定的值为“latest”时，此只读字段才不同于“version”。
offer	string	Azure 虚拟机市场映像的产品/服务类型。例如，UbuntuServer 或 WindowsServer。
publisher	string	Azure 虚拟机市场映像的发布者。例如，Canonical 或 MicrosoftWindowsServer。
sku	string	Azure 虚拟机市场映像的 SKU。例如，18.04-LTS 或 2019-Datacenter。
version	string	Azure 虚拟机市场映像的版本。可以指定值“latest”以选择最新版本的映像。如果省略，则默认值为“latest”。
virtualMachineImageId	string	Azure Compute Gallery 映像的 ARM 资源标识符。池中的计算节点将使用此映像 ID 创建。其格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} 或 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} ，始终默认为最新的映像版本。此属性与其他 ImageReference 属性互斥。 Azure Compute Gallery 映像的副本必须位于同一区域，并且必须与 Azure Batch 帐户位于同一订阅中。如果未在 imageId 中指定映像版本，将使用最新版本。有关 Batch 计算节点代理与 Batch 服务通信的防火墙设置的信息，请参阅 https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration。

OSType

操作系统的类型 (例如映像的 Windows 或 Linux) 。

名称	类型	说明
linux	string	Linux 操作系统。
windows	string	Windows 操作系统。

VerificationType

Azure Batch服务是否主动验证映像是否与关联的计算节点代理 SKU 兼容。

名称	类型	说明
unverified	string	关联的计算节点代理 SKU 应与映像具有二进制兼容性，但尚未验证特定功能。
verified	string	保证映像与关联的计算节点代理 SKU 兼容，并且所有 Batch 功能都已确认按预期工作。

Account - List Supported Images

URI 参数

请求头

响应

安全性

azure_auth

Scopes

Authorization

示例

Account list node agent skus

Sample Request

Sample Response

定义

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

其他资源