Account - List Supported Images

Referência

Serviço:: Batch Service

Versão da API:: 2024-07-01.20.0

Lista todas as imagens de máquina virtual compatíveis com o serviço lote do Azure.

GET {batchUrl}/supportedimages?api-version=2024-07-01.20.0

Com parâmetros opcionais:

GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
api-version	query	True	string	Versão da API do cliente.
$filter	query		string	Uma cláusula $filter OData. Para obter mais informações sobre como construir esse filtro, consulte https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	O número máximo de itens a serem retornados na resposta. Um máximo de 1000 resultados será retornado.
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.

Cabeçalho da solicitação

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

Nome	Tipo	Description
client-request-id	string uuid	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-rfc1123	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	AccountListSupportedImagesResult	Uma resposta que contém a lista de imagens de máquina virtual com suporte. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Nome

Tipo

Description

200 OK

AccountListSupportedImagesResult

Uma resposta que contém a lista de imagens de máquina virtual com suporte.

Cabeçalhos

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

Other Status Codes

BatchError

O erro do serviço do Lote.

Segurança

azure_auth

Fluxo de código de autenticação do Microsoft Entra OAuth 2.0

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

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Tipo: apiKey
Em: header

Exemplos

Account list node agent skus

Solicitação de exemplo

HTTP

GET account.region.batch.azure.com/supportedimages?api-version=2024-07-01.20.0

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
AccountListSupportedImagesResult	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.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
ImageInformation	Uma referência à imagem do Marketplace de Máquinas Virtuais do Azure e informações adicionais sobre a Imagem.
ImageReference	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'.
OSType	O tipo de sistema operacional (por exemplo, Windows ou Linux) da Imagem.
VerificationType	Se o serviço lote do Azure verifica ativamente se a imagem é compatível com a SKU do agente do Nó de Computação associada.

AccountListSupportedImagesResult

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

Nome	Tipo	Description
odata.nextLink	string	A URL para obter o próximo conjunto de resultados.
value	ImageInformation[]	A lista de imagens de máquina virtual com suporte.

BatchError

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	ErrorMessage	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

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.

ErrorMessage

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.

ImageInformation

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

Nome	Tipo	Description
batchSupportEndOfLife	string	A hora em que o serviço lote do Azure deixará de aceitar solicitações de criação do Pool para a Imagem.
capabilities	string[]	Os recursos ou recursos compatíveis com a Imagem. Nem todas as funcionalidades da Imagem estão listadas. Os recursos nesta lista são considerados de interesse especial e geralmente estão relacionados à integração com outros recursos no serviço do Lote do Azure.
imageReference	ImageReference	A referência à imagem do Marketplace da Máquina Virtual do Azure.
nodeAgentSKUId	string	A ID do SKU do agente do Nó de Computação compatível com a Imagem.
osType	OSType	O tipo de sistema operacional (por exemplo, Windows ou Linux) da Imagem.
verificationType	VerificationType	Se o serviço lote do Azure verifica ativamente se a imagem é compatível com a SKU do agente do Nó de Computação associada.

ImageReference

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	O identificador exclusivo da imagem da galeria da comunidade 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 será diferente de "version" somente se o valor especificado para 'version' quando o pool foi criado for 'latest'.
offer	string	O tipo de oferta da Imagem do Marketplace de Máquinas Virtuais do Azure. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O editor da Imagem do Marketplace de Máquinas Virtuais do Azure. Por exemplo, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId	string	O identificador exclusivo 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	A SKU da imagem do Marketplace de Máquinas Virtuais do Azure. 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 'mais recente' pode ser especificado para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão será 'latest'.
virtualMachineImageId	string	O identificador de recurso do ARM da Imagem da Galeria de Computação do Azure. Nós de computação no pool serão criados usando essa ID de imagem. Isso é do formulário /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 ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma assinatura da conta do Lote do Azure. Se a versão da imagem não for especificada na imageId, a versão mais recente será usada. Para obter informações sobre as configurações de firewall do agente do Nó de Computação em Lote para se comunicar com o serviço do Lote, consulte https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

OSType

O tipo de sistema operacional (por exemplo, Windows ou Linux) da Imagem.

Nome	Tipo	Description
linux	string	O sistema operacional Linux.
windows	string	O sistema operacional Windows.

VerificationType

Se o serviço lote do Azure verifica ativamente se a imagem é compatível com a SKU do agente do Nó de Computação associada.

Nome	Tipo	Description
unverified	string	O SKU do agente do Nó de Computação associado deve ter compatibilidade binária com a Imagem, mas a funcionalidade específica não foi verificada.
verified	string	A imagem tem a garantia de ser compatível com a SKU do agente do Nó de Computação associada e todos os recursos do Lote foram confirmados para funcionar conforme o esperado.

Compartilhar via

Account - List Supported Images

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Escopos

Authorization

Exemplos

Account list node agent skus

Solicitação de exemplo

Resposta de exemplo

Definições

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Recursos adicionais