Pools - List Supported Images

Serviço:: Batch Service

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

Lista todas as imagens de máquina virtual compatíveis com o serviço lote 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 de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	Ponto de extremidade da conta do Lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$filter	query		string	Uma cláusula $filter OData. Para mais informações sobre como construir esse 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. No máximo 1000 solicitações podem ser devolvidas.
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 maior que 30, o padrão será usado em seu lugar.".

Cabeçalho da solicitação

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

Respostas

Nome	Tipo	Description
200 OK	BatchAccountListSupportedImagesResult	A solicitação foi bem-sucedida. Cabeçalhos ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Uma resposta de erro inesperada.

Nome

Tipo

Description

200 OK

BatchAccountListSupportedImagesResult

A solicitação foi bem-sucedida.

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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

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

Exemplos

Account list node agent skus

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	Description
BatchAccountListSupportedImagesResult	O resultado da listagem das imagens de máquina virtual com suporte.
BatchError	Uma resposta de erro recebida do serviço do Lote 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 Marketplace de Máquinas Virtuais do Azure e informações adicionais sobre a Imagem.
BatchVmImageReference	Uma referência a uma imagem do Marketplace de Máquinas Virtuais do Azure 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 Lote do Azure, consulte a operação ' Listar Imagens Com Suporte'.
ImageVerificationType	Enums ImageVerificationType
OSType	OSType enums

BatchAccountListSupportedImagesResult

Objeto

O resultado da listagem das imagens de máquina virtual com suporte.

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

BatchError

Objeto

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	BatchErrorMessage	Uma mensagem que descreve 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

Objeto

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

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

BatchErrorMessage

Objeto

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

Nome	Tipo	Description
lang	string	O código de idioma da mensagem de erro.
value	string	O texto da mensagem.

BatchSupportedImage

Objeto

Uma referência à imagem do Marketplace de Máquinas Virtuais do Azure e informações adicionais sobre a Imagem.

Nome	Tipo	Description
batchSupportEndOfLife	string (date-time)	O momento em que o serviço Batch do Azure para de aceitar requisições de criação de pool para a imagem.
capabilities	string[]	As capacidades ou recursos que a Imagem suporta. Nem todas as capacidades da Imagem estão listadas. As capacidades desta lista são consideradas de interesse especial e geralmente estão relacionadas à integração com outros recursos do serviço Batch do Azure.
imageReference	BatchVmImageReference	A referência à Imagem do 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 operacional (por exemplo, Windows ou Linux) da imagem.
verificationType	ImageVerificationType	Se o serviço Batch do Azure verifica ativamente se a imagem é compatível com o SKU associado do agente de Compute Node.

BatchVmImageReference

Objeto

Uma referência a uma imagem do Marketplace de Máquinas Virtuais do Azure 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 Lote do Azure, consulte a operação ' Listar Imagens Com Suporte'.

Nome	Tipo	Description
communityGalleryImageId	string	A imagem da galeria comunitária identificador único. Essa propriedade é mutuamente exclusiva com outras propriedades e pode ser buscada na chamada GET da imagem 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ó. Esse campo somente leitura difere de 'versão' apenas se o valor especificado para 'versão' quando o pool foi criado fosse 'mais recente'.
offer	string	O tipo de oferta da Imagem do Marketplace de Máquinas Virtuais Azure. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	A editora da Azure Virtual Machines Marketplace Image. Por exemplo, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId	string	Identificador único da imagem da galeria compartilhada. Essa propriedade é mutuamente exclusiva com outras propriedades e pode ser buscada na chamada GET da imagem da galeria compartilhada.
sku	string	O SKU da Imagem do Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.
version	string	A versão da Imagem do Marketplace de Máquinas Virtuais do Azure. Um valor de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão será 'latest'.
virtualMachineImageId	string (arm-id)	O identificador de recurso do 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. Isso é 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 sempre usar a versão mais recente da imagem. Essa 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 estar na mesma assinatura da conta Batch do Azure. Se a versão da imagem não for especificada no imageId, a versão mais recente será usada. Para informações sobre as configurações do firewall para o agente do Nó de Computação Batch para se 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 todos os recursos do Batch foram confirmados como funcionando conforme esperado.
unverified	O SKU associado ao agente de Compute Node deve ter compatibilidade binária com a Imagem, mas a funcionalidade específica não foi verificada.

OSType

Enumeração

OSType enums

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

Compartilhar via

Pools - List Supported Images

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

OAuth2Auth

Escopos

Exemplos

Account list node agent skus

Solicitação de exemplo

Resposta de exemplo

Definições

BatchAccountListSupportedImagesResult

BatchError

BatchErrorDetail

BatchErrorMessage

BatchSupportedImage

BatchVmImageReference

ImageVerificationType

OSType