Pools - List Supported Images

Dienst:: Batch Service

API-Version:: 2025-06-01

Listet alle virtuellen Computerimages auf, die vom Azure-Batchdienst unterstützt werden.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$filter	query		string	Eine OData-$filter-Klausel. Weitere Informationen zur Konstruktion dieses Filters finden Sie unter https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Anträge können zurückgeschickt werden.
timeOut	query		integer (int32)	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

Anforderungsheader

Name	Typ	Beschreibung
client-request-id	string	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date	string (date-time-rfc7231)	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	BatchAccountListSupportedImagesResult	Die Anforderung ist erfolgreich. Header ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

BatchAccountListSupportedImagesResult

Die Anforderung ist erfolgreich.

Header

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

Other Status Codes

BatchError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

Account list node agent skus

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
BatchAccountListSupportedImagesResult	Das Ergebnis der Auflistung der unterstützten Images für virtuelle Computer.
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
BatchErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
BatchSupportedImage	Ein Verweis auf das Azure Virtual Machines Marketplace Image und zusätzliche Informationen zum Image.
BatchVmImageReference	Ein Verweis auf ein Azure Virtual Machines Marketplace Image oder ein Azure Compute Gallery Image. Informationen zum Abrufen der Liste aller azure Marketplace-Imageverweise, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Unterstützte Bilder auflisten".
ImageVerificationType	ImageVerificationType Enums
OSType	OSType enums

BatchAccountListSupportedImagesResult

Objekt

Das Ergebnis der Auflistung der unterstützten Images für virtuelle Computer.

Name	Typ	Beschreibung
odata.nextLink	string (uri)	Die URL zum Abrufen der nächsten Ergebnisse.
value	BatchSupportedImage[]	Die Liste der unterstützten Virtual Machine Images.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	BatchErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Objekt

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

BatchErrorMessage

Objekt

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung.
value	string	Der Text der Nachricht.

BatchSupportedImage

Objekt

Ein Verweis auf das Azure Virtual Machines Marketplace Image und zusätzliche Informationen zum Image.

Name	Typ	Beschreibung
batchSupportEndOfLife	string (date-time)	Die Zeit, in der der Azure Batch-Service aufhört, Pool-Anfragen für das Image zu erstellen.
capabilities	string[]	Die Fähigkeiten oder Funktionen, die das Image unterstützt. Nicht jede Fähigkeit des Bildes ist aufgeführt. Funktionen in dieser Liste gelten als besonders interessant und stehen im Allgemeinen im Zusammenhang mit der Integration mit anderen Funktionen im Azure Batch-Service.
imageReference	BatchVmImageReference	Der Verweis auf das Marktplatz-Image der Azure Virtual Machine.
nodeAgentSKUId	string	Die ID der Compute Node-Agent-SKU, die das Image unterstützt.
osType	OSType	Die Art des Betriebssystems (z. B. Windows oder Linux) des Images.
verificationType	ImageVerificationType	Ob der Azure Batch-Dienst aktiv überprüft, ob das Image mit der zugehörigen Compute Node-Agent-SKU kompatibel ist.

BatchVmImageReference

Objekt

Ein Verweis auf ein Azure Virtual Machines Marketplace Image oder ein Azure Compute Gallery Image. Informationen zum Abrufen der Liste aller azure Marketplace-Imageverweise, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Unterstützte Bilder auflisten".

Name	Typ	Beschreibung
communityGalleryImageId	string	Die eindeutige Kennung des Bildes in der Community-Galerie. Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus und kann aus dem Get-Aufruf der Communitygalerie abgerufen werden.
exactVersion	string	Die spezifische Version des Plattform- oder Marktplatzimages, die zur Erstellung des Knotens verwendet wurde. Dieses Nur-Lese-Feld unterscheidet sich von 'version' nur, wenn der für 'version' angegebene Wert bei der Erstellung des Pools 'neueste' war.
offer	string	Der Angebotstyp des Azure Virtual Machines Marketplace Images. Beispiel: UbuntuServer oder WindowsServer.
publisher	string	Der Herausgeberin des Azure Virtual Machines Marketplace Image. Beispiel: Canonical oder MicrosoftWindowsServer.
sharedGalleryImageId	string	Die einzigartige Identifikatorin des gemeinsamen Galeriebilds. Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus und kann aus dem GET-Aufruf des freigegebenen Katalogbilds abgerufen werden.
sku	string	Die SKU des Azure Virtual Machines Marketplace Images. Beispiel: 18.04-LTS oder 2019-Datacenter.
version	string	Die Version des Azure Virtual Machines Marketplace Images. Ein Wert 'neueste' kann angegeben werden, um die neueste Version eines Images auszuwählen. Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "latest".
virtualMachineImageId	string (arm-id)	Der ARM-Ressourcenbezeichner des Azure Compute Gallery Image. Compute-Knoten im Pool werden mit dieser Bild-ID erstellt. Dies ist in der Form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} oder /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}, um immer auf die neueste Image-Version zu setzen. Diese Eigenschaft schließt sich gegenseitig mit anderen ImageReference-Eigenschaften aus. Das Azure Compute Gallery Image muss Replikate in derselben Region haben und im selben Abonnement wie das Azure Batch-Konto sein. Wenn die Image-Version nicht in der imageID angegeben ist, wird die neueste Version verwendet. Informationen zu den Firewall-Einstellungen für den Batch Compute Node-Agenten zur Kommunikation mit dem Batch-Service finden https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configurationSie unter .

ImageVerificationType

Enumeration

ImageVerificationType Enums

Wert	Beschreibung
verified	Das Image ist garantiert kompatibel mit der zugehörigen Compute Node-Agent-SKU und alle Batch-Funktionen haben bestätigt, dass sie wie erwartet funktionieren.
unverified	Die zugehörige Compute Node-Agent-SKU sollte binärkompatibile mit dem Image haben, aber spezifische Funktionalitäten wurden nicht verifiziert.

OSType

Enumeration

OSType enums

Wert	Beschreibung
linux	Das Linux-Betriebssystem.
windows	Das Windows-Betriebssystem.

Freigeben über

Pools - List Supported Images

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

Account list node agent skus

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchAccountListSupportedImagesResult

BatchError

BatchErrorDetail

BatchErrorMessage

BatchSupportedImage

BatchVmImageReference

ImageVerificationType

OSType