Account - List Supported Images

Référence

Service:: Batch Service

API Version:: 2023-11-01.18.0

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

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
api-version	query	True	string	Version de l’API cliente.
$filter	query		string	Clause de $filter OData. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1 000 résultats seront retournés.
timeout	query		integer int32	Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

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

Réponses

Nom	Type	Description
200 OK	AccountListSupportedImagesResult	Réponse contenant la liste des images de machine virtuelle prises en charge. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Erreur du service Batch.

Nom

Type

Description

200 OK

AccountListSupportedImagesResult

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

Headers

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

Other Status Codes

BatchError

Erreur du service Batch.

Sécurité

azure_auth

flux de code d’authentification OAuth 2.0 Microsoft Entra

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

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

Définitions

Nom	Description
AccountListSupportedImagesResult	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.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
ImageInformation	Référence à l’image de la Place de marché Azure Machines Virtuelles et informations supplémentaires sur l’image.
ImageReference	Référence à une image de la Place de marché Azure Machines Virtuelles ou à une image Azure Compute Gallery. Pour obtenir la liste de toutes les références d’images Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ».
OSType	Type de système d’exploitation (par exemple, Windows ou Linux) de l’image.
VerificationType	Indique si le service Azure Batch vérifie activement que l’image est compatible avec la référence SKU de l’agent Compute Node associée.

AccountListSupportedImagesResult

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

Nom	Type	Description
odata.nextLink	string	URL permettant d’obtenir l’ensemble de résultats suivant.
value	ImageInformation[]	Liste des images de machine virtuelle prises en charge.

BatchError

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 programmation.
message	ErrorMessage	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

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

ErrorMessage

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

Nom	Type	Description
lang	string	Code de langue du message d’erreur
value	string	Texte du message.

ImageInformation

Référence à l’image de la Place de marché Azure Machines Virtuelles et informations supplémentaires sur l’image.

Nom	Type	Description
batchSupportEndOfLife	string	Heure à laquelle le service Azure Batch cesse d’accepter les demandes de création de pool pour l’image.
capabilities	string[]	Fonctionnalités ou fonctionnalités prises en charge par l’image. Toutes les fonctionnalités de l’image ne sont pas répertoriées. Les fonctionnalités de cette liste sont considérées comme présentant un intérêt particulier et sont généralement liées à l’intégration avec d’autres fonctionnalités du service Azure Batch.
imageReference	ImageReference	Référence à l’image de la Place de marché de la machine virtuelle Azure.
nodeAgentSKUId	string	ID de la référence SKU de l’agent Compute Node prise en charge par l’image.
osType	OSType	Type de système d’exploitation (par exemple, Windows ou Linux) de l’image.
verificationType	VerificationType	Indique si le service Azure Batch vérifie activement que l’image est compatible avec la référence SKU de l’agent Compute Node associée.

ImageReference

Référence à une image de la Place de marché Azure Machines Virtuelles ou à une image Azure Compute Gallery. Pour obtenir la liste de toutes les références d’images Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ».

Nom	Type	Description
exactVersion	string	Version spécifique de l’image de plateforme ou de l’image de la Place de marché 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 « latest ».
offer	string	Type d’offre de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, UbuntuServer ou WindowsServer.
publisher	string	Éditeur de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, Canonical ou MicrosoftWindowsServer.
sku	string	Référence SKU de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, 18.04-LTS ou 2019-Datacenter.
version	string	Version de l’image de la Place de marché Azure Machines Virtuelles. Vous pouvez spécifier la valeur « latest » pour sélectionner la dernière version d’une image. S’il est omis, la valeur par défaut est « latest ».
virtualMachineImageId	string	Identificateur de ressource ARM de l’image Azure Compute Gallery. Les nœuds de calcul dans le pool seront créés à l’aide de cet ID d’image. Il s’agit de 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 la dernière version d’image par défaut. Cette propriété s’exclut mutuellement avec d’autres propriétés ImageReference. L’image Azure Compute Gallery doit avoir des réplicas dans la même région et doit se trouver dans le même abonnement que le compte Azure Batch. Si la version de l’image n’est pas spécifiée dans imageId, la version la plus récente est utilisée. Pour plus d’informations sur les paramètres de pare-feu pour que l’agent Batch Compute Node communique avec le service Batch, consultez https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

OSType

Type de système d’exploitation (par exemple, Windows ou Linux) de l’image.

Nom	Type	Description
linux	string	Système d’exploitation Linux.
windows	string	Système d’exploitation Windows.

VerificationType

Indique si le service Azure Batch vérifie activement que l’image est compatible avec la référence SKU de l’agent Compute Node associée.

Nom	Type	Description
unverified	string	La référence SKU de l’agent Compute Node associée doit avoir une compatibilité binaire avec l’image, mais aucune fonctionnalité spécifique n’a été vérifiée.
verified	string	La compatibilité de l’image avec la référence SKU de l’agent Compute Node associée est garantie, et toutes les fonctionnalités Batch ont été confirmées pour fonctionner comme prévu.

Account - List Supported Images

Paramètres URI

En-tête de la demande

Réponses

Sécurité

azure_auth

Scopes

Authorization

Exemples

Account list node agent skus

Sample Request

Sample Response

Définitions

AccountListSupportedImagesResult

BatchError

BatchErrorDetail

ErrorMessage

ImageInformation

ImageReference

OSType

VerificationType

Ressources supplémentaires