Pools - List Supported Images

Servicio:: Batch Service

Versión de la API:: 2025-06-01

Enumera todas las imágenes de máquina virtual compatibles con el servicio Azure Batch.

GET {endpoint}/supportedimages?api-version=2025-06-01

Con parámetros opcionales:

GET {endpoint}/supportedimages?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	Punto de conexión de la cuenta de Batch (por ejemplo: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	La versión de API que se va a utilizar para esta operación.
$filter	query		string	Una cláusula $filter de OData. Para más información sobre cómo construir este filtro, véase https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Número máximo de elementos que se van a devolver en la respuesta. Se pueden devolver un máximo de 1000 solicitudes.
timeOut	query		integer (int32)	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.".

Encabezado de la solicitud

Nombre	Tipo	Description
client-request-id	string	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date	string (date-time-rfc7231)	Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK	BatchAccountListSupportedImagesResult	La solicitud se ha realizado correctamente. Encabezados ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

BatchAccountListSupportedImagesResult

La solicitud se ha realizado correctamente.

Encabezados

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

Other Status Codes

BatchError

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre	Description
https://batch.core.windows.net//.default

Ejemplos

Account list node agent skus

Solicitud de ejemplo

HTTP

GET {endpoint}/supportedimages?api-version=2025-06-01

Respuesta de muestra

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"
    }
  ]
}

Definiciones

Nombre	Description
BatchAccountListSupportedImagesResult	Resultado de enumerar las imágenes de máquina virtual admitidas.
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Un elemento de información adicional incluida en una respuesta de error de Azure Batch.
BatchErrorMessage	Mensaje de error recibido en una respuesta de error de Azure Batch.
BatchSupportedImage	Referencia a la imagen de Marketplace de Azure Virtual Machines e información adicional sobre la imagen.
BatchVmImageReference	Referencia a una imagen de Marketplace de Azure Virtual Machines o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imágenes de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".
ImageVerificationType	Enums ImageVerificationType
OSType	OSType enums

BatchAccountListSupportedImagesResult

Objeto

Resultado de enumerar las imágenes de máquina virtual admitidas.

Nombre	Tipo	Description
odata.nextLink	string (uri)	La URL para obtener el siguiente conjunto de resultados.
value	BatchSupportedImage[]	La lista de imágenes de máquinas virtuales compatibles.

BatchError

Objeto

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	BatchErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contienen detalles adicionales sobre el error.

BatchErrorDetail

Objeto

Un elemento de información adicional incluida en una respuesta de error de Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	La información adicional incluida con la respuesta de error.

BatchErrorMessage

Objeto

Mensaje de error recibido en una respuesta de error de Azure Batch.

Nombre	Tipo	Description
lang	string	El código de idioma del mensaje de error.
value	string	El texto del mensaje.

BatchSupportedImage

Objeto

Referencia a la imagen de Marketplace de Azure Virtual Machines e información adicional sobre la imagen.

Nombre	Tipo	Description
batchSupportEndOfLife	string (date-time)	El momento en que el servicio Batch de Azure deja de aceptar solicitudes de creación de pool para la imagen.
capabilities	string[]	Las capacidades o características que soporta la Imagen. No todas las capacidades de la imagen están listadas. Las capacidades de esta lista se consideran de especial interés y generalmente están relacionadas con la integración con otras funciones del servicio Batch de Azure.
imageReference	BatchVmImageReference	La referencia a la imagen del Marketplace de Azure Virtual Machine.
nodeAgentSKUId	string	El ID del SKU agente de nodo de cálculo que soporta la Imagen.
osType	OSType	El tipo de sistema operativo (por ejemplo, Windows o Linux) de la imagen.
verificationType	ImageVerificationType	Si el servicio Batch de Azure verifica activamente que la imagen es compatible con el SKU asociado del agente de nodos de cálculo.

BatchVmImageReference

Objeto

Referencia a una imagen de Marketplace de Azure Virtual Machines o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imágenes de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".

Nombre	Tipo	Description
communityGalleryImageId	string	La imagen de la galería comunitaria identifica únicamente. Esta propiedad es mutuamente excluyente con otras propiedades y se puede capturar desde la llamada GET de imagen de la galería de la comunidad.
exactVersion	string	La versión específica de la imagen de plataforma o de marketplace utilizada para crear el nodo. Este campo de solo lectura difiere de 'versión' solo si el valor especificado para 'versión' cuando se creó el pool era 'más reciente'.
offer	string	El tipo de oferta de la imagen Azure Virtual Machines Marketplace. Por ejemplo, UbuntuServer o WindowsServer.
publisher	string	El editor de la imagen Azure Virtual Machines Marketplace. Por ejemplo, Canonical o MicrosoftWindowsServer.
sharedGalleryImageId	string	Identificador único de la imagen de galería compartida. Esta propiedad es mutuamente excluyente con otras propiedades y se puede capturar desde la llamada GET de imagen de galería compartida.
sku	string	El SKU de la imagen Azure Virtual Machines Marketplace. Por ejemplo, 18.04-LTS o 2019-Datacenter.
version	string	La versión de la Imagen del Marketplace de Máquinas Virtuales de Azure. Se puede especificar un valor de 'más reciente' para seleccionar la última versión de una Imagen. Si se omite, el valor predeterminado es "latest".
virtualMachineImageId	string (arm-id)	Identificador de recursos de ARM de la imagen de Azure Compute Gallery. Los nodos de cómputo en el Pool se crearán usando este ID de Imagen. Esto es del tipo /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} o /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para siempre usar por defecto la última versión de la imagen. Esta propiedad es mutuamente excluyente con otras propiedades de ImageReference. La Imagen de la Galería de Computación de Azure debe tener réplicas en la misma región y debe estar en la misma suscripción que la cuenta de lotes de Azure. Si la versión de la imagen no se especifica en el imageId, se utilizará la versión más reciente. Para información sobre la configuración del cortafuegos del agente del Nodo de Cómputo por Lotes para comunicarse con el servicio por lotes, véase https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ImageVerificationType

Enumeración

Enums ImageVerificationType

Valor	Description
verified	La imagen está garantizada como compatible con el SKU asociado del agente de nodos de computación y todas las funciones por lotes han sido confirmadas como se esperaba.
unverified	El SKU de agente de nodos de cómputo asociado debería tener compatibilidad binaria con la imagen, pero no se ha verificado la funcionalidad específica.

OSType

Enumeración

OSType enums

Valor	Description
linux	El sistema operativo Linux.
windows	El sistema operativo Windows.

Compartir a través de

Pools - List Supported Images

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

OAuth2Auth

Ámbitos

Ejemplos

Account list node agent skus

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BatchAccountListSupportedImagesResult

BatchError

BatchErrorDetail

BatchErrorMessage

BatchSupportedImage

BatchVmImageReference

ImageVerificationType

OSType