Account - List Supported Images
Visar en lista över alla avbildningar av virtuella datorer som stöds av Azure Batch-tjänsten.
GET {batchUrl}/supportedimages?api-version=2023-11-01.18.0
GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Bas-URL:en för alla Azure Batch tjänstbegäranden. |
api-version
|
query | True |
string |
Klient-API-version. |
$filter
|
query |
string |
En OData-$filter-sats. Mer information om hur du skapar det här filtret finns i https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. |
|
maxresults
|
query |
integer int32 |
Det maximala antalet objekt som ska returneras i svaret. Högst 1 000 resultat returneras. |
|
timeout
|
query |
integer int32 |
Den maximala tid som servern kan ägna åt att bearbeta begäran, i sekunder. Standardvärdet är 30 sekunder. |
Begärandehuvud
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
client-request-id |
string uuid |
Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Om servern ska returnera client-request-id i svaret. |
|
ocp-date |
string date-time-rfc1123 |
Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till systemets aktuella klocktid. ange det uttryckligen om du anropar REST-API:et direkt. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Ett svar som innehåller listan över avbildningar av virtuella datorer som stöds. Sidhuvuden
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Microsoft Entra OAuth 2.0-autentiseringskodflöde
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Authorization
Typ:
apiKey
I:
header
Exempel
Account list node agent skus
Exempelbegäran
GET account.region.batch.azure.com/supportedimages?api-version=2023-11-01.18.0
Exempelsvar
{
"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"
}
]
}
Definitioner
Name | Description |
---|---|
Account |
Resultatet av en lista över avbildningar av virtuella datorer som stöds. |
Batch |
Ett felsvar som tagits emot från Azure Batch-tjänsten. |
Batch |
Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar. |
Error |
Ett felmeddelande som tas emot i ett Azure Batch felsvar. |
Image |
En referens till Azure Virtual Machines Marketplace-avbildningen och ytterligare information om avbildningen. |
Image |
En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. Om du vill hämta en lista över alla Azure Marketplace Image-referenser som verifierats av Azure Batch läser du åtgärden "Lista över avbildningar som stöds". |
OSType |
Typ av operativsystem (t.ex. Windows eller Linux) för avbildningen. |
Verification |
Om Azure Batch-tjänsten aktivt verifierar att avbildningen är kompatibel med den associerade Compute Node-agent-SKU:n. |
AccountListSupportedImagesResult
Resultatet av en lista över avbildningar av virtuella datorer som stöds.
Name | Typ | Description |
---|---|---|
odata.nextLink |
string |
URL:en för att hämta nästa uppsättning resultat. |
value |
Listan över avbildningar av virtuella datorer som stöds. |
BatchError
Ett felsvar som tagits emot från Azure Batch-tjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt. |
message |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
|
values |
En samling nyckel/värde-par som innehåller ytterligare information om felet. |
BatchErrorDetail
Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
Name | Typ | Description |
---|---|---|
key |
string |
En identifierare som anger innebörden av egenskapen Value. |
value |
string |
Den ytterligare information som ingår i felsvaret. |
ErrorMessage
Ett felmeddelande som tas emot i ett Azure Batch felsvar.
Name | Typ | Description |
---|---|---|
lang |
string |
Språkkoden för felmeddelandet |
value |
string |
Texten i meddelandet. |
ImageInformation
En referens till Azure Virtual Machines Marketplace-avbildningen och ytterligare information om avbildningen.
Name | Typ | Description |
---|---|---|
batchSupportEndOfLife |
string |
Den tid då Azure Batch-tjänsten slutar acceptera begäranden om att skapa pooler för avbildningen. |
capabilities |
string[] |
De funktioner som avbildningen stöder. |
imageReference |
Referensen till Azure Virtual Machines Marketplace-avbildning. |
|
nodeAgentSKUId |
string |
ID:t för beräkningsnodagentens SKU som avbildningen stöder. |
osType |
Typ av operativsystem (t.ex. Windows eller Linux) för avbildningen. |
|
verificationType |
Om Azure Batch-tjänsten aktivt verifierar att avbildningen är kompatibel med den associerade Compute Node-agent-SKU:n. |
ImageReference
En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. Om du vill hämta en lista över alla Azure Marketplace Image-referenser som verifierats av Azure Batch läser du åtgärden "Lista över avbildningar som stöds".
Name | Typ | Description |
---|---|---|
exactVersion |
string |
Den specifika versionen av plattformsbilden eller Marketplace-avbildningen som används för att skapa noden. Det här skrivskyddade fältet skiljer sig endast från "version" om värdet som angavs för "version" när poolen skapades var "senaste". |
offer |
string |
Erbjudandetypen för Azure Virtual Machines Marketplace-avbildningen. |
publisher |
string |
Utgivaren av Azure Virtual Machines Marketplace-avbildningen. |
sku |
string |
SKU:n för Azure Virtual Machines Marketplace-avbildningen. |
version |
string |
Versionen av Azure Virtual Machines Marketplace-avbildningen. |
virtualMachineImageId |
string |
ARM-resursidentifieraren för Azure Compute Gallery-avbildningen. Beräkningsnoder i poolen skapas med det här avbildnings-ID:t. Detta är av formatet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} eller /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} för att alltid ha den senaste avbildningsversionen som standard. |
OSType
Typ av operativsystem (t.ex. Windows eller Linux) för avbildningen.
Name | Typ | Description |
---|---|---|
linux |
string |
Linux-operativsystemet. |
windows |
string |
Windows-operativsystemet. |
VerificationType
Om Azure Batch-tjänsten aktivt verifierar att avbildningen är kompatibel med den associerade Compute Node-agent-SKU:n.
Name | Typ | Description |
---|---|---|
unverified |
string |
Den associerade SKU:n för Compute Node-agenten bör ha binär kompatibilitet med avbildningen, men specifika funktioner har inte verifierats. |
verified |
string |
Avbildningen är garanterat kompatibel med den associerade Compute Node-agentens SKU och alla Batch-funktioner har bekräftats fungera som förväntat. |