Virtual Machine Image Templates - Get

Layanan:: Image Builder

Versi API:: 2022-07-01

Mendapatkan informasi tentang templat gambar komputer virtual

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}?api-version=2022-07-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
imageTemplateName	path	True	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nama Templat gambar
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. Id langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi Api Klien.

Respons

Nama	Jenis	Deskripsi
200 OK	ImageTemplate	OK
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Retrieve an Image Template.

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate?api-version=2022-07-01

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
  "name": "myImageTemplate",
  "location": "westus",
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "source": {
      "type": "ManagedImage",
      "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image"
    },
    "customize": [
      {
        "type": "Shell",
        "name": "Shell Customizer Example",
        "scriptUri": "https://example.com/path/to/script.sh"
      }
    ],
    "distribute": [
      {
        "type": "ManagedImage",
        "location": "1_location",
        "runOutputName": "image_it_pir_1",
        "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
        "artifactTags": {
          "tagName": "value"
        }
      }
    ],
    "vmProfile": {
      "vmSize": "Standard_D2s_v3",
      "osDiskSizeGB": 64
    }
  }
}

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari layanan Azure VM Image Builder.
CloudErrorBody	Respons kesalahan dari layanan Azure VM Image Builder.
createdByType	Jenis identitas yang membuat sumber daya.
DistributeVersionerLatest	Menghasilkan nomor versi yang akan terbaru berdasarkan nomor versi yang ada.
DistributeVersionerSource	Menghasilkan nomor versi berdasarkan nomor versi gambar sumber
ImageTemplate	Templat gambar adalah sumber daya ARM yang dikelola oleh penyedia Microsoft.VirtualMachineImages
ImageTemplateFileCustomizer	Mengunggah file ke VM (Linux, Windows). Sesuai dengan penyedia file Packer
ImageTemplateFileValidator	Mengunggah file yang diperlukan untuk validasi ke VM (Linux, Windows). Sesuai dengan penyedia file Packer
ImageTemplateIdentity	Identitas untuk templat gambar.
ImageTemplateLastRunStatus	Menjelaskan status terbaru menjalankan templat gambar
ImageTemplateManagedImageDistributor	Distribusikan sebagai Citra Disk Terkelola.
ImageTemplateManagedImageSource	Menjelaskan sumber gambar yang merupakan gambar terkelola dalam langganan pelanggan. Gambar ini harus berada di langganan dan wilayah yang sama dengan templat Image Builder.
ImageTemplatePlatformImageSource	Menjelaskan sumber gambar dari Gambar Galeri Azure.
ImageTemplatePowerShellCustomizer	Menjalankan PowerShell yang ditentukan pada VM (Windows). Sesuai dengan penyedia powershell Packer. Tepat salah satu 'scriptUri' atau 'inline' dapat ditentukan.
ImageTemplatePowerShellValidator	Menjalankan skrip PowerShell yang ditentukan selama fase validasi (Windows). Sesuai dengan penyedia powershell Packer. Tepat salah satu 'scriptUri' atau 'inline' dapat ditentukan.
ImageTemplateRestartCustomizer	Reboot VM dan menunggunya kembali online (Windows). Sesuai dengan penyedia windows-restart Packer
ImageTemplateSharedImageDistributor	Distribusikan melalui Azure Compute Gallery.
ImageTemplateSharedImageVersionSource	Menjelaskan sumber gambar yang merupakan versi gambar di Azure Compute Gallery atau Direct Shared Gallery.
ImageTemplateShellCustomizer	Menjalankan skrip shell selama fase kustomisasi (Linux). Sesuai dengan provisi shell Packer. Tepat salah satu 'scriptUri' atau 'inline' dapat ditentukan.
ImageTemplateShellValidator	Menjalankan skrip shell yang ditentukan selama fase validasi (Linux). Sesuai dengan provisi shell Packer. Tepat salah satu 'scriptUri' atau 'inline' dapat ditentukan.
ImageTemplateVhdDistributor	Distribusikan melalui VHD di akun penyimpanan.
ImageTemplateVmProfile	Menjelaskan komputer virtual yang digunakan untuk membangun dan memvalidasi gambar
ImageTemplateWindowsUpdateCustomizer	Menginstal Windows Updates. Sesuai dengan Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)
Optimize	Menentukan pengoptimalan yang akan dilakukan pada gambar.
PlatformImagePurchasePlan	Konfigurasi paket pembelian untuk gambar platform.
ProvisioningError	Menjelaskan kesalahan yang terjadi saat membuat atau memperbarui templat gambar
ProvisioningErrorCode	Kode kesalahan kegagalan provisi
ProvisioningState	Status provisi sumber daya
ResourceIdentityType	Jenis identitas yang digunakan untuk templat gambar. Jenis 'None' akan menghapus identitas apa pun dari templat gambar.
RunState	Status eksekusi terakhir
RunSubState	Sub-status eksekusi terakhir
SharedImageStorageAccountType	Menentukan jenis akun penyimpanan yang akan digunakan untuk menyimpan versi gambar Azure Compute Gallery.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TargetRegion	Menjelaskan informasi wilayah target.
UserAssignedIdentity	Properti identitas yang ditetapkan pengguna
Validate	Opsi konfigurasi dan daftar validasi yang akan dilakukan pada gambar yang dihasilkan.
VirtualNetworkConfig	Konfigurasi Virtual Network.
VmBoot	Pengoptimalan diterapkan pada gambar untuk boot VM yang lebih cepat.
VMBootOptimizationState	Mengaktifkan bidang ini akan meningkatkan waktu boot VM dengan mengoptimalkan output gambar akhir yang disesuaikan.

CloudError

Objek

Respons kesalahan dari layanan Azure VM Image Builder.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Detail tentang kesalahan.

CloudErrorBody

Objek

Respons kesalahan dari layanan Azure VM Image Builder.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Objek

Menghasilkan nomor versi yang akan terbaru berdasarkan nomor versi yang ada.

Nama	Jenis	Nilai default	Deskripsi
major	integer (int32) minimum: -1	-1	Versi utama untuk nomor versi yang dihasilkan. Tentukan apa itu "terbaru" berdasarkan versi dengan nilai ini sebagai versi utama. -1 setara dengan membiarkannya tidak diatur.
scheme	string: Latest		Skema penomoran versi yang akan digunakan.

DistributeVersionerSource

Objek

Menghasilkan nomor versi berdasarkan nomor versi gambar sumber

Nama	Jenis	Deskripsi
scheme	string: Source	Skema penomoran versi yang akan digunakan.

ImageTemplate

Objek

Templat gambar adalah sumber daya ARM yang dikelola oleh penyedia Microsoft.VirtualMachineImages

Nama	Jenis	Nilai default	Deskripsi
id	string		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		Identitas templat gambar, jika dikonfigurasi.
location	string		Lokasi geografis tempat sumber daya berada
name	string		Nama sumber daya
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	Durasi maksimum untuk menunggu saat membangun templat gambar (mencakup semua kustomisasi, pengoptimalan, validasi, dan distribusi). Hilangkan atau tentukan 0 untuk menggunakan default (4 jam).
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		Menentukan properti yang digunakan untuk menjelaskan langkah-langkah kustomisasi gambar, seperti Sumber gambar dll
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		Distribusi menargetkan tempat output gambar perlu masuk.
properties.exactStagingResourceGroup	string		Id grup sumber daya penahapan dalam langganan yang sama dengan templat gambar yang akan digunakan untuk membangun gambar. Bidang baca-saja ini berbeda dari 'stagingResourceGroup' hanya jika nilai yang ditentukan dalam bidang 'stagingResourceGroup' kosong.
properties.lastRunStatus	ImageTemplateLastRunStatus		Status 'jalankan' yang saat ini sedang dijalankan atau terakhir dijalankan.
properties.optimize	Optimize		Menentukan pengoptimalan yang akan dilakukan pada gambar.
properties.provisioningError	ProvisioningError		Kesalahan provisi, jika ada
properties.provisioningState	ProvisioningState		Status provisi sumber daya
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		Menentukan properti yang digunakan untuk menjelaskan gambar sumber.
properties.stagingResourceGroup	string		Id grup sumber daya penahapan dalam langganan yang sama dengan templat gambar yang akan digunakan untuk membangun gambar. Jika bidang ini kosong, grup sumber daya dengan nama acak akan dibuat. Jika grup sumber daya yang ditentukan di bidang ini tidak ada, grup sumber daya akan dibuat dengan nama yang sama. Jika grup sumber daya yang ditentukan ada, grup sumber daya harus kosong dan di wilayah yang sama dengan templat gambar. Grup sumber daya yang dibuat akan dihapus selama penghapusan templat jika bidang ini kosong atau grup sumber daya yang ditentukan tidak ada, tetapi jika grup sumber daya yang ditentukan ada sumber daya yang dibuat dalam grup sumber daya akan dihapus selama penghapusan templat dan grup sumber daya itu sendiri akan tetap ada.
properties.validate	Validate		Opsi konfigurasi dan daftar validasi yang akan dilakukan pada gambar yang dihasilkan.
properties.vmProfile	ImageTemplateVmProfile		Menjelaskan bagaimana komputer virtual disiapkan untuk membangun gambar
systemData	systemData		Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ImageTemplateFileCustomizer

Objek

Mengunggah file ke VM (Linux, Windows). Sesuai dengan penyedia file Packer

Nama	Jenis	Deskripsi
destination	string	Jalur absolut ke file (dengan struktur direktori berlapis yang sudah dibuat) tempat file (dari sourceUri) akan diunggah ke di VM
name	string	Nama yang Mudah Diingat untuk memberikan konteks tentang apa yang dilakukan langkah penyesuaian ini
sha256Checksum	string	Checksum SHA256 dari file yang disediakan di bidang sourceUri di atas
sourceUri	string	URI file yang akan diunggah untuk menyesuaikan VM. Ini bisa menjadi tautan github, SAS URI untuk Azure Storage, dll
type	string: File	Jenis alat kustomisasi yang ingin Anda gunakan pada Gambar. Misalnya, "Shell" bisa menjadi penyesuai shell

ImageTemplateFileValidator

Objek

Mengunggah file yang diperlukan untuk validasi ke VM (Linux, Windows). Sesuai dengan penyedia file Packer

Nama	Jenis	Deskripsi
destination	string	Jalur absolut ke file (dengan struktur direktori berlapis yang sudah dibuat) tempat file (dari sourceUri) akan diunggah ke di VM
name	string	Nama yang Mudah Diingat untuk memberikan konteks tentang apa yang dilakukan langkah validasi ini
sha256Checksum	string	Checksum SHA256 dari file yang disediakan di bidang sourceUri di atas
sourceUri	string	URI file yang akan diunggah ke VM untuk validasi. Ini bisa berupa tautan github, URI Azure Storage (resmi atau SAS), dll
type	string: File	Jenis validasi yang ingin Anda gunakan pada Gambar. Misalnya, "Shell" bisa menjadi validasi shell

ImageTemplateIdentity

Objek

Identitas untuk templat gambar.

Nama	Jenis	Deskripsi
type	ResourceIdentityType	Jenis identitas yang digunakan untuk templat gambar. Jenis 'None' akan menghapus identitas apa pun dari templat gambar.
userAssignedIdentities	<string, UserAssignedIdentity>	Identitas User-Assigned Kumpulan identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Kunci kamus userAssignedIdentities akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Nilai kamus dapat berupa objek kosong ({}) dalam permintaan.

ImageTemplateLastRunStatus

Objek

Menjelaskan status terbaru menjalankan templat gambar

Nama	Jenis	Deskripsi
endTime	string (date-time)	Waktu akhir eksekusi terakhir (UTC)
message	string	Informasi verbose tentang status eksekusi terakhir
runState	RunState	Status eksekusi terakhir
runSubState	RunSubState	Sub-status eksekusi terakhir
startTime	string (date-time)	Waktu mulai eksekusi terakhir (UTC)

ImageTemplateManagedImageDistributor

Objek

Distribusikan sebagai Citra Disk Terkelola.

Nama	Jenis	Deskripsi
artifactTags	object	Tag yang akan diterapkan ke artefak setelah dibuat/diperbarui oleh distributor.
imageId	string	Id Sumber Daya Citra Disk Terkelola
location	string	Lokasi Azure untuk gambar, harus cocok jika gambar sudah ada
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nama yang akan digunakan untuk RunOutput terkait.
type	string: ManagedImage	Jenis distribusi.

ImageTemplateManagedImageSource

Objek

Menjelaskan sumber gambar yang merupakan gambar terkelola dalam langganan pelanggan. Gambar ini harus berada di langganan dan wilayah yang sama dengan templat Image Builder.

Nama	Jenis	Deskripsi
imageId	string	Id sumber daya ARM dari gambar terkelola dalam langganan pelanggan
type	string: ManagedImage	Menentukan jenis gambar sumber yang ingin Anda mulai.

ImageTemplatePlatformImageSource

Objek

Menjelaskan sumber gambar dari Gambar Galeri Azure.

Nama	Jenis	Deskripsi
exactVersion	string	Versi gambar dariGambar Galeri Azure . Bidang readonly ini berbeda dari 'versi', hanya jika nilai yang ditentukan dalam bidang 'versi' adalah 'terbaru'.
offer	string	Penawaran gambar dari Gambar Galeri Azure.
planInfo	PlatformImagePurchasePlan	Konfigurasi opsional paket pembelian untuk gambar platform.
publisher	string	Penerbit Gambar di Gambar Galeri Azure.
sku	string	Gambar sku dari Gambar Galeri Azure.
type	string: PlatformImage	Menentukan jenis gambar sumber yang ingin Anda mulai.
version	string	Versi gambar dariGambar Galeri Azure . Jika 'terbaru' ditentukan di sini, versi dievaluasi ketika build gambar terjadi, bukan saat templat dikirimkan.

ImageTemplatePowerShellCustomizer

Objek

Menjalankan PowerShell yang ditentukan pada VM (Windows). Sesuai dengan penyedia powershell Packer. Tepat salah satu 'scriptUri' atau 'inline' dapat ditentukan.

Nama	Jenis	Nilai default	Deskripsi
inline	string[]		Array perintah PowerShell untuk dijalankan
name	string		Nama yang Mudah Diingat untuk memberikan konteks tentang apa yang dilakukan langkah penyesuaian ini
runAsSystem	boolean	False	Jika ditentukan, skrip PowerShell akan dijalankan dengan hak istimewa yang ditingkatkan menggunakan pengguna Sistem Lokal. Hanya dapat benar ketika bidang runElevated di atas diatur ke true.
runElevated	boolean	False	Jika ditentukan, skrip PowerShell akan dijalankan dengan hak istimewa yang ditingkatkan
scriptUri	string		URI skrip PowerShell yang akan dijalankan untuk disesuaikan. Ini bisa menjadi tautan github, SAS URI untuk Azure Storage, dll
sha256Checksum	string		Checksum SHA256 dari skrip shell daya yang disediakan di bidang scriptUri di atas
type	string: PowerShell		Jenis alat kustomisasi yang ingin Anda gunakan pada Gambar. Misalnya, "Shell" bisa menjadi penyesuai shell
validExitCodes	integer[] (int32)		Kode keluar yang valid untuk skrip PowerShell. [Default: 0]

ImageTemplatePowerShellValidator

Objek

Menjalankan skrip PowerShell yang ditentukan selama fase validasi (Windows). Sesuai dengan penyedia powershell Packer. Tepat salah satu 'scriptUri' atau 'inline' dapat ditentukan.

Nama	Jenis	Nilai default	Deskripsi
inline	string[]		Array perintah PowerShell untuk dijalankan
name	string		Nama yang Mudah Diingat untuk memberikan konteks tentang apa yang dilakukan langkah validasi ini
runAsSystem	boolean	False	Jika ditentukan, skrip PowerShell akan dijalankan dengan hak istimewa yang ditingkatkan menggunakan pengguna Sistem Lokal. Hanya dapat benar ketika bidang runElevated di atas diatur ke true.
runElevated	boolean	False	Jika ditentukan, skrip PowerShell akan dijalankan dengan hak istimewa yang ditingkatkan
scriptUri	string		URI skrip PowerShell yang akan dijalankan untuk validasi. Ini bisa menjadi tautan github, URI Azure Storage, dll
sha256Checksum	string		Checksum SHA256 dari skrip shell daya yang disediakan di bidang scriptUri di atas
type	string: PowerShell		Jenis validasi yang ingin Anda gunakan pada Gambar. Misalnya, "Shell" bisa menjadi validasi shell
validExitCodes	integer[] (int32)		Kode keluar yang valid untuk skrip PowerShell. [Default: 0]

ImageTemplateRestartCustomizer

Objek

Reboot VM dan menunggunya kembali online (Windows). Sesuai dengan penyedia windows-restart Packer

Nama	Jenis	Deskripsi
name	string	Nama yang Mudah Diingat untuk memberikan konteks tentang apa yang dilakukan langkah penyesuaian ini
restartCheckCommand	string	Perintah untuk memeriksa apakah hidupkan ulang berhasil [Default: '']
restartCommand	string	Perintah untuk menjalankan restart [Default: 'shutdown /r /f /t 0 /c "packer restart"']
restartTimeout	string	Waktu habis hidupkan ulang yang ditentukan sebagai string besaran dan unit, misalnya '5m' (5 menit) atau '2 jam' (2 jam) [Default: '5m']
type	string: WindowsRestart	Jenis alat kustomisasi yang ingin Anda gunakan pada Gambar. Misalnya, "Shell" bisa menjadi penyesuai shell

ImageTemplateSharedImageDistributor

Objek

Distribusikan melalui Azure Compute Gallery.

Nama	Jenis	Nilai default	Deskripsi
artifactTags	object		Tag yang akan diterapkan ke artefak setelah dibuat/diperbarui oleh distributor.
excludeFromLatest	boolean	False	Bendera yang menunjukkan apakah versi gambar yang dibuat harus dikecualikan dari yang terbaru. Hilangkan untuk menggunakan default (false).
galleryImageId	string		Id Sumber Daya gambar Azure Compute Gallery
replicationRegions	string[]		[Tidak digunakan lagi] Daftar wilayah tempat gambar akan direplikasi. Daftar ini hanya dapat ditentukan jika targetRegions tidak ditentukan. Bidang ini tidak digunakan lagi - gunakan targetRegions sebagai gantinya.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		Nama yang akan digunakan untuk RunOutput terkait.
storageAccountType	SharedImageStorageAccountType		[Tidak digunakan lagi] Jenis akun penyimpanan yang akan digunakan untuk menyimpan gambar bersama. Hilangkan untuk menggunakan default (Standard_LRS). Bidang ini hanya dapat ditentukan jika replikasiRegions ditentukan. Bidang ini tidak digunakan lagi - gunakan targetRegions sebagai gantinya.
targetRegions	TargetRegion[]		Wilayah target tempat Versi Gambar terdistribusi akan direplikasi. Objek ini menggantikan replikasiRegions dan hanya dapat ditentukan jika replikasiRegions tidak ditentukan.
type	string: SharedImage		Jenis distribusi.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Menjelaskan cara menghasilkan nomor versi x.y.z baru untuk distribusi.

ImageTemplateSharedImageVersionSource

Objek

Menjelaskan sumber gambar yang merupakan versi gambar di Azure Compute Gallery atau Direct Shared Gallery.

Nama	Jenis	Deskripsi
exactVersion	string	Id sumber daya ARM yang tepat dari versi gambar. Bidang readonly ini berbeda dari Id versi gambar di 'imageVersionId' hanya jika nama versi yang ditentukan di bidang 'imageVersionId' adalah 'terbaru'.
imageVersionId	string	Id sumber daya ARM dari versi gambar. Ketika nama versi gambar adalah 'terbaru', versi dievaluasi saat build gambar berlangsung.
type	string: SharedImageVersion	Menentukan jenis gambar sumber yang ingin Anda mulai.

ImageTemplateShellCustomizer

Objek

Menjalankan skrip shell selama fase kustomisasi (Linux). Sesuai dengan provisi shell Packer. Tepat salah satu 'scriptUri' atau 'inline' dapat ditentukan.

Nama	Jenis	Deskripsi
inline	string[]	Array perintah shell untuk dijalankan
name	string	Nama yang Mudah Diingat untuk memberikan konteks tentang apa yang dilakukan langkah penyesuaian ini
scriptUri	string	URI skrip shell yang akan dijalankan untuk penyesuaian. Ini bisa menjadi tautan github, SAS URI untuk Azure Storage, dll
sha256Checksum	string	Checksum SHA256 dari skrip shell yang disediakan di bidang scriptUri
type	string: Shell	Jenis alat kustomisasi yang ingin Anda gunakan pada Gambar. Misalnya, "Shell" bisa menjadi penyesuai shell

ImageTemplateShellValidator

Objek

Menjalankan skrip shell yang ditentukan selama fase validasi (Linux). Sesuai dengan provisi shell Packer. Tepat salah satu 'scriptUri' atau 'inline' dapat ditentukan.

Nama	Jenis	Deskripsi
inline	string[]	Array perintah shell untuk dijalankan
name	string	Nama yang Mudah Diingat untuk memberikan konteks tentang apa yang dilakukan langkah validasi ini
scriptUri	string	URI skrip shell yang akan dijalankan untuk validasi. Ini bisa menjadi tautan github, URI Azure Storage, dll
sha256Checksum	string	Checksum SHA256 dari skrip shell yang disediakan di bidang scriptUri
type	string: Shell	Jenis validasi yang ingin Anda gunakan pada Gambar. Misalnya, "Shell" bisa menjadi validasi shell

ImageTemplateVhdDistributor

Objek

Distribusikan melalui VHD di akun penyimpanan.

Nama	Jenis	Deskripsi
artifactTags	object	Tag yang akan diterapkan ke artefak setelah dibuat/diperbarui oleh distributor.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nama yang akan digunakan untuk RunOutput terkait.
type	string: VHD	Jenis distribusi.
uri	string	URI Azure Storage opsional untuk blob VHD terdistribusi. Hilangkan untuk menggunakan default (string kosong) dalam hal ini VHD akan diterbitkan ke akun penyimpanan di grup sumber daya penahapan.

ImageTemplateVmProfile

Objek

Menjelaskan komputer virtual yang digunakan untuk membangun dan memvalidasi gambar

Nama	Jenis	Nilai default	Deskripsi
osDiskSizeGB	integer (int32) minimum: 0	0	Ukuran disk OS dalam GB. Hilangkan atau tentukan 0 untuk menggunakan ukuran disk OS default Azure.
userAssignedIdentities	string[]		Array opsional ID sumber daya identitas terkelola yang ditetapkan pengguna untuk dikonfigurasi pada VM build dan VM validasi. Ini mungkin termasuk identitas templat gambar.
vmSize	string		Ukuran komputer virtual yang digunakan untuk membangun, menyesuaikan, dan mengambil gambar. Hilangkan atau tentukan string kosong untuk menggunakan default (Standard_D1_v2 untuk gambar Gen1 dan Standard_D2ds_v4 untuk gambar Gen2).
vnetConfig	VirtualNetworkConfig		Konfigurasi opsional jaringan virtual yang akan digunakan untuk menyebarkan VM build dan VM validasi. Hilangkan jika tidak ada jaringan virtual tertentu yang perlu digunakan.

ImageTemplateWindowsUpdateCustomizer

Objek

Menginstal Windows Updates. Sesuai dengan Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Nama	Jenis	Nilai default	Deskripsi
filters	string[]		Array filter untuk memilih pembaruan yang akan diterapkan. Hilangkan atau tentukan array kosong untuk menggunakan default (tanpa filter). Lihat tautan di atas untuk contoh dan deskripsi terperinci dari bidang ini.
name	string		Nama yang Mudah Diingat untuk memberikan konteks tentang apa yang dilakukan langkah penyesuaian ini
searchCriteria	string		Kriteria untuk mencari pembaruan. Hilangkan atau tentukan string kosong untuk menggunakan default (cari semua). Lihat tautan di atas untuk contoh dan deskripsi terperinci dari bidang ini.
type	string: WindowsUpdate		Jenis alat kustomisasi yang ingin Anda gunakan pada Gambar. Misalnya, "Shell" bisa menjadi penyesuai shell
updateLimit	integer (int32) minimum: 0	0	Jumlah maksimum pembaruan yang akan diterapkan pada satu waktu. Hilangkan atau tentukan 0 untuk menggunakan default (1000)

Optimize

Objek

Menentukan pengoptimalan yang akan dilakukan pada gambar.

Nama	Jenis	Deskripsi
vmBoot	VmBoot	Pengoptimalan diterapkan pada gambar untuk boot VM yang lebih cepat.

PlatformImagePurchasePlan

Objek

Konfigurasi paket pembelian untuk gambar platform.

Nama	Jenis	Deskripsi
planName	string	Nama paket pembelian.
planProduct	string	Produk dari paket pembelian.
planPublisher	string	Penerbit paket pembelian.

ProvisioningError

Objek

Menjelaskan kesalahan yang terjadi saat membuat atau memperbarui templat gambar

Nama	Jenis	Deskripsi
message	string	Pesan kesalahan verbose tentang kegagalan provisi
provisioningErrorCode	ProvisioningErrorCode	Kode kesalahan kegagalan provisi

ProvisioningErrorCode

Enumeration

Kode kesalahan kegagalan provisi

Nilai	Deskripsi
BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Other

ProvisioningState

Enumeration

Status provisi sumber daya

Nilai	Deskripsi
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Enumeration

Jenis identitas yang digunakan untuk templat gambar. Jenis 'None' akan menghapus identitas apa pun dari templat gambar.

Nilai	Deskripsi
UserAssigned
None

RunState

Enumeration

Status eksekusi terakhir

Nilai	Deskripsi
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Enumeration

Sub-status eksekusi terakhir

Nilai	Deskripsi
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Enumeration

Menentukan jenis akun penyimpanan yang akan digunakan untuk menyimpan versi gambar Azure Compute Gallery.

Nilai	Deskripsi
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

TargetRegion

Objek

Menjelaskan informasi wilayah target.

Nama	Jenis	Nilai default	Deskripsi
name	string		Nama wilayah.
replicaCount	integer (int32) minimum: 1	1	Jumlah replika Versi Gambar yang akan dibuat di wilayah ini. Hilangkan untuk menggunakan default (1).
storageAccountType	SharedImageStorageAccountType		Menentukan jenis akun penyimpanan yang akan digunakan untuk menyimpan gambar di wilayah ini. Hilangkan untuk menggunakan default (Standard_LRS).

UserAssignedIdentity

Objek

Properti identitas yang ditetapkan pengguna

Nama	Jenis	Deskripsi
clientId	string	ID klien dari identitas yang ditetapkan.
principalId	string	ID utama identitas yang ditetapkan.

Validate

Objek

Opsi konfigurasi dan daftar validasi yang akan dilakukan pada gambar yang dihasilkan.

Nama	Jenis	Nilai default	Deskripsi
continueDistributeOnFailure	boolean	False	Jika validasi gagal dan bidang ini diatur ke false, gambar output tidak akan didistribusikan. Ini adalah perilaku default. Jika validasi gagal dan bidang ini diatur ke true, gambar output masih akan didistribusikan. Harap gunakan opsi ini dengan hati-hati karena dapat mengakibatkan citra buruk didistribusikan untuk digunakan. Dalam kedua kasus (benar atau salah), eksekusi gambar ujung ke ujung akan dilaporkan gagal jika terjadi kegagalan validasi. [Catatan: Bidang ini tidak berpengaruh jika validasi berhasil.]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Daftar validasi yang akan dilakukan.
sourceValidationOnly	boolean	False	Jika bidang ini diatur ke true, gambar yang ditentukan di bagian 'sumber' akan langsung divalidasi. Tidak ada build terpisah yang akan dijalankan untuk dihasilkan lalu memvalidasi gambar yang disesuaikan.

VirtualNetworkConfig

Objek

Konfigurasi Virtual Network.

Nama	Jenis	Deskripsi
proxyVmSize	string	Ukuran komputer virtual proksi yang digunakan untuk meneruskan lalu lintas ke VM build dan VM validasi. Hilangkan atau tentukan string kosong untuk menggunakan default (Standard_A1_v2).
subnetId	string	Id sumber daya subnet yang sudah ada sebelumnya.

VmBoot

Objek

Pengoptimalan diterapkan pada gambar untuk boot VM yang lebih cepat.

Nama	Jenis	Deskripsi
state	VMBootOptimizationState	Mengaktifkan bidang ini akan meningkatkan waktu boot VM dengan mengoptimalkan output gambar akhir yang disesuaikan.

VMBootOptimizationState

Enumeration

Mengaktifkan bidang ini akan meningkatkan waktu boot VM dengan mengoptimalkan output gambar akhir yang disesuaikan.

Nilai	Deskripsi
Enabled
Disabled

Bagikan melalui

Virtual Machine Image Templates - Get

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

Retrieve an Image Template.

Permintaan sampel

Respon sampel

Definisi

CloudError

CloudErrorBody

createdByType

DistributeVersionerLatest

DistributeVersionerSource

ImageTemplate

ImageTemplateFileCustomizer

ImageTemplateFileValidator

ImageTemplateIdentity

ImageTemplateLastRunStatus

ImageTemplateManagedImageDistributor

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplatePowerShellCustomizer

ImageTemplatePowerShellValidator

ImageTemplateRestartCustomizer

ImageTemplateSharedImageDistributor

ImageTemplateSharedImageVersionSource

ImageTemplateShellCustomizer

ImageTemplateShellValidator

ImageTemplateVhdDistributor

ImageTemplateVmProfile

ImageTemplateWindowsUpdateCustomizer

Optimize

PlatformImagePurchasePlan

ProvisioningError

ProvisioningErrorCode

ProvisioningState

ResourceIdentityType

RunState

RunSubState

SharedImageStorageAccountType

systemData

TargetRegion

UserAssignedIdentity

Validate

VirtualNetworkConfig

VmBoot

VMBootOptimizationState