共用方式為

Account - List Supported Images

  • 參考
服務:
Batch Service
API 版本:
2024-07-01.20.0

列出 Azure Batch 服務支援的所有虛擬機映像。

GET {batchUrl}/supportedimages?api-version=2024-07-01.20.0
含選擇性參數: 
GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI 參數

名稱 位於 必要 類型 Description
batchUrl
 path True

string

所有 Azure Batch 服務要求的基底 URL。
api-version
 query True

string

用戶端 API 版本。
$filter
 query

string

OData $filter 子句。 如需建構此篩選的詳細資訊，請參閱 https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images。
maxresults
 query

integer

int32

回應中要傳回的項目數目上限。 最多會傳回 1000 個結果。
timeout
 query

integer

int32

伺服器可以花費數秒處理要求的時間上限。 預設值為30秒。 如果值大於 30，則會改用預設值。

要求標頭

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

名稱 必要 類型 Description
client-request-id

string

uuid

呼叫端產生的要求身分識別，格式為 GUID，不含大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id

boolean

伺服器是否應該在回應中傳回 client-request-id。
ocp-date

string

date-time-rfc1123

發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。

回應

名稱 類型 Description
200 OK

AccountListSupportedImagesResult

包含支援的虛擬機映像清單的回應。

標題

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Batch 服務的錯誤。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

Authorization

類型: apiKey
位於: header

範例

Account list node agent skus

範例要求

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

範例回覆

狀態碼:
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"
    }
  ]
}

定義

名稱 Description
AccountListSupportedImagesResult

列出支援的虛擬機映像結果。
BatchError

從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。
ErrorMessage

Azure Batch 錯誤回應中收到的錯誤訊息。
ImageInformation

Azure 虛擬機 Marketplace 映像的參考，以及映射的其他資訊。
ImageReference

Azure 虛擬機 Marketplace 映像或 Azure 計算資源庫映像的參考。 若要取得 Azure Batch 所驗證的所有 Azure Marketplace 映像參考清單，請參閱「列出支援的映像」作業。
OSType

映射的操作系統類型（例如 Windows 或 Linux）。
VerificationType

Azure Batch 服務是否主動驗證映像是否與相關聯的計算節點代理程式 SKU 相容。

AccountListSupportedImagesResult

列出支援的虛擬機映像結果。

名稱 類型 Description
odata.nextLink

string

要取得下一組結果的URL。
value

ImageInformation[]

支援的虛擬機映像清單。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱 類型 Description
code

string

錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message

ErrorMessage

描述錯誤的訊息，適用於在使用者介面中顯示。
values

BatchErrorDetail[]

索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱 類型 Description
key

string

指定 Value 屬性意義的識別碼。
value

string

錯誤回應隨附的其他資訊。

ErrorMessage

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱 類型 Description
lang

string

錯誤訊息的語言代碼
value

string

訊息的文字。

ImageInformation

Azure 虛擬機 Marketplace 映像的參考，以及映射的其他資訊。

名稱 類型 Description
batchSupportEndOfLife

string

Azure Batch 服務停止接受映像的建立集區要求的時間。
capabilities

string[]

Image 支援的功能或功能。
並非列出映像的每個功能。 此清單中的功能會被視為特別感興趣的功能，通常與 Azure Batch 服務中的其他功能整合有關。
imageReference

ImageReference

Azure 虛擬機 Marketplace 映像的參考。
nodeAgentSKUId

string

映像支持的計算節點代理程式 SKU 識別碼。
osType

OSType

映射的操作系統類型（例如 Windows 或 Linux）。
verificationType

VerificationType

Azure Batch 服務是否主動驗證映像是否與相關聯的計算節點代理程式 SKU 相容。

ImageReference

Azure 虛擬機 Marketplace 映像或 Azure 計算資源庫映像的參考。 若要取得 Azure Batch 所驗證的所有 Azure Marketplace 映像參考清單，請參閱「列出支援的映像」作業。

名稱 類型 Description
communityGalleryImageId

string

社群資源庫映像唯一標識符
這個屬性與其他屬性互斥，而且可以從社群資源庫映像 GET 呼叫擷取。
exactVersion

string

用來建立節點之平臺映像或市集映像的特定版本。 只有當建立集區時為 'version' 指定的值是 'latest' 時，這個只讀字段才會與 'version' 不同。
offer

string

Azure 虛擬機 Marketplace 映像的供應項目類型。
例如，UbuntuServer 或 WindowsServer。
publisher

string

Azure 虛擬機 Marketplace 映像的發行者。
例如，Canonical 或 MicrosoftWindowsServer。
sharedGalleryImageId

string

共用資源庫映像唯一標識碼
這個屬性與其他屬性互斥，而且可以從共用資源庫映像 GET 呼叫擷取。
sku

string

Azure 虛擬機 Marketplace 映像的 SKU。
例如，18.04-LTS 或 2019-Datacenter。
version

string

Azure 虛擬機 Marketplace 映像的版本。
您可以指定 'latest' 的值來選取最新版的映像。 如果省略，預設值為 'latest'。
virtualMachineImageId

string

Azure 計算資源庫映射的 ARM 資源識別碼。 將會使用此映像標識碼來建立集區中的計算節點。這是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} 的格式 或 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} ，一律預設為最新的映射版本。
這個屬性與其他 ImageReference 屬性互斥。 Azure 計算資源庫映像必須有相同區域中的複本，且必須與 Azure Batch 帳戶位於相同的訂用帳戶中。 如果未在 imageId 中指定映像版本，則會使用最新版本。 如需 Batch 計算節點代理程式與 Batch 服務通訊之防火牆設定的相關信息，請參閱 https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration。

OSType

映射的操作系統類型（例如 Windows 或 Linux）。

名稱 類型 Description
linux

string

Linux 作業系統。
windows

string

Windows 作業系統。

VerificationType

Azure Batch 服務是否主動驗證映像是否與相關聯的計算節點代理程式 SKU 相容。

名稱 類型 Description
unverified

string

相關聯的計算節點代理程式 SKU 應該與映像具有二進位相容性，但尚未驗證特定功能。
verified

string

映像保證與相關聯的計算節點代理程式 SKU 相容，且所有 Batch 功能都已確認如預期般運作。