Account - List Supported Images

Servizio:

Batch Service

Versione API:

2024-07-01.20.0

Elenca tutte le immagini di macchine virtuali supportate dal servizio Azure Batch.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del servizio Azure Batch.
api-version	query	True	string	Versione dell'API client.
$filter	query		string	Clausola di $filter OData. Per altre informazioni sulla creazione di questo filtro, vedere https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer int32	Numero massimo di elementi da restituire nella risposta. Verrà restituito un massimo di 1000 risultati.
timeout	query		integer int32	Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string uuid	Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date		string date-time-rfc1123	Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome	Tipo	Descrizione
200 OK	AccountListSupportedImagesResult	Risposta contenente l'elenco di immagini di macchine virtuali supportate. Intestazioni client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Errore del servizio Batch.

Sicurezza

azure_auth

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Account list node agent skus

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
AccountListSupportedImagesResult	Risultato dell'elenco delle immagini di macchine virtuali supportate.
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
ImageInformation	Riferimento all'immagine del Marketplace delle macchine virtuali di Azure e ad altre informazioni sull'immagine.
ImageReference	Riferimento a un'immagine del Marketplace di macchine virtuali di Azure o a un'immagine della raccolta di calcolo di Azure. Per ottenere l'elenco di tutti i riferimenti alle immagini di Azure Marketplace verificati da Azure Batch, vedere l'operazione "Elenca immagini supportate".
OSType	Tipo di sistema operativo (ad esempio Windows o Linux) dell'immagine.
VerificationType	Indica se il servizio Azure Batch verifica attivamente che l'immagine sia compatibile con lo SKU dell'agente del nodo di calcolo associato.

AccountListSupportedImagesResult

Risultato dell'elenco delle immagini di macchine virtuali supportate.

Nome	Tipo	Descrizione
odata.nextLink	string	URL per ottenere il set di risultati successivo.
value	ImageInformation[]	Elenco di immagini di macchine virtuali supportate.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	ErrorMessage	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta di errore.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

Nome	Tipo	Descrizione
lang	string	Codice linguistico del messaggio di errore
value	string	Testo del messaggio.

ImageInformation

Riferimento all'immagine del Marketplace delle macchine virtuali di Azure e ad altre informazioni sull'immagine.

Nome	Tipo	Descrizione
batchSupportEndOfLife	string	L'ora in cui il servizio Azure Batch smetterà di accettare le richieste di creazione del pool per l'immagine.
capabilities	string[]	Funzionalità o funzionalità supportate dall'immagine. Non tutte le funzionalità dell'immagine sono elencate. Le funzionalità di questo elenco sono considerate di particolare interesse e sono in genere correlate all'integrazione con altre funzionalità nel servizio Azure Batch.
imageReference	ImageReference	Riferimento all'immagine del Marketplace della macchina virtuale di Azure.
nodeAgentSKUId	string	ID dello SKU dell'agente del nodo di calcolo supportato dall'immagine.
osType	OSType	Tipo di sistema operativo (ad esempio Windows o Linux) dell'immagine.
verificationType	VerificationType	Indica se il servizio Azure Batch verifica attivamente che l'immagine sia compatibile con lo SKU dell'agente del nodo di calcolo associato.

ImageReference

Riferimento a un'immagine del Marketplace di macchine virtuali di Azure o a un'immagine della raccolta di calcolo di Azure. Per ottenere l'elenco di tutti i riferimenti alle immagini di Azure Marketplace verificati da Azure Batch, vedere l'operazione "Elenca immagini supportate".

Nome	Tipo	Descrizione
communityGalleryImageId	string	Identificatore univoco dell'immagine della raccolta community Questa proprietà si escludono a vicenda con altre proprietà e possono essere recuperate dalla chiamata GET dell'immagine della raccolta della community.
exactVersion	string	Versione specifica dell'immagine della piattaforma o dell'immagine del marketplace usata per creare il nodo. Questo campo di sola lettura è diverso da 'version' solo se il valore specificato per 'version' quando il pool è stato creato è stato 'latest'.
offer	string	Tipo di offerta dell'immagine marketplace di Macchine virtuali di Azure. Ad esempio, UbuntuServer o WindowsServer.
publisher	string	Autore dell'immagine del Marketplace delle macchine virtuali di Azure. Ad esempio, Canonical o MicrosoftWindowsServer.
sharedGalleryImageId	string	Identificatore univoco dell'immagine della raccolta condivisa Questa proprietà si escludono a vicenda con altre proprietà e possono essere recuperate dalla chiamata GET dell'immagine della raccolta condivisa.
sku	string	SKU dell'immagine del Marketplace delle macchine virtuali di Azure. Ad esempio, 18.04-LTS o 2019-Datacenter.
version	string	Versione dell'immagine marketplace di Macchine virtuali di Azure. È possibile specificare il valore 'latest' per selezionare la versione più recente di un'immagine. Se omesso, il valore predefinito è 'latest'.
virtualMachineImageId	string	Identificatore della risorsa ARM dell'immagine della raccolta di calcolo di Azure. I nodi di calcolo nel pool verranno creati usando questo ID immagine. Si tratta del formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} o /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} per l'impostazione predefinita alla versione più recente dell'immagine. Questa proprietà si escludono a vicenda con altre proprietà ImageReference. L'immagine della raccolta di calcolo di Azure deve avere repliche nella stessa area e deve trovarsi nella stessa sottoscrizione dell'account Azure Batch. Se la versione dell'immagine non è specificata nell'imageId, verrà usata la versione più recente. Per informazioni sulle impostazioni del firewall per l'agente del nodo di calcolo Batch per comunicare con il servizio Batch, vedere https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

OSType

Tipo di sistema operativo (ad esempio Windows o Linux) dell'immagine.

Nome	Tipo	Descrizione
linux	string	Sistema operativo Linux.
windows	string	Sistema operativo Windows.

VerificationType

Indica se il servizio Azure Batch verifica attivamente che l'immagine sia compatibile con lo SKU dell'agente del nodo di calcolo associato.

Nome	Tipo	Descrizione
unverified	string	Lo SKU dell'agente del nodo di calcolo associato deve avere compatibilità binaria con l'immagine, ma non è stata verificata alcuna funzionalità specifica.
verified	string	L'immagine è sicuramente compatibile con lo SKU dell'agente del nodo di calcolo associato e tutte le funzionalità di Batch sono state confermate per funzionare come previsto.