Pools - List Supported Images

Služba:: Batch Service

Verze rozhraní API:: 2025-06-01

Zobrazí seznam všech imagí virtuálních počítačů podporovaných službou Azure Batch.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod účtu Batch (například: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	Klauzule $filter OData. Pro více informací o konstrukci tohoto filtru viz https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Maximální počet položek, které se mají vrátit v odpovědi. Maximálně 1000 žádostí lze vrátit.
timeOut	query		integer (int32)	Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.".

Hlavička požadavku

Name	Typ	Description
client-request-id	string	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date	string (date-time-rfc7231)	Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Odpovědi

Name	Typ	Description
200 OK	BatchAccountListSupportedImagesResult	Požadavek byl úspěšný. Hlavičky ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Neočekávaná chybová odpověď

Name

Typ

Description

200 OK

BatchAccountListSupportedImagesResult

Požadavek byl úspěšný.

Hlavičky

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

Other Status Codes

BatchError

Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

Account list node agent skus

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
    }
  ]
}

Definice

Name	Description
BatchAccountListSupportedImagesResult	Výsledek výpisu podporovaných imagí virtuálních počítačů
BatchError	Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail	Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
BatchErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
BatchSupportedImage	Odkaz na image Azure Virtual Machines Marketplace a další informace o imagi.
BatchVmImageReference	Odkaz na image Azure Virtual Machines Marketplace nebo image galerie výpočetních prostředků Azure Pokud chcete získat seznam všech odkazů na image z Azure Marketplace ověřených službou Azure Batch, podívejte se na operaci Seznam podporovaných imagí.
ImageVerificationType	Enums ImageVerificationType
OSType	OSType enums

BatchAccountListSupportedImagesResult

Objekt

Výsledek výpisu podporovaných imagí virtuálních počítačů

Name	Typ	Description
odata.nextLink	string (uri)	Adresa URL pro získání další sady výsledků.
value	BatchSupportedImage[]	Seznam podporovaných obrazů virtuálních strojů.

BatchError

Objekt

Odpověď na chybu přijatá ze služby Azure Batch

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	BatchErrorMessage	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Objekt

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

Name	Typ	Description
key	string	Identifikátor určující význam vlastnosti Value.
value	string	Další informace zahrnuté v odpovědi na chybu.

BatchErrorMessage

Objekt

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

Name	Typ	Description
lang	string	Jazykový kód chybové zprávy.
value	string	Text zprávy.

BatchSupportedImage

Objekt

Odkaz na image Azure Virtual Machines Marketplace a další informace o imagi.

Name	Typ	Description
batchSupportEndOfLife	string (date-time)	Čas, kdy služba Azure Batch přestane přijímat požadavky na vytvoření poolu pro obrázek.
capabilities	string[]	Schopnosti nebo funkce, které Image podporuje. Ne všechny schopnosti Image jsou uvedeny. Schopnosti v tomto seznamu jsou považovány za zvlášť zajímavé a obecně souvisejí s integrací s dalšími funkcemi služby Azure Batch.
imageReference	BatchVmImageReference	Odkaz na Marketplace Image Azure Virtual Machine.
nodeAgentSKUId	string	ID agenta Compute Node, které obraz podporuje.
osType	OSType	Typ operačního systému (např. Windows nebo Linux) Image.
verificationType	ImageVerificationType	Zda služba Azure Batch aktivně ověřuje, že je obraz kompatibilní s příslušným SCU agenta Compute Node.

BatchVmImageReference

Objekt

Odkaz na image Azure Virtual Machines Marketplace nebo image galerie výpočetních prostředků Azure Pokud chcete získat seznam všech odkazů na image z Azure Marketplace ověřených službou Azure Batch, podívejte se na operaci Seznam podporovaných imagí.

Name	Typ	Description
communityGalleryImageId	string	Unikátní identifikátor obrázku komunitní galerie. Tato vlastnost se vzájemně vylučují s jinými vlastnostmi a lze ji načíst z volání GET galerie komunity.
exactVersion	string	Konkrétní verze obrazu platformy nebo obrázku tržiště použitého k vytvoření uzlu. Toto pole pouze pro čtení se liší od 'version' pouze tehdy, pokud byla hodnota uvedena pro 'version' při vytvoření poolu 'laput'.
offer	string	Typ nabídky je image Azure Virtual Machines Marketplace. Například UbuntuServer nebo WindowsServer.
publisher	string	Vydavatel Azure Virtual Machines Marketplace Image. Například Canonical nebo MicrosoftWindowsServer.
sharedGalleryImageId	string	Jedinečný identifikátor sdíleného obrázku galerie. Tato vlastnost se vzájemně vylučují s jinými vlastnostmi a lze ji načíst z volání GET sdíleného obrázku galerie.
sku	string	The SKU of the Azure Virtual Machines Marketplace Image. Například 18.04-LTS nebo 2019-Datacenter.
version	string	Verze Azure Virtual Machines Marketplace Image. Pro výběr nejnovější verze obrazu lze zadat hodnotu 'nejnejčasnější'. Pokud tento parametr vynecháte, výchozí hodnota je nejnovější.
virtualMachineImageId	string (arm-id)	Identifikátor prostředku ARM image galerie výpočetních prostředků Azure. Výpočetní uzly v poolu budou vytvořeny pomocí tohoto Image ID. Jedná se o podobu /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} nebo /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pro vždy výchozí nastavení na nejnovější verzi obrázku. Tato vlastnost je vzájemně vylučující se s ostatními vlastnostmi ImageReference. Obrázek Azure Compute Gallery musí mít repliky ve stejném regionu a musí být ve stejném předplatném jako účet Azure Batch. Pokud verze obrázku není v imageID uvedena, použije se nejnovější verze. Pro informace o nastavení firewallu pro komunikaci agenta Batch Compute Node s Batch službou viz https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ImageVerificationType

Výčet

Enums ImageVerificationType

Hodnota	Description
verified	Obraz je zaručeně kompatibilní s příslušným SKU agenta Compute Node a všechny funkce Batch byly potvrzeny jako fungující podle očekávání.
unverified	Přiřazený agent Compute Node by měl mít binární kompatibilitu s obrazem, ale konkrétní funkce nebyla ověřena.

OSType

Výčet

OSType enums

Hodnota	Description
linux	Operační systém Linux.
windows	Operační systém Windows.

Sdílet prostřednictvím

Pools - List Supported Images

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

OAuth2Auth

Rozsahy

Příklady

Account list node agent skus

Ukázkový požadavek

Ukázková odpověď

Definice

BatchAccountListSupportedImagesResult

BatchError

BatchErrorDetail

BatchErrorMessage

BatchSupportedImage

BatchVmImageReference

ImageVerificationType

OSType