Delen via

Pools - List Supported Images

Service:
Batch Service
API-versie:
2025-06-01

Een lijst met alle installatiekopieën van virtuele machines die worden ondersteund door de Azure Batch-service.

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

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string (uri)

Batch-accounteindpunt (bijvoorbeeld: https://batchaccount.eastus2.batch.azure.com).
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.
$filter
 query

string

Een OData-$filter-component. Voor meer informatie over het construeren van dit filter, zie https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults
 query

integer (int32)

minimum: 1
maximum: 1000

Het maximum aantal items dat moet worden geretourneerd in het antwoord. Maximaal 1000 aanvragen kunnen worden teruggestuurd.
timeOut
 query

integer (int32)

De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt de standaard in plaats daarvan gebruikt."

Aanvraagkoptekst

Name Vereist Type Description
client-request-id

string

De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date

string (date-time-rfc7231)

Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name Type Description
200 OK

BatchAccountListSupportedImagesResult

De aanvraag is voltooid.

Kopteksten

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

Account list node agent skus

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
BatchAccountListSupportedImagesResult

Het resultaat van het weergeven van de ondersteunde installatiekopieën van virtuele machines.
BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
BatchErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
BatchSupportedImage

Een verwijzing naar de Marketplace-installatiekopieën van Azure Virtual Machines en aanvullende informatie over de installatiekopieën.
BatchVmImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking 'Lijst met ondersteunde installatiekopieën' voor alle Azure Marketplace-installatiekopieën die zijn geverifieerd door Azure Batch.
ImageVerificationType

ImageVerificationType enums
OSType

OSType enums

BatchAccountListSupportedImagesResult

Object

Het resultaat van het weergeven van de ondersteunde installatiekopieën van virtuele machines.

Name Type Description
odata.nextLink

string (uri)

De URL om de volgende reeks resultaten te krijgen.
value

BatchSupportedImage[]

De lijst van ondersteunde Virtual Machine Images.

BatchError

Object

Er is een foutbericht ontvangen van de Azure Batch-service.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message

BatchErrorMessage

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values

BatchErrorDetail[]

Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Object

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name Type Description
key

string

Een id die de betekenis van de eigenschap Waarde aangeeft.
value

string

De aanvullende informatie die is opgenomen in het foutbericht.

BatchErrorMessage

Object

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name Type Description
lang

string

De taalcode van het foutbericht.
value

string

De tekst van het bericht.

BatchSupportedImage

Object

Een verwijzing naar de Marketplace-installatiekopieën van Azure Virtual Machines en aanvullende informatie over de installatiekopieën.

Name Type Description
batchSupportEndOfLife

string (date-time)

Het moment waarop de Azure Batch-service stopt met het accepteren van aanmaak Pool-verzoeken voor de image.
capabilities

string[]

De mogelijkheden of functies die de Image ondersteunt. Niet elke functionaliteit van de afbeelding wordt vermeld. Mogelijkheden in deze lijst worden als bijzonder interessant beschouwd en zijn over het algemeen gerelateerd aan integratie met andere functies in de Azure Batch-service.
imageReference

BatchVmImageReference

De verwijzing naar het Marketplace Image van de Azure Virtual Machine.
nodeAgentSKUId

string

De ID van de Compute Node-agent SKU die door de Image wordt ondersteund.
osType

OSType

Het type besturingssysteem (bijv. Windows of Linux) van de afbeelding.
verificationType

ImageVerificationType

Of de Azure Batch-service actief verifieert dat de Image compatibel is met de bijbehorende Compute Node agent SKU.

BatchVmImageReference

Object

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking 'Lijst met ondersteunde installatiekopieën' voor alle Azure Marketplace-installatiekopieën die zijn geverifieerd door Azure Batch.

Name Type Description
communityGalleryImageId

string

De unieke identificatie van de afbeelding in de communitygalerij. Deze eigenschap is wederzijds exclusief met andere eigenschappen en kan worden opgehaald uit de get-aanroep van de communitygalerieafbeelding.
exactVersion

string

De specifieke versie van het platformimage of marktplaats image die is gebruikt om de node te maken. Dit alleen-lezen veld verschilt van 'versie' alleen als de waarde die voor 'versie' werd gespecificeerd toen de pool werd aangemaakt 'laatste' was.
offer

string

Het aanbiedingstype van de Azure Virtual Machines Marketplace Image. Bijvoorbeeld UbuntuServer of WindowsServer.
publisher

string

De uitgever van de Azure Virtual Machines Marketplace Image. Bijvoorbeeld Canonical of MicrosoftWindowsServer.
sharedGalleryImageId

string

De unieke identificatie van de gedeelde galerijafbeelding. Deze eigenschap is wederzijds exclusief met andere eigenschappen en kan worden opgehaald uit de get-aanroep van de installatiekopieën in de gedeelde galerie.
sku

string

De SKU van de Azure Virtual Machines Marketplace Image. Bijvoorbeeld 18.04-LTS of 2019-Datacenter.
version

string

De versie van de Azure Virtual Machines Marketplace Image. Een waarde van 'laatste' kan worden opgegeven om de nieuwste versie van een Image te selecteren. Als u dit weglaat, is de standaardwaarde 'nieuwste'.
virtualMachineImageId

string (arm-id)

De ARM-resource-id van de installatiekopieën van de Azure Compute Gallery. Compute Nodes in de pool worden aangemaakt met deze Image Id. Dit is de vorm /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} om altijd standaard te kiezen voor de nieuwste afbeeldingsversie. Deze eigenschap sluit elkaar uit met andere ImageReference-eigenschappen. De Azure Compute Gallery Image moet replica's in dezelfde regio hebben en moet in hetzelfde abonnement zitten als het Azure Batch-account. Als de afbeeldingsversie niet is gespecificeerd in de imageId, wordt de nieuwste versie gebruikt. Voor informatie over de firewallinstellingen voor de Batch Compute Node-agent om met de Batch-service te communiceren, zie https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ImageVerificationType

Opsomming

ImageVerificationType enums

Waarde Description
verified

De Image is gegarandeerd compatibel met de bijbehorende Compute Node-agent SKU en alle Batch-functies zijn bevestigd als werkend zoals verwacht.
unverified

De bijbehorende Compute Node-agent SKU zou binaire compatibiliteit met de Image moeten hebben, maar specifieke functionaliteit is niet geverifieerd.

OSType

Opsomming

OSType enums

Waarde Description
linux

Het Linux-besturingssysteem.
windows

Het Windows-besturingssysteem.