Pools - List Supported Images

Service:: Batch Service

Version d'API:: 2025-06-01

Répertorie toutes les images de machine virtuelle prises en charge par le service Azure Batch.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Point de terminaison de compte Batch (par exemple : https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$filter	query		string	Clause OData $filter. Pour plus d’informations sur la construction de ce filtre, voir https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1000 candidatures peuvent être retournées.
timeOut	query		integer (int32)	Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, le par défaut sera utilisé à la place. »

En-tête de la demande

Nom	Type	Description
client-request-id	string	L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Indique si le serveur doit retourner l’ID client-request-id dans la réponse.
ocp-date	string (date-time-rfc7231)	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.

Réponses

Nom	Type	Description
200 OK	BatchAccountListSupportedImagesResult	La demande a réussi. En-têtes ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

BatchAccountListSupportedImagesResult

La demande a réussi.

En-têtes

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

Other Status Codes

BatchError

Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

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

Exemples

Account list node agent skus

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
BatchAccountListSupportedImagesResult	Résultat de la liste des images de machine virtuelle prises en charge.
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
BatchErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
BatchSupportedImage	Référence à l’image de la Place de marché des machines virtuelles Azure et informations supplémentaires sur l’image.
BatchVmImageReference	Référence à une image de la Place de marché de machines virtuelles Azure ou à une image de galerie de calcul Azure. Pour obtenir la liste de toutes les références d’images de la Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Liste des images prises en charge ».
ImageVerificationType	Enums ImageVerificationType
OSType	OSType enums

BatchAccountListSupportedImagesResult

Objet

Résultat de la liste des images de machine virtuelle prises en charge.

Nom	Type	Description
odata.nextLink	string (uri)	L’URL permettant d’obtenir la prochaine série de résultats.
value	BatchSupportedImage[]	La liste des images de machines virtuelles prises en charge.

BatchError

Objet

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
message	BatchErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Objet

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

BatchErrorMessage

Objet

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Le code de langue du message d’erreur.
value	string	Le texte du message.

BatchSupportedImage

Objet

Référence à l’image de la Place de marché des machines virtuelles Azure et informations supplémentaires sur l’image.

Nom	Type	Description
batchSupportEndOfLife	string (date-time)	Le moment où le service Azure Batch cesse d’accepter les requêtes de création de pool pour l’image.
capabilities	string[]	Les capacités ou fonctionnalités que l’image prend en charge. Toutes les capacités de l’image ne sont pas listées. Les fonctionnalités de cette liste sont considérées comme d’un intérêt particulier et sont généralement liées à l’intégration avec d’autres fonctionnalités du service Batch Azure.
imageReference	BatchVmImageReference	La référence à l’image Marketplace de la machine virtuelle Azure.
nodeAgentSKUId	string	L’identifiant du SKU agent Compute Node que l’image supporte.
osType	OSType	Le type de système d’exploitation (par exemple Windows ou Linux) de l’image.
verificationType	ImageVerificationType	Si le service Batch Azure vérifie activement que l’image est compatible avec le SKU d’agent Compute Node associé.

BatchVmImageReference

Objet

Référence à une image de la Place de marché de machines virtuelles Azure ou à une image de galerie de calcul Azure. Pour obtenir la liste de toutes les références d’images de la Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Liste des images prises en charge ».

Nom	Type	Description
communityGalleryImageId	string	L’image de la galerie communautaire identifie uniquement. Cette propriété s’exclue mutuellement avec d’autres propriétés et peut être extraite de l’appel GET de la galerie de la galerie de communautés.
exactVersion	string	La version spécifique de l’image de plateforme ou de l’image marketplace utilisée pour créer le nœud. Ce champ en lecture seule diffère de « version » uniquement si la valeur spécifiée pour « version » lors de la création du pool était « plus récente ».
offer	string	Le type d’offre de l’image Azure Virtual Machines Marketplace. Par exemple, UbuntuServer ou WindowsServer.
publisher	string	L’éditeur de l’image Azure Virtual Machines Marketplace. Par exemple, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId	string	L’identifiant unique de l’image de galerie partagée. Cette propriété s’exclue mutuellement avec d’autres propriétés et peut être extraite de l’appel GET de l’image de galerie partagée.
sku	string	Le SKU de l’image Azure Virtual Machines Marketplace. Par exemple, 18.04-LTS ou 2019-Datacenter.
version	string	La version de l’image Azure Virtual Machines Marketplace. Une valeur de « plus tard » peut être spécifiée pour sélectionner la dernière version d’une image. S’il est omis, la valeur par défaut est « latest ».
virtualMachineImageId	string (arm-id)	Identificateur de ressource ARM de l’image de la galerie de calcul Azure. Les nœuds de calcul du pool seront créés à l’aide de cet identifiant d’image. Ceci prend la forme /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pour toujours utiliser par défaut la dernière version de l’image. Cette propriété est mutuellement exclusive avec les autres propriétés ImageReference. L’image de la galerie Azure Compute doit avoir des répliques dans la même région et être dans le même abonnement que le compte Azure Batch. Si la version de l’image n’est pas spécifiée dans l’imageId, la version la plus récente sera utilisée. Pour des informations sur les paramètres de pare-feu de l’agent du nœud de calcul batch afin de communiquer avec le service Batch, voir https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ImageVerificationType

Énumération

Enums ImageVerificationType

Valeur	Description
verified	L’image est garantie compatible avec le SKU associé Compute Node agent et toutes les fonctionnalités Batch ont été confirmées comme étant attendus.
unverified	Le SKU d’agent Compute Node associé devrait être compatible en binaire avec l’image, mais la fonctionnalité spécifique n’a pas été vérifiée.

OSType

Énumération

OSType enums

Valeur	Description
linux	Le système d’exploitation Linux.
windows	Le système d’exploitation Windows.

Partager via

Pools - List Supported Images

Paramètres URI

En-tête de la demande

Réponses

Sécurité

OAuth2Auth

Étendues

Exemples

Account list node agent skus

Exemple de requête

Exemple de réponse

Définitions

BatchAccountListSupportedImagesResult

BatchError

BatchErrorDetail

BatchErrorMessage

BatchSupportedImage

BatchVmImageReference

ImageVerificationType

OSType