Account - List Supported Images

Reference

Service:: Batch Service

API Version:: 2023-11-01.18.0

Zobrazí seznam všech imagí virtuálních počítačů podporovaných službou 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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky Azure Batch služby.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru najdete v tématu https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	Maximální počet položek, které se mají v odpovědi vrátit. Vrátí se maximálně 1000 výsledků.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Typ	Description
client-request-id	string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date	string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

Odpovědi

Name	Typ	Description
200 OK	AccountListSupportedImagesResult	Odpověď obsahující seznam podporovaných imagí virtuálních počítačů. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Name

Typ

Description

200 OK

AccountListSupportedImagesResult

Odpověď obsahující seznam podporovaných imagí virtuálních počítačů.

Headers

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

Other Status Codes

BatchError

Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
AccountListSupportedImagesResult	Výsledek výpisu podporovaných imagí virtuálních počítačů.
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
ImageInformation	Odkaz na image Azure Virtual Machines Marketplace a další informace o této imagi.
ImageReference	Odkaz na image Azure Virtual Machines Marketplace nebo image Azure Compute Gallery. Pokud chcete získat seznam všech odkazů Azure Marketplace Image ověřených Azure Batch, projděte si operaci Výpis podporovaných imagí.
OSType	Typ operačního systému (např. Windows nebo Linux) image.
VerificationType	Jestli služba Azure Batch aktivně ověřuje, jestli je image kompatibilní se skladovou položkou přidruženého agenta výpočetního uzlu.

AccountListSupportedImagesResult

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

Name	Typ	Description
odata.nextLink	string	Adresa URL pro získání další sady výsledků
value	ImageInformation[]	Seznam podporovaných imagí virtuálních počítačů

BatchError

Služba Azure Batch obdržela chybovou odpověď.

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

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

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

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy

ImageInformation

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

Name	Typ	Description
batchSupportEndOfLife	string	Čas, kdy služba Azure Batch přestane přijímat žádosti o vytvoření fondu pro image.
capabilities	string[]	Možnosti nebo funkce, které image podporuje. Ne všechny funkce image jsou uvedené. Možnosti v tomto seznamu jsou považovány za zajímavé a obecně souvisejí s integrací s dalšími funkcemi služby Azure Batch.
imageReference	ImageReference	Odkaz na image virtuálního počítače Azure z Marketplace.
nodeAgentSKUId	string	ID skladové položky agenta výpočetního uzlu, kterou image podporuje.
osType	OSType	Typ operačního systému (např. Windows nebo Linux) image.
verificationType	VerificationType	Jestli služba Azure Batch aktivně ověřuje, jestli je image kompatibilní se skladovou položkou přidruženého agenta výpočetního uzlu.

ImageReference

Odkaz na image Azure Virtual Machines Marketplace nebo image Azure Compute Gallery. Pokud chcete získat seznam všech odkazů Azure Marketplace Image ověřených Azure Batch, projděte si operaci Výpis podporovaných imagí.

Name	Typ	Description
exactVersion	string	Konkrétní verze image platformy nebo image z Marketplace, která se použila k vytvoření uzlu. Toto pole jen pro čtení se liší od pole version pouze v případě, že hodnota zadaná pro "version" při vytvoření fondu byla "latest".
offer	string	Typ nabídky image Azure Virtual Machines Marketplace. Například UbuntuServer nebo WindowsServer.
publisher	string	Vydavatel image Azure Virtual Machines Marketplace. Například Canonical nebo MicrosoftWindowsServer.
sku	string	Skladová položka image Azure Virtual Machines Marketplace. Například 18.04-LTS nebo 2019-Datacenter.
version	string	Verze image Azure Virtual Machines Marketplace. Je možné zadat hodnotu "latest" pro výběr nejnovější verze image. Pokud ho vynecháte, výchozí hodnota je "latest".
virtualMachineImageId	string	Identifikátor prostředku ARM image Azure Compute Gallery. Výpočetní uzly ve fondu se vytvoří pomocí tohoto ID image. Má formát /subscriptions/{id_předplatného}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{Id_verze} nebo /subscriptions/{id_předplatného}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pro vždy nastavenou nejnovější verzi image. Tato vlastnost se vzájemně vylučuje s jinými ImageReference vlastnosti. Image Azure Compute Gallery musí mít repliky ve stejné oblasti a musí být ve stejném předplatném jako účet Azure Batch. Pokud v identifikátoru imageId není uvedená verze image, použije se nejnovější verze. Informace o nastavení brány firewall pro komunikaci agenta Výpočetního uzlu služby Batch se službou Batch najdete v tématu https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

OSType

Typ operačního systému (např. Windows nebo Linux) image.

Name	Typ	Description
linux	string	Operační systém Linux.
windows	string	Operační systém Windows.

VerificationType

Jestli služba Azure Batch aktivně ověřuje, jestli je image kompatibilní se skladovou položkou přidruženého agenta výpočetního uzlu.

Name	Typ	Description
unverified	string	Přidružená skladová položka agenta výpočetního uzlu by měla mít binární kompatibilitu s imagí, ale konkrétní funkce nebyly ověřeny.
verified	string	Image zaručuje kompatibilitu s přidruženou skladovou položkou agenta výpočetního uzlu a bylo potvrzeno, že všechny funkce Služby Batch fungují podle očekávání.

Share via

Account - List Supported Images

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Authorization

Příklady

Account list node agent skus

Sample Request

Sample Response

Definice

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Další materiály