@azure/arm-imagebuilder package

類別

介面

DataDisk	資料磁碟的特性。
DistributeVersioner	描述如何為散發產生新的 x.y.z 版本號碼。
DistributeVersionerLatest	產生以現有版本號碼為基礎的版本號碼。
DistributeVersionerSource	根據來源映像的版本號碼產生版本號碼
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。
ImageBuilderClientOptionalParams	用戶端的選擇性參數。
ImageTemplate	映像範本是由 Microsoft.VirtualMachineImages 提供者管理的 ARM 資源
ImageTemplateAutoRun	指出映像範本是否需要建置在建立/更新上
ImageTemplateCustomizer	描述映像自定義的單位
ImageTemplateDistributor	泛型散發物件
ImageTemplateFileCustomizer	將檔案上傳至 VM（Linux、Windows）。對應至 Packer 檔案布建工具
ImageTemplateFileValidator	將驗證所需的檔案上傳至 VM（Linux、Windows）。對應至 Packer 檔案布建工具
ImageTemplateIdentity	映像範本的身分識別。
ImageTemplateInVMValidator	描述影像 in-VM 驗證的單位
ImageTemplateLastRunStatus	描述執行映像範本的最新狀態
ImageTemplateManagedImageDistributor	散發為受控磁碟映像。
ImageTemplateManagedImageSource	描述客戶訂用帳戶中受控映像的映像來源。此映像必須與 Image Builder 範本位於相同的訂用帳戶和區域中。
ImageTemplatePlatformImageSource	描述來自 Azure 資源庫映像的映射來源。
ImageTemplatePowerShellCustomizer	在 VM 上執行指定的 PowerShell（Windows）。對應至 Packer powershell 布建器。您可以指定 'scriptUri' 或 'inline' 的其中一個。
ImageTemplatePowerShellValidator	在驗證階段（Windows）期間執行指定的 PowerShell 腳本。對應至 Packer powershell 布建器。您可以指定 'scriptUri' 或 'inline' 的其中一個。
ImageTemplateProperties	描述影像範本的特性
ImageTemplatePropertiesErrorHandling	建置失敗時的錯誤處理選項
ImageTemplatePropertiesOptimize	指定要在映像上執行的優化。
ImageTemplatePropertiesOptimizeVmBoot	優化會在映像上套用，以加快 VM 開機速度。
ImageTemplatePropertiesOptimizeWorkload	針對特定工作負載，會對影像進行優化。
ImageTemplatePropertiesValidate	要對產生的映像執行的組態選項和驗證清單。
ImageTemplateRestartCustomizer	重新啟動 VM，並等候它重新上線（Windows）。對應至 Packer windows-restart 布建器
ImageTemplateSharedImageDistributor	透過 Azure 計算資源庫散發。
ImageTemplateSharedImageVersionSource	描述 Azure 計算資源庫或直接共用資源庫中映像版本的映射來源。
ImageTemplateShellCustomizer	在自定義階段（Linux）期間執行殼層腳本。對應至 Packer 殼層布建器。您可以指定 'scriptUri' 或 'inline' 的其中一個。
ImageTemplateShellValidator	在驗證階段（Linux）期間執行指定的殼層腳本。對應至 Packer 殼層布建器。您可以指定 'scriptUri' 或 'inline' 的其中一個。
ImageTemplateSource	描述用來建置、自定義和散發的虛擬機映像來源
ImageTemplateUpdateParameters	更新映像範本的參數。
ImageTemplateUpdateParametersProperties	更新映像範本的參數。
ImageTemplateVhdDistributor	透過記憶體帳戶中的 VHD 散發。
ImageTemplateVmProfile	描述用來建置和驗證映像的虛擬機
ImageTemplateWindowsUpdateCustomizer	安裝 Windows 更新。對應至 Packer Windows Update Provisioner （https://github.com/rgl/packer-provisioner-windows-update）
Operation	REST API 作業
OperationDisplay	描述作業的物件。
OperationsListOptionalParams	選擇性參數。
OperationsOperations	代表作業作業的介面。
PageSettings	byPage 方法的選項
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
PlatformImagePurchasePlan	平臺映像的購買方案組態。
ProvisioningError	描述建立或更新映像範本時發生的錯誤
ProxyResource	Azure Resource Manager Proxy 資源的資源模型定義。它不會有標記和位置
Resource	回應中針對所有 Azure Resource Manager 資源傳回的常見欄位
RestorePollerOptions
RunOutput	表示執行映像範本所建立的輸出。
RunOutputProperties	描述執行輸出的性質
SimplePollerLike	簡單的輪詢器，可用來輪詢長時間執行的作業。
SourceImageTriggerProperties	SourceImage 類型的觸發程序屬性
SystemData	與建立和上次修改資源相關的元數據。
TargetRegion	描述目標區域資訊。
TrackedResource	Azure Resource Manager 的資源模型定義已追蹤最上層資源，其具有「標記」和「位置」
Trigger	表示可以叫用映像範本組建的觸發程式。
TriggerProperties	描述觸發程序的屬性
TriggerStatus	描述觸發程序的狀態
TriggersCreateOrUpdateOptionalParams	選擇性參數。
TriggersDeleteOptionalParams	選擇性參數。
TriggersGetOptionalParams	選擇性參數。
TriggersListByImageTemplateOptionalParams	選擇性參數。
TriggersOperations	介面代表一個觸發操作。
UserAssignedIdentity	使用者指派的身分識別屬性
VirtualMachineImageTemplatesCancelOptionalParams	選擇性參數。
VirtualMachineImageTemplatesCreateOrUpdateOptionalParams	選擇性參數。
VirtualMachineImageTemplatesDeleteOptionalParams	選擇性參數。
VirtualMachineImageTemplatesGetOptionalParams	選擇性參數。
VirtualMachineImageTemplatesGetRunOutputOptionalParams	選擇性參數。
VirtualMachineImageTemplatesListByResourceGroupOptionalParams	選擇性參數。
VirtualMachineImageTemplatesListOptionalParams	選擇性參數。
VirtualMachineImageTemplatesListRunOutputsOptionalParams	選擇性參數。
VirtualMachineImageTemplatesOperations	介面代表 VirtualMachineImageTemplates 操作。
VirtualMachineImageTemplatesRunOptionalParams	選擇性參數。
VirtualMachineImageTemplatesUpdateOptionalParams	選擇性參數。
VirtualNetworkConfig	虛擬網路組態。

類型別名

AutoRunState	啟用此欄位將會在映像範本建立或更新時觸發自動建置。
AzureSupportedClouds	雲端設定為字串常值類型的支援值
ContinuablePage	描述結果頁面的介面。
CreatedByType	建立資源的實體種類。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。服務支援的已知值使用者：實體是由使用者建立的。應用程式：實體是由應用程式所建立。 ManagedIdentity：實體是由受控識別所建立。金鑰：實體是由金鑰所建立。
DistributeVersionerUnion	DistributeVersionerUnion 的別名
ImageTemplateCustomizerUnion	Alias for ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion	ImageTemplateDistributorUnion 的別名
ImageTemplateInVMValidatorUnion	Alias for ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion	ImageTemplateSourceUnion 的別名
OnBuildError	建置失敗時的錯誤處理行為 KnownOnBuildError 可以與 OnBuildError 交換使用，此列舉包含服務支援的已知值。服務支援的已知值清理：清理中止：中止
ProvisioningErrorCode	配置失敗的錯誤代碼 KnownProvisioningErrorCode 可以與 ProvisioningErrorCode 交換使用，此列舉包含服務支援的已知值。服務支援的已知值 BadSourceType：BadSourceType BadPIRSource：BadPIRSource BadManagedImageSource：BadManagedImageSource BadSharedImage版本來源：BadSharedImageVersionSource 壞自訂類型：壞壞自訂類型 UnsupportedCustomizerType： UnsupportedCustomizerType NoCustomizerScript： NoCustomizerScript BadValidatorType： BadValidatorType UnsupportedValidatorType： UnsupportedValidatorType NoValidatorScript：NoValidatorScript BadDistributionType：BadDistributionType 壞 BadSharedImageDistribution：BadSharedImageDistribution BadStagingResourceGroup：BadStagingResourceGroup ServerError：ServerError 其他：其他
ProvisioningState	資源的布建狀態
ReplicationMode	描述 Azure Compute Gallery 中分發的複製模式。避免使用預設（完整版）。 KnownReplicationMode 可以與 ReplicationMode 交換使用，此列舉包含服務支援的已知值。服務支援的已知值完整：完整複製模式淺層：淺層複製模式
ResourceIdentityType	用於映像範本的身分識別類型。類型『None』會從映像範本中移除任何身分識別。
RunState	上次演出的狀況
RunSubState	上次運行的子國家
SharedImageStorageAccountType	指定用於存放 Azure Compute Gallery 映像版本的儲存帳號類型。 KnownSharedImageStorageAccountType 可以與 SharedImageStorageAccountType 交換使用，此列舉包含服務支援的已知值。服務支援的已知值 Standard_LRS：Standard_LRS Standard_ZRS：Standard_ZRS Premium_LRS：Premium_LRS
TriggerPropertiesUnion	TriggerPropertiesUnion 的別名
VMBootOptimizationState	啟用此欄位可藉由優化最終自定義映像輸出來改善 VM 開機時間。
WorkloadOptimizationState	啟用此欄位將優化虛擬機映像以符合特定工作負載。

列舉

AzureClouds	一個用來描述 Azure Cloud 環境的 enum。
KnownCreatedByType	建立資源的實體種類。
KnownOnBuildError	建置失敗時的錯誤處理行為
KnownProvisioningErrorCode	配置失敗的錯誤代碼
KnownReplicationMode	描述 Azure Compute Gallery 中分發的複製模式。避免使用預設（完整版）。
KnownSharedImageStorageAccountType	指定用於存放 Azure Compute Gallery 映像版本的儲存帳號類型。
KnownVersions	可用的 API 版本。

函式

isRestError(unknown)	RestError 的 Typeguard
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	從另一個輪詢器的序列化狀態建立輪詢器。當您想要在不同的主機上建立輪詢器，或需要在原始輪詢器不在範圍內之後建構輪詢器時，這會很有用。

變數

RestError

失敗管線要求的自定義錯誤類型。

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

參數

e: unknown

catch 子句攔截到的東西。

傳回

e

restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

從另一個輪詢器的序列化狀態建立輪詢器。當您想要在不同的主機上建立輪詢器，或需要在原始輪詢器不在範圍內之後建構輪詢器時，這會很有用。

function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

參數

client: ImageBuilderClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

傳回

PollerLike<OperationState<TResult>, TResult>

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型

RestErrorConstructor

@azure/arm-imagebuilder package

類別

介面

類型別名

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

服務支援的已知值

列舉

函式

變數

函式詳細資料

isRestError(unknown)

參數

傳回

restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

參數

傳回

變數詳細資料

RestError

類型