Pools - List Supported Images

Usługa:: Batch Service

Wersja interfejsu API:: 2025-06-01

Wyświetla listę wszystkich obrazów maszyn wirtualnych obsługiwanych przez usługę Azure Batch.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Punkt końcowy konta usługi Batch (na przykład: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	Klauzula OData $filter. Więcej informacji o konstrukcji tego filtra można znaleźć w .https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Maksymalna liczba elementów do zwrócenia w odpowiedzi. Maksymalnie można zwrócić 1000 wniosków.
timeOut	query		integer (int32)	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta domyślna wersja domyślna.".

Nagłówek żądania

Nazwa	Typ	Opis
client-request-id	string	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi.
ocp-date	string (date-time-rfc7231)	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BatchAccountListSupportedImagesResult	Żądanie zakończyło się pomyślnie. Nagłówki ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Nieoczekiwana odpowiedź na błąd.

Nazwa

Typ

Opis

200 OK

BatchAccountListSupportedImagesResult

Żądanie zakończyło się pomyślnie.

Nagłówki

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

Other Status Codes

BatchError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://batch.core.windows.net//.default

Przykłady

Account list node agent skus

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
BatchAccountListSupportedImagesResult	Wynik wyświetlania listy obsługiwanych obrazów maszyn wirtualnych.
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
BatchErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
BatchSupportedImage	Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines i dodatkowe informacje o obrazie.
BatchVmImageReference	Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazów witryny Azure Marketplace zweryfikowanych przez usługę Azure Batch, zobacz operację "Lista obsługiwanych obrazów".
ImageVerificationType	Enumy ImageVerificationType
OSType	Enumy OSType

BatchAccountListSupportedImagesResult

Objekt

Wynik wyświetlania listy obsługiwanych obrazów maszyn wirtualnych.

Nazwa	Typ	Opis
odata.nextLink	string (uri)	Adres URL, aby uzyskać następny zestaw wyników.
value	BatchSupportedImage[]	Lista obsługiwanych obrazów maszyn wirtualnych.

BatchError

Objekt

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	BatchErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Objekt

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

BatchErrorMessage

Objekt

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
lang	string	Kod językowy komunikatu o błędzie.
value	string	Tekst wiadomości.

BatchSupportedImage

Objekt

Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines i dodatkowe informacje o obrazie.

Nazwa	Typ	Opis
batchSupportEndOfLife	string (date-time)	Czas, w którym usługa Azure Batch przestanie przyjmować żądania tworzenia puli dla obrazu.
capabilities	string[]	Możliwości lub funkcje, które obsługuje Image. Nie wszystkie funkcje Image są wymienione. Możliwości z tej listy są uważane za szczególnie interesujące i zazwyczaj związane z integracją z innymi funkcjami usługi Azure Batch.
imageReference	BatchVmImageReference	Odniesienie do obrazu Marketplace z Azure Virtual Machine.
nodeAgentSKUId	string	ID modelu SKU agenta Compute Node, który obraz obsługuje.
osType	OSType	Typ systemu operacyjnego (np. Windows lub Linux) obrazu.
verificationType	ImageVerificationType	Czy usługa Azure Batch aktywnie weryfikuje, że obraz jest kompatybilny z powiązanym SKU agenta Compute Node.

BatchVmImageReference

Objekt

Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazów witryny Azure Marketplace zweryfikowanych przez usługę Azure Batch, zobacz operację "Lista obsługiwanych obrazów".

Nazwa	Typ	Opis
communityGalleryImageId	string	Unikalny identyfikator obrazu galerii społecznościowej. Ta właściwość wzajemnie wyklucza się z innymi właściwościami i może być pobierana z wywołania GET obrazu galerii społeczności.
exactVersion	string	Konkretna wersja obrazu platformy lub marketplace użytego do stworzenia węzła. To pole tylko do odczytu różni się od 'version' tylko wtedy, gdy wartość podany dla 'version' podczas tworzenia puli była 'laprint'.
offer	string	Typ oferty to Azure Virtual Machines Marketplace Image. Na przykład UbuntuServer lub WindowsServer.
publisher	string	Wydawca obrazu Azure Virtual Machines Marketplace. Na przykład Canonical lub MicrosoftWindowsServer.
sharedGalleryImageId	string	Unikalny identyfikator wspólnego zdjęcia galerii. Ta właściwość wzajemnie wyklucza się z innymi właściwościami i może zostać pobrana z wywołania GET obrazu galerii udostępnionej.
sku	string	SKU obrazu Azure Virtual Machines Marketplace. Na przykład 18.04-LTS lub 2019-Datacenter.
version	string	Wersja Azure Virtual Machines Marketplace Image. Można określić wartość 'najnowszy', aby wybrać najnowszą wersję obrazu. W przypadku pominięcia wartość domyślna to "latest".
virtualMachineImageId	string (arm-id)	Identyfikator zasobu usługi ARM obrazu galerii obliczeniowej platformy Azure. Węzły obliczeniowe w puli będą tworzone za pomocą tego ID obrazu. Ma ona formę /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} lub /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}, gdzie zawsze domyślnie wraca do najnowszej wersji obrazu. Ta własność jest wzajemnie wyłączna z innymi właściwościami ImageReference. Obraz Azure Compute Gallery Gallery musi mieć repliki w tym samym regionie i musi być w tej samej subskrypcji co konto Azure Batch. Jeśli wersja obrazu nie jest określona w imageId, zostanie użyta najnowsza wersja. Aby uzyskać informacje o ustawieniach zapory dla agenta Batch Compute Node, aby komunikował się z usługą https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configurationBatch .

ImageVerificationType

Wyliczenie

Enumy ImageVerificationType

Wartość	Opis
verified	Obraz jest gwarantowany jako kompatybilny z powiązanym SKU agenta Compute Node, a wszystkie funkcje Batch zostały potwierdzone jako działające zgodnie z oczekiwaniami.
unverified	Powiązany element agenta Compute Node powinien mieć binarną kompatybilność z obrazem, ale konkretna funkcjonalność nie została zweryfikowana.

OSType

Wyliczenie

Enumy OSType

Wartość	Opis
linux	System operacyjny Linux.
windows	System operacyjny Windows.

Udostępnij przez

Pools - List Supported Images

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

OAuth2Auth

Zakresy

Przykłady

Account list node agent skus

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BatchAccountListSupportedImagesResult

BatchError

BatchErrorDetail

BatchErrorMessage

BatchSupportedImage

BatchVmImageReference

ImageVerificationType

OSType