Account - List Supported Images

Service:

Batch Service

API-versie:

2024-07-01.20.0

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

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

Met optionele parameters:

GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch-serviceaanvragen.
api-version	query	True	string	Client-API-versie.
$filter	query		string	Een OData-$filter-component. Zie https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-imagesvoor meer informatie over het maken van dit filter.
maxresults	query		integer int32	Het maximum aantal items dat moet worden geretourneerd in het antwoord. Er worden maximaal 1000 resultaten geretourneerd.
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 in plaats daarvan de standaardwaarde gebruikt.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	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-rfc1123	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	AccountListSupportedImagesResult	Een antwoord met de lijst met ondersteunde installatiekopieën van virtuele machines. Kopteksten client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Account list node agent skus

Voorbeeldaanvraag

HTTP

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

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
AccountListSupportedImagesResult	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.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
ImageInformation	Een verwijzing naar de Marketplace-installatiekopieën van Azure Virtual Machines en aanvullende informatie over de installatiekopieën.
ImageReference	Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven om de lijst met alle Azure Marketplace-installatiekopieën op te halen die zijn geverifieerd door Azure Batch.
OSType	Het type besturingssysteem (bijvoorbeeld Windows of Linux) van de installatiekopie.
VerificationType	Of de Azure Batch-service actief controleert of de installatiekopieën compatibel zijn met de bijbehorende SKU van de rekenknooppuntagent.

AccountListSupportedImagesResult

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

Name	Type	Description
odata.nextLink	string	De URL voor het ophalen van de volgende set resultaten.
value	ImageInformation[]	De lijst met ondersteunde installatiekopieën van virtuele machines.

BatchError

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

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.

ErrorMessage

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.

ImageInformation

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

Name	Type	Description
batchSupportEndOfLife	string	Het moment waarop de Azure Batch-service stopt met het accepteren van aanvraaggroepen voor de installatiekopieën.
capabilities	string[]	De mogelijkheden of functies die door de installatiekopieën worden ondersteund. Niet elke mogelijkheid van de afbeelding wordt vermeld. Mogelijkheden in deze lijst worden van bijzonder belang geacht en zijn over het algemeen gerelateerd aan integratie met andere functies in de Azure Batch-service.
imageReference	ImageReference	De verwijzing naar de Marketplace-installatiekopieën van de virtuele Azure-machine.
nodeAgentSKUId	string	De id van de rekenknooppuntagent-SKU die door de installatiekopieën wordt ondersteund.
osType	OSType	Het type besturingssysteem (bijvoorbeeld Windows of Linux) van de installatiekopie.
verificationType	VerificationType	Of de Azure Batch-service actief controleert of de installatiekopieën compatibel zijn met de bijbehorende SKU van de rekenknooppuntagent.

ImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven om de lijst met alle Azure Marketplace-installatiekopieën op te halen die zijn geverifieerd door Azure Batch.

Name	Type	Description
communityGalleryImageId	string	De unieke id van de communitygalerieafbeelding 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 de platforminstallatiekopieën of marketplace-installatiekopieën die worden gebruikt om het knooppunt te maken. Dit alleen-lezenveld verschilt van 'versie' alleen als de waarde die is opgegeven voor 'versie' toen de pool werd gemaakt 'latest' was.
offer	string	Het aanbiedingstype van de Marketplace-installatiekopie van Azure Virtual Machines. Bijvoorbeeld UbuntuServer of WindowsServer.
publisher	string	De uitgever van de Azure Virtual Machines Marketplace-installatiekopieën. Bijvoorbeeld Canonical of MicrosoftWindowsServer.
sharedGalleryImageId	string	De unieke id van de installatiekopieën van de gedeelde galerie 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 Marketplace-installatiekopieën van Azure Virtual Machines. Bijvoorbeeld 18.04-LTS of 2019-Datacenter.
version	string	De versie van de Azure Virtual Machines Marketplace-installatiekopieën. Een waarde van 'latest' kan worden opgegeven om de nieuwste versie van een installatiekopieën te selecteren. Als u dit weglaat, is de standaardwaarde 'nieuwste'.
virtualMachineImageId	string	De ARM-resource-id van de installatiekopieën van de Azure Compute Gallery. Rekenknooppunten in de pool worden gemaakt met behulp van deze installatiekopieën-id. Dit is van het formulier /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} voor altijd de meest recente versie van de installatiekopie. Deze eigenschap is wederzijds exclusief met andere ImageReference-eigenschappen. De installatiekopieën van de Azure Compute Gallery moeten replica's hebben in dezelfde regio en moeten zich in hetzelfde abonnement bevinden als het Azure Batch-account. Als de versie van de installatiekopieën niet is opgegeven in de imageId, wordt de nieuwste versie gebruikt. Zie https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configurationvoor informatie over de firewallinstellingen voor de Batch Compute Node-agent om te communiceren met de Batch-service.

OSType

Het type besturingssysteem (bijvoorbeeld Windows of Linux) van de installatiekopie.

Name	Type	Description
linux	string	Het Linux-besturingssysteem.
windows	string	Het Windows-besturingssysteem.

VerificationType

Of de Azure Batch-service actief controleert of de installatiekopieën compatibel zijn met de bijbehorende SKU van de rekenknooppuntagent.

Name	Type	Description
unverified	string	De gekoppelde rekenknooppuntagent-SKU moet binaire compatibiliteit met de installatiekopieën hebben, maar er is geen specifieke functionaliteit geverifieerd.
verified	string	De installatiekopieën zijn gegarandeerd compatibel met de bijbehorende SKU van de Compute Node-agent en alle Batch-functies zijn bevestigd om te werken zoals verwacht.