Bagikan melalui


Account - List Supported Images

Mencantumkan semua Gambar Komputer Virtual yang didukung oleh layanan 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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
batchUrl
path True

string

URL dasar untuk semua permintaan layanan Azure Batch.

api-version
query True

string

Versi API Klien.

$filter
query

string

Klausa $filter OData. Untuk informasi selengkapnya tentang membuat filter ini, lihat https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.

maxresults
query

integer (int32)

minimum: 1
maximum: 1000

Jumlah maksimum item yang akan dikembalikan dalam respons. Maksimal 1000 hasil akan dikembalikan.

timeout
query

integer (int32)

Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik. Jika nilainya lebih besar dari 30, default akan digunakan sebagai gantinya.

Header Permintaan

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

Nama Diperlukan Jenis Deskripsi
client-request-id

string (uuid)

Identitas permintaan yang dihasilkan penelepon, dalam bentuk GUID tanpa dekorasi seperti kurung kurawal, misalnya 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Apakah server harus mengembalikan client-request-id dalam respons.

ocp-date

string (date-time-rfc1123)

Waktu permintaan dikeluarkan. Pustaka klien biasanya mengatur ini ke waktu jam sistem saat ini; atur secara eksplisit jika Anda memanggil REST API secara langsung.

Respons

Nama Jenis Deskripsi
200 OK

AccountListSupportedImagesResult

Respons yang berisi daftar Gambar Komputer Virtual yang didukung.

Header

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

BatchError

Kesalahan dari layanan Batch.

Keamanan

azure_auth

Alur kode autentikasi Microsoft Entra OAuth 2.0

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation Meniru akun pengguna Anda

Authorization

Jenis: apiKey
Dalam: header

Contoh

Account list node agent skus

Permintaan sampel

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


Respon sampel

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

Definisi

Nama Deskripsi
AccountListSupportedImagesResult

Hasil dari mencantumkan Gambar Komputer Virtual yang didukung.

BatchError

Respons kesalahan diterima dari layanan Azure Batch.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

ImageInformation

Referensi ke Gambar Marketplace Azure Virtual Machines dan informasi tambahan tentang Gambar.

ImageReference

Referensi ke Gambar Marketplace Azure Virtual Machines atau Gambar Azure Compute Gallery. Untuk mendapatkan daftar semua referensi Gambar Marketplace Azure yang diverifikasi oleh Azure Batch, lihat operasi 'Daftar Gambar yang Didukung'.

OSType

Jenis sistem operasi (misalnya Windows atau Linux) gambar.

VerificationType

Apakah layanan Azure Batch secara aktif memverifikasi bahwa Gambar kompatibel dengan SKU agen Simpul Komputasi terkait.

AccountListSupportedImagesResult

Hasil dari mencantumkan Gambar Komputer Virtual yang didukung.

Nama Jenis Deskripsi
odata.nextLink

string

URL untuk mendapatkan serangkaian hasil berikutnya.

value

ImageInformation[]

Daftar Gambar Komputer Virtual yang didukung.

BatchError

Respons kesalahan diterima dari layanan Azure Batch.

Nama Jenis Deskripsi
code

string

Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.

message

ErrorMessage

Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.

values

BatchErrorDetail[]

Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Nama Jenis Deskripsi
key

string

Pengidentifikasi yang menentukan arti properti Nilai.

value

string

Informasi tambahan yang disertakan dengan respons kesalahan.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Nama Jenis Deskripsi
lang

string

Kode bahasa pesan kesalahan

value

string

Teks pesan.

ImageInformation

Referensi ke Gambar Marketplace Azure Virtual Machines dan informasi tambahan tentang Gambar.

Nama Jenis Deskripsi
batchSupportEndOfLife

string (date-time)

Waktu ketika layanan Azure Batch akan berhenti menerima permintaan buat Kumpulan untuk Gambar.

capabilities

string[]

Kemampuan atau fitur yang didukung Gambar.
Tidak setiap kemampuan Gambar tercantum. Kemampuan dalam daftar ini dianggap menarik dan umumnya terkait dengan integrasi dengan fitur lain dalam layanan Azure Batch.

imageReference

ImageReference

Referensi ke Gambar Marketplace Azure Virtual Machine.

nodeAgentSKUId

string

ID SKU agen Simpul Komputasi yang didukung Gambar.

osType

OSType

Jenis sistem operasi (misalnya Windows atau Linux) gambar.

verificationType

VerificationType

Apakah layanan Azure Batch secara aktif memverifikasi bahwa Gambar kompatibel dengan SKU agen Simpul Komputasi terkait.

ImageReference

Referensi ke Gambar Marketplace Azure Virtual Machines atau Gambar Azure Compute Gallery. Untuk mendapatkan daftar semua referensi Gambar Marketplace Azure yang diverifikasi oleh Azure Batch, lihat operasi 'Daftar Gambar yang Didukung'.

Nama Jenis Deskripsi
communityGalleryImageId

string

Pengidentifikasi unik gambar galeri komunitas
Properti ini saling eksklusif dengan properti lain dan dapat diambil dari panggilan GET gambar galeri komunitas.

exactVersion

string

Versi spesifik gambar platform atau gambar marketplace yang digunakan untuk membuat simpul. Bidang baca-saja ini berbeda dari 'versi' hanya jika nilai yang ditentukan untuk 'versi' ketika kumpulan dibuat adalah 'terbaru'.

offer

string

Jenis penawaran Gambar Marketplace Azure Virtual Machines.
Misalnya, UbuntuServer atau WindowsServer.

publisher

string

Penerbit Gambar Marketplace Azure Virtual Machines.
Misalnya, Canonical atau MicrosoftWindowsServer.

sharedGalleryImageId

string

Pengidentifikasi unik gambar galeri bersama
Properti ini saling eksklusif dengan properti lain dan dapat diambil dari panggilan GET gambar galeri bersama.

sku

string

SKU Gambar Marketplace Azure Virtual Machines.
Misalnya, 18.04-LTS atau 2019-Datacenter.

version

string

Versi Gambar Marketplace Azure Virtual Machines.
Nilai 'terbaru' dapat ditentukan untuk memilih versi terbaru Gambar. Jika dihilangkan, defaultnya adalah 'terbaru'.

virtualMachineImageId

string

Pengidentifikasi sumber daya ARM dari Gambar Azure Compute Gallery. Simpul Komputasi di Kumpulan akan dibuat menggunakan Id Gambar ini. Ini adalah formulir /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} atau /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} untuk selalu default ke versi gambar terbaru.
Properti ini saling eksklusif dengan properti ImageReference lainnya. Gambar Azure Compute Gallery harus memiliki replika di wilayah yang sama dan harus berada dalam langganan yang sama dengan akun Azure Batch. Jika versi gambar tidak ditentukan dalam imageId, versi terbaru akan digunakan. Untuk informasi tentang pengaturan firewall untuk agen Simpul Komputasi Batch untuk berkomunikasi dengan layanan Batch, lihat https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

OSType

Jenis sistem operasi (misalnya Windows atau Linux) gambar.

Nilai Deskripsi
linux

Sistem operasi Linux.

windows

Sistem operasi Windows.

VerificationType

Apakah layanan Azure Batch secara aktif memverifikasi bahwa Gambar kompatibel dengan SKU agen Simpul Komputasi terkait.

Nilai Deskripsi
unverified

SKU agen Simpul Komputasi terkait harus memiliki kompatibilitas biner dengan Gambar, tetapi fungsionalitas tertentu belum diverifikasi.

verified

Gambar dijamin kompatibel dengan SKU agen Simpul Komputasi terkait dan semua fitur Batch telah dikonfirmasi berfungsi seperti yang diharapkan.