Pools - List Supported Images

Serviço:: Batch Service

Versão da API:: 2025-06-01

Lista todas as Imagens de Máquina Virtual suportadas pelo serviço Batch do Azure.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	Ponto de extremidade da conta em lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$filter	query		string	Uma cláusula $filter OData. Para mais informações sobre como construir este filtro, veja https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	O número máximo de itens a serem retornados na resposta. Podem ser devolvidos um máximo de 1000 candidaturas.
timeOut	query		integer (int32)	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

Name	Tipo	Description
client-request-id	string	A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date	string (date-time-rfc7231)	A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name	Tipo	Description
200 OK	BatchAccountListSupportedImagesResult	O pedido foi bem-sucedido. Cabeçalhos ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Uma resposta de erro inesperada.

Name

Tipo

Description

200 OK

BatchAccountListSupportedImagesResult

O pedido foi bem-sucedido.

Cabeçalhos

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

Other Status Codes

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

Account list node agent skus

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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"
    }
  ]
}

Definições

Name	Description
BatchAccountListSupportedImagesResult	O resultado da listagem das Imagens de Máquina Virtual suportadas.
BatchError	Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
BatchErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
BatchSupportedImage	Uma referência à Imagem do Azure Virtual Machines Marketplace e informações adicionais sobre a Imagem.
BatchVmImageReference	Uma referência a uma Imagem do Azure Virtual Machines Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas pelo Azure Batch, consulte a operação ' Listar Imagens Suportadas '.
ImageVerificationType	Enums ImageVerificationType
OSType	OSTip enums

BatchAccountListSupportedImagesResult

Object

O resultado da listagem das Imagens de Máquina Virtual suportadas.

Name	Tipo	Description
odata.nextLink	string (uri)	O URL para obter o próximo conjunto de resultados.
value	BatchSupportedImage[]	A lista de Imagens de Máquinas Virtuais suportadas.

BatchError

Object

Uma resposta de erro recebida do serviço Batch do Azure.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	BatchErrorMessage	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Object

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas com a resposta de erro.

BatchErrorMessage

Object

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Name	Tipo	Description
lang	string	O código da linguagem da mensagem de erro.
value	string	O texto da mensagem.

BatchSupportedImage

Object

Uma referência à Imagem do Azure Virtual Machines Marketplace e informações adicionais sobre a Imagem.

Name	Tipo	Description
batchSupportEndOfLife	string (date-time)	O momento em que o serviço Batch do Azure deixa de aceitar pedidos de criação de pool para a Imagem.
capabilities	string[]	As capacidades ou funcionalidades que a Imagem suporta. Nem todas as capacidades da Imagem estão listadas. As capacidades desta lista são consideradas de interesse especial e estão geralmente relacionadas com a integração com outras funcionalidades do serviço Batch do Azure.
imageReference	BatchVmImageReference	A referência à imagem Marketplace da Azure Virtual Machine.
nodeAgentSKUId	string	O ID do SKU agente do Compute Node que a Imagem suporta.
osType	OSType	O tipo de sistema operativo (por exemplo, Windows ou Linux) da Imagem.
verificationType	ImageVerificationType	Se o serviço Batch do Azure verifica ativamente que a imagem é compatível com o SKU associado do agente Compute Node.

BatchVmImageReference

Object

Uma referência a uma Imagem do Azure Virtual Machines Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas pelo Azure Batch, consulte a operação ' Listar Imagens Suportadas '.

Name	Tipo	Description
communityGalleryImageId	string	A imagem da galeria comunitária identificador único. Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida na chamada GET da galeria da comunidade.
exactVersion	string	A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Este campo de apenas leitura difere de 'versão' apenas se o valor especificado para 'versão' quando o pool foi criado for 'mais recente'.
offer	string	O tipo de oferta da Imagem do Marketplace de Máquinas Virtuais Azure. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O editor da Azure Virtual Machines Marketplace Image. Por exemplo, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId	string	Identificador único da imagem da galeria partilhada. Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida a partir da chamada GET da imagem da galeria partilhada.
sku	string	O SKU da Imagem Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.
version	string	A versão da Imagem do Azure Virtual Machines Marketplace. Pode ser especificado um valor de 'mais recente' para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão é 'mais recente'.
virtualMachineImageId	string (arm-id)	O identificador de recurso ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Pool serão criados usando este ID de Imagem. Isto é da forma /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para usar sempre a versão mais recente da imagem. Esta propriedade é mutuamente exclusiva com outras propriedades do ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma subscrição da conta Batch do Azure. Se a versão da imagem não for especificada no imageId, será usada a versão mais recente. Para informações sobre as definições do firewall do agente Batch Compute Node para comunicar com o serviço Batch, veja https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ImageVerificationType

Enumeração

Enums ImageVerificationType

Valor	Description
verified	A imagem é garantida como compatível com o SKU associado ao agente de Compute Node e todas as funcionalidades Batch foram confirmadas como funcionando conforme esperado.
unverified	O SKU associado ao agente do Compute Node deve ter compatibilidade binária com a Imagem, mas a funcionalidade específica não foi verificada.

OSType

Enumeração

OSTip enums

Valor	Description
linux	O sistema operativo Linux.
windows	O sistema operacional Windows.

Partilhar via

Pools - List Supported Images

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

Account list node agent skus

Pedido de amostra

Resposta da amostra

Definições

BatchAccountListSupportedImagesResult

BatchError

BatchErrorDetail

BatchErrorMessage

BatchSupportedImage

BatchVmImageReference

ImageVerificationType

OSType