@azure/arm-imagebuilder package
Kelas
| ImageBuilderClient |
Antarmuka
| DataDisk |
Properti disk data. |
| DistributeVersioner |
Menjelaskan cara menghasilkan nomor versi x.y.z baru untuk distribusi. |
| DistributeVersionerLatest |
Menghasilkan nomor versi yang akan terbaru berdasarkan nomor versi yang ada. |
| DistributeVersionerSource |
Menghasilkan nomor versi berdasarkan nomor versi gambar sumber |
| ErrorAdditionalInfo |
Info tambahan kesalahan manajemen sumber daya. |
| ErrorDetail |
Detail kesalahan. |
| ErrorResponse |
Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. |
| ImageBuilderClientOptionalParams |
Parameter opsional untuk klien. |
| ImageTemplate |
Templat gambar adalah sumber daya ARM yang dikelola oleh penyedia Microsoft.VirtualMachineImages |
| ImageTemplateAutoRun |
Menunjukkan apakah templat gambar perlu dibuat berdasarkan buat/perbarui |
| ImageTemplateCustomizer |
Menjelaskan satuan kustomisasi gambar |
| ImageTemplateDistributor |
Objek distribusi generik |
| 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. |
| ImageTemplateInVMValidator |
Menjelaskan unit validasi gambar in-VM |
| 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. |
| ImageTemplateProperties |
Menjelaskan properti templat gambar |
| ImageTemplatePropertiesErrorHandling |
Opsi penanganan kesalahan setelah kegagalan build |
| ImageTemplatePropertiesOptimize |
Menentukan pengoptimalan yang akan dilakukan pada gambar. |
| ImageTemplatePropertiesOptimizeVmBoot |
Pengoptimalan diterapkan pada gambar untuk boot VM yang lebih cepat. |
| ImageTemplatePropertiesOptimizeWorkload |
Pengoptimalan diterapkan pada gambar untuk beban kerja tertentu. |
| ImageTemplatePropertiesValidate |
Opsi konfigurasi dan daftar validasi yang akan dilakukan pada gambar yang dihasilkan. |
| 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. |
| ImageTemplateSource |
Menjelaskan sumber gambar komputer virtual untuk membangun, menyesuaikan, dan mendistribusikan |
| ImageTemplateUpdateParameters |
Parameter untuk memperbarui templat gambar. |
| ImageTemplateUpdateParametersProperties |
Parameter untuk memperbarui templat gambar. |
| 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) |
| Operation |
Operasi REST API |
| OperationDisplay |
Objek yang menjelaskan operasi. |
| OperationsListOptionalParams |
Parameter opsional. |
| OperationsOperations |
Antarmuka yang mewakili operasi Operasi. |
| PageSettings |
Opsi untuk metode byPage |
| PagedAsyncIterableIterator |
Antarmuka yang memungkinkan iterasi yang dapat diulang asinkron baik ke penyelesaian maupun berdasarkan halaman. |
| PlatformImagePurchasePlan |
Konfigurasi paket pembelian untuk gambar platform. |
| ProvisioningError |
Menjelaskan kesalahan yang terjadi saat membuat atau memperbarui templat gambar |
| ProxyResource |
Definisi model sumber daya untuk sumber daya proksi Azure Resource Manager. Ini tidak akan memiliki tag dan lokasi |
| Resource |
Bidang umum yang dikembalikan dalam respons untuk semua sumber daya Azure Resource Manager |
| RestorePollerOptions | |
| RunOutput |
Mewakili output yang dibuat dengan menjalankan templat gambar. |
| RunOutputProperties |
Menjelaskan properti output eksekusi |
| SimplePollerLike |
Poller sederhana yang dapat digunakan untuk melakukan polling operasi jangka panjang. |
| SourceImageTriggerProperties |
Properti pemicu jenis SourceImage |
| SystemData |
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya. |
| TargetRegion |
Menjelaskan informasi wilayah target. |
| TrackedResource |
Definisi model sumber daya untuk Sumber Daya Azure Resource Manager melacak sumber daya tingkat atas yang memiliki 'tag' dan 'lokasi' |
| Trigger |
Mewakili pemicu yang dapat memanggil build templat gambar. |
| TriggerProperties |
Menjelaskan properti pemicu |
| TriggerStatus |
Menjelaskan status pemicu |
| TriggersCreateOrUpdateOptionalParams |
Parameter opsional. |
| TriggersDeleteOptionalParams |
Parameter opsional. |
| TriggersGetOptionalParams |
Parameter opsional. |
| TriggersListByImageTemplateOptionalParams |
Parameter opsional. |
| TriggersOperations |
Antarmuka yang mewakili operasi Pemicu. |
| UserAssignedIdentity |
Properti identitas yang ditetapkan pengguna |
| VirtualMachineImageTemplatesCancelOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesCreateOrUpdateOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesDeleteOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesGetOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesGetRunOutputOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesListByResourceGroupOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesListOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesListRunOutputsOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesOperations |
Antarmuka yang mewakili operasi VirtualMachineImageTemplates. |
| VirtualMachineImageTemplatesRunOptionalParams |
Parameter opsional. |
| VirtualMachineImageTemplatesUpdateOptionalParams |
Parameter opsional. |
| VirtualNetworkConfig |
Konfigurasi Virtual Network. |
Alias Jenis
| AutoRunState |
Mengaktifkan bidang ini akan memicu build otomatis pada pembuatan atau pembaruan templat gambar. |
| AzureSupportedClouds |
Nilai yang didukung untuk pengaturan cloud sebagai jenis literal string |
| ContinuablePage |
Antarmuka yang menjelaskan halaman hasil. |
| CreatedByType |
Jenis entitas yang membuat sumber daya. Nilai yang diketahui didukung oleh layanan
Pengguna : Entitas dibuat oleh pengguna. |
| DistributeVersionerUnion |
Alias untuk DistributeVersionerUnion |
| ImageTemplateCustomizerUnion |
Alias untuk ImageTemplateCustomizerUnion |
| ImageTemplateDistributorUnion |
Alias untuk ImageTemplateDistributorUnion |
| ImageTemplateInVMValidatorUnion |
Alias untuk ImageTemplateInVMValidatorUnion |
| ImageTemplateSourceUnion |
Alias untuk ImageTemplateSourceUnion |
| OnBuildError |
Perilaku penanganan kesalahan saat kegagalan build Nilai yang diketahui didukung oleh layanan
Pembersihan: Pembersihan |
| ProvisioningErrorCode |
Kode kesalahan kegagalan provisi Nilai yang diketahui didukung oleh layanan
BadSourceType: BadSourceType |
| ProvisioningState |
Status provisi sumber daya |
| ReplicationMode |
Menjelaskan mode replikasi untuk distribusi di Azure Compute Gallery. Hilangkan untuk menggunakan default (Penuh). Nilai yang diketahui didukung oleh layanan
Penuh: Mode replikasi penuh |
| ResourceIdentityType |
Jenis identitas yang digunakan untuk templat gambar. Jenis 'None' akan menghapus identitas apa pun dari templat gambar. |
| RunState |
Keadaan lari terakhir |
| RunSubState |
Sub-status dari eksekusi terakhir |
| SharedImageStorageAccountType |
Menentukan jenis akun penyimpanan yang akan digunakan untuk menyimpan versi gambar Azure Compute Gallery. Nilai yang diketahui didukung oleh layanan
Standard_LRS: Standard_LRS |
| TriggerPropertiesUnion |
Alias untuk TriggerPropertiesUnion |
| VMBootOptimizationState |
Mengaktifkan bidang ini akan meningkatkan waktu boot VM dengan mengoptimalkan output gambar akhir yang disesuaikan. |
| WorkloadOptimizationState |
Mengaktifkan bidang ini akan mengoptimalkan gambar vm untuk beban kerja tertentu. |
Enum
| AzureClouds |
Enum untuk mendeskripsikan lingkungan Azure Cloud. |
| KnownCreatedByType |
Jenis entitas yang membuat sumber daya. |
| KnownOnBuildError |
Perilaku penanganan kesalahan saat kegagalan build |
| KnownProvisioningErrorCode |
Kode kesalahan kegagalan provisi |
| KnownReplicationMode |
Menjelaskan mode replikasi untuk distribusi di Azure Compute Gallery. Hilangkan untuk menggunakan default (Penuh). |
| KnownSharedImageStorageAccountType |
Menentukan jenis akun penyimpanan yang akan digunakan untuk menyimpan versi gambar Azure Compute Gallery. |
| KnownVersions |
Versi API yang tersedia. |
Fungsi
| is |
Typeguard untuk RestError |
| restore |
Membuat poller dari status serialisasi poller lain. Ini dapat berguna ketika Anda ingin membuat poller di host yang berbeda atau poller perlu dibuat setelah poller asli tidak dalam cakupan. |
Variabel
| Rest |
Jenis kesalahan kustom untuk permintaan alur yang gagal. |
Detail Fungsi
isRestError(unknown)
Typeguard untuk RestError
function isRestError(e: unknown): e
Parameter
- e
-
unknown
Sesuatu tertangkap oleh klausul tangkapan.
Mengembalikan
e
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Membuat poller dari status serialisasi poller lain. Ini dapat berguna ketika Anda ingin membuat poller di host yang berbeda atau poller perlu dibuat setelah poller asli tidak dalam cakupan.
function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameter
- client
- ImageBuilderClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Mengembalikan
PollerLike<OperationState<TResult>, TResult>
Detail Variabel
RestError
Jenis kesalahan kustom untuk permintaan alur yang gagal.
RestError: RestErrorConstructor