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 suportadas pelo serviço Batch 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 do URI

Name	Em	Necessá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ão devolvidos.
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 do Pedido

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

Name	Tipo	Description
client-request-id	string uuid	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-rfc1123	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	AccountListSupportedImagesResult	Uma resposta que contém a lista de Imagens de Máquina Virtual suportadas. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço de lote.

Name

Tipo

Description

200 OK

AccountListSupportedImagesResult

Uma resposta que contém a lista de Imagens de Máquina Virtual suportadas.

Cabeçalhos

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

Other Status Codes

BatchError

O erro do serviço de lote.

Segurança

azure_auth

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

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

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Account list node agent skus

Pedido de amostra

HTTP

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

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
AccountListSupportedImagesResult	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.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
ImageInformation	Uma referência à Imagem do Azure Virtual Machines Marketplace e informações adicionais sobre a Imagem.
ImageReference	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 Lote do Azure, consulte a operação 'Listar imagens suportadas'.
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 suportadas.

Name	Tipo	Description
odata.nextLink	string	O URL para obter o próximo conjunto de resultados.
value	ImageInformation[]	A lista de Imagens de Máquina Virtual suportadas.

BatchError

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

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.

ErrorMessage

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

Name	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 Azure Virtual Machines Marketplace e informações adicionais sobre a Imagem.

Name	Tipo	Description
batchSupportEndOfLife	string	A hora em que o serviço Lote do Azure deixará de aceitar solicitações de criação de Pool para a Imagem.
capabilities	string[]	Os recursos ou recursos suportados pela Imagem. Nem todos os recursos da imagem estão listados. Os recursos nesta lista são considerados de interesse especial e geralmente estão relacionados à integração com outros recursos no serviço Batch do Azure.
imageReference	ImageReference	A referência à Imagem do Marketplace da Máquina Virtual do Azure.
nodeAgentSKUId	string	A ID da SKU do agente do nó de computação que a imagem suporta.
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 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 Lote do Azure, consulte a operação 'Listar imagens suportadas'.

Name	Tipo	Description
communityGalleryImageId	string	O identificador exclusivo da imagem da galeria da comunidade 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 imagem do mercado usada para criar o nó. Este campo somente leitura difere de 'version' somente se o valor especificado para 'version' quando o pool foi criado era 'mais recente'.
offer	string	O tipo de oferta da Imagem do Azure Virtual Machines Marketplace. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O editor da Imagem do Azure Virtual Machines Marketplace. Por exemplo, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId	string	O identificador exclusivo da imagem da galeria compartilhada Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida a partir da chamada GET da imagem da galeria partilhada.
sku	string	A SKU da imagem do Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.
version	string	A versão da Imagem do Azure Virtual Machines Marketplace. Um valor de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma imagem. Se omitido, o padrão é 'mais recente'.
virtualMachineImageId	string	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 essa ID de imagem. Este é o formato /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 padronizar a versão de imagem mais recente. Esta 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 que a conta do Lote do Azure. Se a versão da imagem não for especificada no imageId, a versão mais recente será usada. Para obter informações sobre as configurações de firewall para o agente Batch Compute Node se comunicar com o serviço Batch, 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.

Name	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.

Name	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	É garantido que a imagem é compatível com o SKU do agente do nó de computação associado e todos os recursos do lote foram confirmados para funcionar conforme o esperado.

Partilhar via

Account - List Supported Images

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Authorization

Exemplos

Account list node agent skus

Pedido de amostra

Resposta da amostra

Definições

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Recursos adicionais