Account - List Supported Images

Referência

Service:: Batch Service

API Version:: 2023-11-01.18.0

Lista todas as Imagens da Máquina Virtual suportadas pelo serviço 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 do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
api-version	query	True	string	Versão da API de Cliente.
$filter	query		string	Uma cláusula OData $filter. Para obter mais informações sobre a construção deste filtro, consulte https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	O número máximo de itens a devolver na resposta. Será devolvido um máximo de 1000 resultados.
timeout	query		integer int32	O tempo máximo que o servidor pode passar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Tipo	Description
client-request-id	string uuid	A identidade do pedido gerado pelo autor da chamada, na forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date	string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-o explicitamente se estiver a chamar a API REST diretamente.

Respostas

Name	Tipo	Description
200 OK	AccountListSupportedImagesResult	Uma resposta que contém a lista de Imagens de Máquinas Virtuais suportadas. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço Batch.

Name

Tipo

Description

200 OK

AccountListSupportedImagesResult

Uma resposta que contém a lista de Imagens de Máquinas Virtuais suportadas.

Headers

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

Other Status Codes

BatchError

O erro do serviço Batch.

Segurança

azure_auth

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

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

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

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

Definições

Name	Description
AccountListSupportedImagesResult	O resultado da listagem das Imagens de Máquinas Virtuais suportadas.
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
ImageInformation	Uma referência à Imagem do Azure Máquinas Virtuais Marketplace e informações adicionais sobre a Imagem.
ImageReference	Uma referência a uma Imagem do Marketplace do Azure Máquinas Virtuais ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências da imagem Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas".
OSType	O tipo de sistema operativo (por exemplo, Windows ou Linux) da Imagem.
VerificationType	Se o serviço Azure Batch verifica ativamente se a Imagem é compatível com o SKU do agente de Nó de Computação associado.

AccountListSupportedImagesResult

O resultado da listagem das Imagens de Máquinas Virtuais 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áquinas Virtuais suportadas.

BatchError

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

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 que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

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

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

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 Máquinas Virtuais Marketplace e informações adicionais sobre a Imagem.

Name	Tipo	Description
batchSupportEndOfLife	string	A hora em que o serviço Azure Batch deixará de aceitar a criação de pedidos de Conjunto para a Imagem.
capabilities	string[]	As capacidades ou funcionalidades suportadas pela Imagem. Nem todas as capacidades da Imagem estão listadas. As capacidades nesta lista são consideradas de especial interesse e estão geralmente relacionadas com a integração com outras funcionalidades no serviço Azure Batch.
imageReference	ImageReference	A referência à Imagem do Marketplace da Máquina Virtual do Azure.
nodeAgentSKUId	string	O ID do SKU do agente do Nó de Computação que a Imagem suporta.
osType	OSType	O tipo de sistema operativo (por exemplo, Windows ou Linux) da Imagem.
verificationType	VerificationType	Se o serviço Azure Batch verifica ativamente se a Imagem é compatível com o SKU do agente de Nó de Computação associado.

ImageReference

Uma referência a uma Imagem do Marketplace do Azure Máquinas Virtuais ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências da imagem Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas".

Name	Tipo	Description
exactVersion	string	A versão específica da imagem da plataforma ou imagem do marketplace utilizada para criar o nó. Este campo só de leitura só difere de "versão" se o valor especificado para "versão" quando o conjunto foi criado for "mais recente".
offer	string	O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O publicador da Imagem do Azure Máquinas Virtuais Marketplace. Por exemplo, Canonical ou MicrosoftWindowsServer.
sku	string	O SKU da Imagem do Azure Máquinas Virtuais Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.
version	string	A versão da Imagem do Azure Máquinas Virtuais Marketplace. Pode especificar um valor "mais recente" para selecionar a versão mais recente de uma Imagem. Se omitido, a predefinição é "mais recente".
virtualMachineImageId	string	O identificador de recursos do ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Conjunto serão criados com este ID de Imagem. Este é o 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 predefinir sempre a versão mais recente da imagem. Esta propriedade é mutuamente exclusiva com outras propriedades ImageReference. A Imagem da Galeria de Computação do Azure tem de ter réplicas na mesma região e tem de estar na mesma subscrição que a conta Azure Batch. Se a versão da imagem não for especificada no imageId, será utilizada a versão mais recente. Para obter informações sobre as definições de firewall do agente do Nó de Computação do Batch para comunicar com o serviço Batch, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

OSType

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

Name	Tipo	Description
linux	string	O sistema operativo Linux.
windows	string	O sistema operativo Windows.

VerificationType

Se o serviço Azure Batch verifica ativamente se a Imagem é compatível com o SKU do agente de Nó de Computação associado.

Name	Tipo	Description
unverified	string	O SKU do agente de Nó de Computação associado deve ter compatibilidade binária com a Imagem, mas não foi verificada uma funcionalidade específica.
verified	string	É garantido que a Imagem é compatível com o SKU do agente do Nó de Computação associado e todas as funcionalidades do Batch foram confirmadas para funcionar conforme esperado.

Partilhar via

Account - List Supported Images

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Scopes

Authorization

Exemplos

Account list node agent skus

Sample Request

Sample Response

Definições

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Recursos adicionais