Account - List Supported Images

Referenz

Service:: Batch Service

API Version:: 2023-11-01.18.0

Listet alle vm-Images auf, die vom Azure Batch-Dienst unterstützt werden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
api-version	query	True	string	Client-API-Version.
$filter	query		string	Eine OData $filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Es werden maximal 1.000 Ergebnisse zurückgegeben.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name	Typ	Beschreibung
client-request-id	string uuid	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-rfc1123	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. explizit festlegen, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	AccountListSupportedImagesResult	Eine Antwort, die die Liste der unterstützten Vm-Images enthält. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Name

Typ

Beschreibung

200 OK

AccountListSupportedImagesResult

Eine Antwort, die die Liste der unterstützten Vm-Images enthält.

Headers

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

Other Status Codes

BatchError

Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
AccountListSupportedImagesResult	Das Ergebnis der Auflistung der unterstützten Vm-Images.
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
ImageInformation	Ein Verweis auf das Azure Virtual Machines Marketplace-Image und zusätzliche Informationen zum Image.
ImageReference	Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder ein Azure Compute-Katalogimage. Informationen zum Abrufen der Liste aller von Azure Batch überprüften Azure Marketplace Imageverweise finden Sie im Vorgang "Unterstützte Images auflisten".
OSType	Der Typ des Betriebssystems (z. B. Windows oder Linux) des Images.
VerificationType	Gibt an, ob der Azure Batch-Dienst aktiv überprüft, ob das Image mit der zugehörigen Compute Node-Agent-SKU kompatibel ist.

AccountListSupportedImagesResult

Das Ergebnis der Auflistung der unterstützten Vm-Images.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL zum Abrufen der nächsten Gruppe von Ergebnissen.
value	ImageInformation[]	Die Liste der unterstützten Vm-Images.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

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

BatchErrorDetail

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.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.

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

ImageInformation

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

Name	Typ	Beschreibung
batchSupportEndOfLife	string	Der Zeitpunkt, zu dem der Azure Batch-Dienst keine Poolerstellungsanforderungen für das Image akzeptiert.
capabilities	string[]	Die Funktionen oder Features, die das Image unterstützt. Nicht jede Funktion des Images ist aufgeführt. Funktionen in dieser Liste gelten als besonders interessant und beziehen sich im Allgemeinen auf die Integration mit anderen Features im Azure Batch-Dienst.
imageReference	ImageReference	Der Verweis auf das Marketplace-Image des virtuellen Azure-Computers.
nodeAgentSKUId	string	Die ID der SKU des Computeknoten-Agents, die vom Image unterstützt wird.
osType	OSType	Der Typ des Betriebssystems (z. B. Windows oder Linux) des Images.
verificationType	VerificationType	Gibt an, ob der Azure Batch-Dienst aktiv überprüft, ob das Image mit der zugehörigen Compute Node-Agent-SKU kompatibel ist.

ImageReference

Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder ein Azure Compute-Katalogimage. Informationen zum Abrufen der Liste aller von Azure Batch überprüften Azure Marketplace Imageverweise finden Sie im Vorgang "Unterstützte Images auflisten".

Name	Typ	Beschreibung
exactVersion	string	Die spezifische Version des Plattformimages oder Marketplace-Images, das zum Erstellen des Knotens verwendet wird. Dieses schreibgeschützte 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 Herausgeber des Azure Virtual Machines Marketplace-Images. Beispiel: Canonical oder MicrosoftWindowsServer.
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. Der Wert "latest" kann angegeben werden, um die neueste Version eines Images auszuwählen. Wenn nicht angegeben, lautet der Standardwert "latest".
virtualMachineImageId	string	Der ARM-Ressourcenbezeichner des Azure Compute-Katalogimages. Computeknoten im Pool werden mithilfe dieser Image-ID erstellt. Dies hat das Format /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} für immer die neueste Imageversion. Diese Eigenschaft schließt sich gegenseitig mit anderen ImageReference-Eigenschaften aus. Das Azure Compute Gallery-Image muss Replikate in derselben Region aufweisen und sich im selben Abonnement wie das Azure Batch-Konto befinden. Wenn die Imageversion in der imageId nicht angegeben ist, wird die neueste Version verwendet. Informationen zu den Firewalleinstellungen für den Batch Compute Node-Agent für die Kommunikation mit dem Batch-Dienst finden Sie unter https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

OSType

Der Typ des Betriebssystems (z. B. Windows oder Linux) des Images.

Name	Typ	Beschreibung
linux	string	Das Linux-Betriebssystem.
windows	string	Das Windows-Betriebssystem.

VerificationType

Gibt an, ob der Azure Batch-Dienst aktiv überprüft, ob das Image mit der zugehörigen Compute Node-Agent-SKU kompatibel ist.

Name	Typ	Beschreibung
unverified	string	Die zugeordnete Compute Node-Agent-SKU sollte binärkompatibilität mit dem Image aufweisen, bestimmte Funktionen wurden jedoch nicht überprüft.
verified	string	Das Image ist garantiert mit der zugehörigen Compute Node-Agent-SKU kompatibel, und alle Batch-Features wurden bestätigt, dass sie wie erwartet funktionieren.

Account - List Supported Images

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Scopes

Authorization

Beispiele

Account list node agent skus

Sample Request

Sample Response

Definitionen

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Zusätzliche Ressourcen