ImageTemplate interface
映像範本是由 Microsoft.VirtualMachineImages 提供者管理的 ARM 資源
- Extends
屬性
| auto |
指出是否要在範本建立或更新時自動執行映像範本組建。 |
| build |
建置映像範本時要等候的最大持續時間（包括所有自定義專案、優化、驗證和散發套件）。 省略或指定 0 以使用預設值 （4 小時）。 |
| customize | 指定用來描述映像自定義步驟的屬性，例如影像來源等 |
| distribute | 影像輸出需要前往的散發目標。 |
| error |
建置失敗時的錯誤處理選項 |
| exact |
與用來建置映像之映像範本相同訂用帳戶中的預備資源群組標識碼。 只有當 'stagingResourceGroup' 字段中指定的值是空的時，這個只讀字段才會與 'stagingResourceGroup' 不同。 注意：這個屬性不會串行化。 它只能由伺服器填入。 |
| identity | 如果已設定，則為映像範本的身分識別。 |
| last |
目前正在執行或上次執行的 『run』 狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。 |
| managed |
將套用至服務所建立之資源群組和/或資源的標記。 |
| optimize | 指定要在映像上執行的優化。 |
| provisioning |
布建錯誤，如果有注意：此屬性將不會串行化。 它只能由伺服器填入。 |
| provisioning |
資源布建狀態注意：此屬性將不會串行化。 它只能由伺服器填入。 |
| source | 指定用來描述來源影像的屬性。 |
| staging |
與用來建置映像之映像範本相同訂用帳戶中的預備資源群組標識碼。 如果此欄位是空的，將會建立具有隨機名稱的資源群組。 如果此欄位中指定的資源群組不存在，則會以相同的名稱建立。 如果指定的資源群組存在，它必須是空的，且位於與映像範本相同的區域中。 如果此欄位是空的，或指定的資源群組不存在，則會在範本刪除期間刪除建立的資源群組，但如果指定的資源群組存在，則會在範本刪除期間刪除資源群組，而且資源群組本身將會保留。 |
| validate | 要對產生的映像執行的組態選項和驗證清單。 |
| vm |
描述虛擬機如何設定以建置映像 |
繼承的屬性
| id | 資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此屬性將不會串行化。 它只能由伺服器填入。 |
| location | 資源所在的地理位置 |
| name | 資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。 |
| system |
包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。 |
| tags | 資源標籤。 |
| type | 資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。 |
屬性詳細資料
autoRun
buildTimeoutInMinutes
建置映像範本時要等候的最大持續時間（包括所有自定義專案、優化、驗證和散發套件）。 省略或指定 0 以使用預設值 （4 小時）。
buildTimeoutInMinutes?: number屬性值
number
customize
指定用來描述映像自定義步驟的屬性，例如影像來源等
customize?: ImageTemplateCustomizerUnion[]屬性值
distribute
errorHandling
建置失敗時的錯誤處理選項
errorHandling?: ImageTemplatePropertiesErrorHandling屬性值
exactStagingResourceGroup
與用來建置映像之映像範本相同訂用帳戶中的預備資源群組標識碼。 只有當 'stagingResourceGroup' 字段中指定的值是空的時，這個只讀字段才會與 'stagingResourceGroup' 不同。 注意：這個屬性不會串行化。 它只能由伺服器填入。
exactStagingResourceGroup?: string屬性值
string
identity
lastRunStatus
目前正在執行或上次執行的 『run』 狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
lastRunStatus?: ImageTemplateLastRunStatus屬性值
managedResourceTags
將套用至服務所建立之資源群組和/或資源的標記。
managedResourceTags?: {[propertyName: string]: string}屬性值
{[propertyName: string]: string}
optimize
provisioningError
provisioningState
source
stagingResourceGroup
與用來建置映像之映像範本相同訂用帳戶中的預備資源群組標識碼。 如果此欄位是空的，將會建立具有隨機名稱的資源群組。 如果此欄位中指定的資源群組不存在，則會以相同的名稱建立。 如果指定的資源群組存在，它必須是空的，且位於與映像範本相同的區域中。 如果此欄位是空的，或指定的資源群組不存在，則會在範本刪除期間刪除建立的資源群組，但如果指定的資源群組存在，則會在範本刪除期間刪除資源群組，而且資源群組本身將會保留。
stagingResourceGroup?: string屬性值
string
validate
vmProfile
繼承的屬性詳細資料
id
資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此屬性將不會串行化。 它只能由伺服器填入。
id?: string屬性值
string
location
name
systemData
包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
systemData?: SystemData屬性值
tags
資源標籤。
tags?: {[propertyName: string]: string}屬性值
{[propertyName: string]: string}
type
資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。
type?: string屬性值
string