Account - List Supported Images

Referenz

Dienst:: Batch Service

API-Version:: 2024-07-01.20.0

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

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

Mit optionalen Parametern:

GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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/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 1000 Ergebnisse zurückgegeben.
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. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

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. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	AccountListSupportedImagesResult	Eine Antwort, die die Liste der unterstützten Images für virtuelle Computer enthält. Header client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst.

Name

Typ

Beschreibung

200 OK

AccountListSupportedImagesResult

Eine Antwort, die die Liste der unterstützten Images für virtuelle Computer enthält.

Header

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

Other Status Codes

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Account list node agent skus

Beispielanforderung

HTTP

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

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
AccountListSupportedImagesResult	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.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
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 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".
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 zugeordneten Computeknoten-Agent-SKU kompatibel ist.

AccountListSupportedImagesResult

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

Name	Typ	Beschreibung
odata.nextLink	string	Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value	ImageInformation[]	Die Liste der unterstützten Images für virtuelle Computer.

BatchError

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

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 wurde.

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

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 die Annahme von Erstellungspoolanforderungen für das Image beendet.
capabilities	string[]	Die Funktionen oder Features, die das Image unterstützt. Nicht jede Funktion des Bilds wird aufgeführt. Die Funktionen in dieser Liste werden von besonderem Interesse betrachtet 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 das Image unterstützt.
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 zugeordneten Computeknoten-Agent-SKU kompatibel ist.

ImageReference

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	Eindeutiger Bezeichner des Communitykatalogbilds 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 Plattformimages oder Marketplace-Images, das zum Erstellen des Knotens verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich nur dann von "Version", wenn der für "Version" angegebene Wert beim Erstellen des Pools "latest" lautet.
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.
sharedGalleryImageId	string	Eindeutiger Bezeichner des freigegebenen Katalogbilds 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 von "latest" kann angegeben werden, um die neueste Version eines Bilds auszuwählen. Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "latest".
virtualMachineImageId	string	Der ARM-Ressourcenbezeichner des Azure Compute Gallery Image. Computeknoten im Pool werden mithilfe dieser Image-ID erstellt. Dies ist das Formular /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} oder /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} für immer die neueste Bildversion. Diese Eigenschaft schließt sich gegenseitig mit anderen ImageReference-Eigenschaften aus. Das Azure Compute Gallery Image muss Replikate in derselben Region aufweisen und muss sich im selben Abonnement wie das Azure Batch-Konto befinden. Wenn die Bildversion in der imageId nicht angegeben ist, wird die neueste Version verwendet. Informationen zu den Firewalleinstellungen für den Batch-Computeknoten-Agent für die Kommunikation mit dem Batchdienst finden Sie unter https://docs.microsoft.com/azure/batch/nodes-and-pools#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 zugeordneten Computeknoten-Agent-SKU kompatibel ist.

Name	Typ	Beschreibung
unverified	string	Die zugeordnete Computeknoten-Agent-SKU sollte über binäre Kompatibilität mit dem Image verfügen, aber bestimmte Funktionen wurden nicht überprüft.
verified	string	Das Image ist garantiert kompatibel mit der zugehörigen Compute Node-Agent-SKU, und alle Batchfunktionen wurden bestätigt, dass sie wie erwartet funktionieren.

Freigeben über

Account - List Supported Images

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Authorization

Beispiele

Account list node agent skus

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Zusätzliche Ressourcen