Account - List Supported Images

Služba:

Batch Service

Verze rozhraní API:

2024-07-01.20.0

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

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

S volitelnými parametry:

GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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 služby Azure Batch.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru naleznete v tématu https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	Maximální počet položek, které se mají vrátit v odpovědi. Vrátí se maximálně 1 000 výsledků.
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

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	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-rfc1123	Č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	AccountListSupportedImagesResult	Odpověď obsahující seznam podporovaných imagí virtuálních počítačů Hlavičky 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

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

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

Rozsahy

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

Authorization

Typ: apiKey
V: header

Příklady

Account list node agent skus

Ukázkový požadavek

HTTP

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

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
AccountListSupportedImagesResult	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
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
ImageInformation	Odkaz na image Azure Virtual Machines Marketplace a další informace o imagi.
ImageReference	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 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í s přidruženou skladovou jednotkou 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

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

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.

ErrorMessage

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

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 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 zvláštní zájem a obecně souvisí s integrací s dalšími funkcemi ve službě Azure Batch.
imageReference	ImageReference	Odkaz na image Marketplace virtuálního počítače Azure.
nodeAgentSKUId	string	ID skladové položky agenta výpočetního uzlu, které 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í s přidruženou skladovou jednotkou agenta výpočetního uzlu.

ImageReference

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 Výpis podporovaných imagí.

Name	Typ	Description
communityGalleryImageId	string	Jedinečný identifikátor obrázku galerie komunity 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 image platformy nebo image marketplace použité k vytvoření uzlu. Toto pole jen pro čtení se liší od verze pouze v případě, že hodnota zadaná pro verzi 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.
sharedGalleryImageId	string	Jedinečný identifikátor obrázku sdílené 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	Skladová položka image Azure Virtual Machines Marketplace. Například 18.04-LTS nebo 2019-Datacenter.
version	string	Verze image Azure Virtual Machines Marketplace. Hodnotu "latest" je možné zadat, pokud chcete vybrat nejnovější verzi image. Pokud tento parametr vynecháte, výchozí hodnota je nejnovější.
virtualMachineImageId	string	Identifikátor prostředku ARM image galerie výpočetních prostředků Azure. Výpočetní uzly ve fondu se vytvoří pomocí tohoto ID image. Toto je formulář /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} nebo /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} pro vždy výchozí nastavení nejnovější verze image. Tato vlastnost se vzájemně vylučují s jinými vlastnostmi ImageReference. Image galerie výpočetních prostředků Azure musí mít repliky ve stejné oblasti a musí být ve stejném předplatném jako účet Azure Batch. Pokud verze image není zadaná v id image, použije se nejnovější verze. Informace o nastavení brány firewall pro agenta výpočetního uzlu služby Batch ke komunikaci se službou Batch najdete v tématu https://docs.microsoft.com/azure/batch/nodes-and-pools#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í s přidruženou skladovou jednotkou agenta výpočetního uzlu.

Name	Typ	Description
unverified	string	Skladová položka agenta výpočetního uzlu by měla mít binární kompatibilitu s imagí, ale nebyla ověřena konkrétní funkce.
verified	string	Je zaručeno, že je kompatibilní s přidruženou skladovou jednotkou agenta výpočetního uzlu a všechny funkce Batch byly potvrzeny tak, aby fungovaly podle očekávání.