Account - List Supported Images

Referencia

Service:: Batch Service

API Version:: 2023-11-01.18.0

Enumera todas las imágenes de máquina virtual compatibles con el servicio 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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
api-version	query	True	string	Versión de la API de cliente.
$filter	query		string	Una cláusula de $filter OData. Para obtener más información sobre cómo construir este filtro, vea https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	Número máximo de elementos que se van a devolver en la respuesta. Se devolverá un máximo de 1000 resultados.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

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

Nombre	Tipo	Description
client-request-id	string uuid	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-rfc1123	Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK	AccountListSupportedImagesResult	Respuesta que contiene la lista de imágenes de máquina virtual admitidas. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Error del servicio Batch.

Nombre

Tipo

Description

200 OK

AccountListSupportedImagesResult

Respuesta que contiene la lista de imágenes de máquina virtual admitidas.

Headers

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

Other Status Codes

BatchError

Error del servicio Batch.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

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

Definiciones

Nombre	Description
AccountListSupportedImagesResult	Resultado de enumerar las imágenes de máquina virtual admitidas.
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.
ImageInformation	Referencia a la imagen de Azure Virtual Machines Marketplace e información adicional sobre la imagen.
ImageReference	Referencia a una imagen de Azure Virtual Machines Marketplace o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imagen de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".
OSType	El tipo de sistema operativo (por ejemplo, Windows o Linux) de la imagen.
VerificationType	Si el servicio Azure Batch comprueba activamente que la imagen es compatible con la SKU del agente de Compute Node asociada.

AccountListSupportedImagesResult

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

Nombre	Tipo	Description
odata.nextLink	string	Dirección URL para obtener el siguiente conjunto de resultados.
value	ImageInformation[]	Lista de imágenes de máquina virtual admitidas.

BatchError

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	ErrorMessage	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 contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error 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.

ErrorMessage

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

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.

ImageInformation

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

Nombre	Tipo	Description
batchSupportEndOfLife	string	Hora a la que el servicio Azure Batch dejará de aceptar solicitudes de creación de grupo para la imagen.
capabilities	string[]	Las funcionalidades o características que admite image. No se muestran todas las funcionalidades de la imagen. Las funcionalidades de esta lista se consideran de interés especial y generalmente están relacionadas con la integración con otras características del servicio Azure Batch.
imageReference	ImageReference	Referencia a la imagen de Marketplace de la máquina virtual de Azure.
nodeAgentSKUId	string	Identificador de la SKU del agente de nodo de proceso que admite la imagen.
osType	OSType	El tipo de sistema operativo (por ejemplo, Windows o Linux) de la imagen.
verificationType	VerificationType	Si el servicio Azure Batch comprueba activamente que la imagen es compatible con la SKU del agente de Compute Node asociada.

ImageReference

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

Nombre	Tipo	Description
exactVersion	string	La versión específica de la imagen de plataforma o la imagen de Marketplace que se usa para crear el nodo. Este campo de solo lectura difiere de "version" solo si el valor especificado para "version" cuando se creó el grupo era "latest".
offer	string	El tipo de oferta de la imagen de Marketplace de Azure Virtual Machines. Por ejemplo, UbuntuServer o WindowsServer.
publisher	string	Publicador de la imagen de Marketplace de Azure Virtual Machines. Por ejemplo, Canonical o MicrosoftWindowsServer.
sku	string	SKU de la imagen de Marketplace de Azure Virtual Machines. Por ejemplo, 18.04-LTS o 2019-Datacenter.
version	string	La versión de la imagen de Azure Virtual Machines Marketplace. Se puede especificar un valor de "latest" para seleccionar la versión más reciente de una imagen. Si se omite, el valor predeterminado es "latest".
virtualMachineImageId	string	Identificador de recurso de ARM de la imagen de Azure Compute Gallery. Los nodos de proceso del grupo se crearán con este identificador de imagen. Tiene el formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} o /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} para la versión de imagen más reciente. Esta propiedad es mutuamente excluyente con otras propiedades ImageReference. La imagen de Azure Compute Gallery debe tener réplicas en la misma región y debe estar en la misma suscripción que la cuenta de Azure Batch. Si la versión de la imagen no se especifica en imageId, se usará la versión más reciente. Para obtener información sobre la configuración del firewall para que el agente de Batch Compute Node se comunique con el servicio Batch, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

OSType

El tipo de sistema operativo (por ejemplo, Windows o Linux) de la imagen.

Nombre	Tipo	Description
linux	string	Sistema operativo Linux.
windows	string	Sistema operativo Windows.

VerificationType

Si el servicio Azure Batch comprueba activamente que la imagen es compatible con la SKU del agente de Compute Node asociada.

Nombre	Tipo	Description
unverified	string	La SKU del agente de Compute Node asociada debe tener compatibilidad binaria con la imagen, pero no se ha comprobado la funcionalidad específica.
verified	string	Se garantiza que la imagen es compatible con la SKU del agente de Compute Node asociada y todas las características de Batch se han confirmado para que funcionen según lo previsto.

Account - List Supported Images

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Authorization

Ejemplos

Account list node agent skus

Sample Request

Sample Response

Definiciones

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Recursos adicionales