ImageTemplate interface
イメージ テンプレートは、Microsoft.VirtualMachineImages プロバイダーによって管理される ARM リソースです
- Extends
プロパティ
auto |
テンプレートの作成または更新時にイメージ テンプレート ビルドを自動的に実行するかどうかを示します。 |
build |
イメージ テンプレートのビルド中に待機する最大時間 (すべてのカスタマイズ、最適化、検証、およびディストリビューションが含まれます)。 既定値 (4 時間) を使用するには、0 を省略するか指定します。 |
customize | イメージ ソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。 |
distribute | イメージ出力の移動先となる配布ターゲット。 |
error |
ビルドエラー時のエラー処理オプション |
exact |
イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 この読み取り専用フィールドは、'stagingResourceGroup' フィールドに指定された値が空の場合にのみ、'stagingResourceGroup' と異なります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
identity | イメージ テンプレートの ID (構成されている場合)。 |
last |
現在実行中または最後に実行された 'run' の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
managed |
サービスによって作成されたリソース グループまたはリソースに適用されるタグ。 |
optimize | イメージに対して実行する最適化を指定します。 |
provisioning |
プロビジョニング エラー (注: このプロパティはシリアル化されません)。 サーバーによってのみ設定できます。 |
provisioning |
リソースのプロビジョニング状態注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
source | ソース イメージの説明に使用するプロパティを指定します。 |
staging |
イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 このフィールドが空の場合は、ランダムな名前のリソース グループが作成されます。 このフィールドに指定されたリソース グループが存在しない場合は、同じ名前で作成されます。 指定されたリソース グループが存在する場合は、イメージ テンプレートと同じリージョンに空である必要があります。 このフィールドが空であるか、指定されたリソース グループが存在しない場合、作成されたリソース グループはテンプレートの削除中に削除されますが、指定されたリソース グループが存在する場合、リソース グループに作成されたリソースはテンプレートの削除中に削除され、リソース グループ自体は残ります。 |
validate | 結果のイメージに対して実行される構成オプションと検証の一覧。 |
vm |
イメージをビルドするように仮想マシンを設定する方法について説明します |
継承されたプロパティ
id | リソースの完全修飾リソース 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
テンプレートの作成または更新時にイメージ テンプレート ビルドを自動的に実行するかどうかを示します。
autoRun?: ImageTemplateAutoRun
プロパティ値
buildTimeoutInMinutes
イメージ テンプレートのビルド中に待機する最大時間 (すべてのカスタマイズ、最適化、検証、およびディストリビューションが含まれます)。 既定値 (4 時間) を使用するには、0 を省略するか指定します。
buildTimeoutInMinutes?: number
プロパティ値
number
customize
イメージ ソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。
customize?: ImageTemplateCustomizerUnion[]
プロパティ値
distribute
イメージ出力の移動先となる配布ターゲット。
distribute?: ImageTemplateDistributorUnion[]
プロパティ値
errorHandling
ビルドエラー時のエラー処理オプション
errorHandling?: ImageTemplatePropertiesErrorHandling
プロパティ値
exactStagingResourceGroup
イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 この読み取り専用フィールドは、'stagingResourceGroup' フィールドに指定された値が空の場合にのみ、'stagingResourceGroup' と異なります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
exactStagingResourceGroup?: string
プロパティ値
string
identity
lastRunStatus
現在実行中または最後に実行された 'run' の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
lastRunStatus?: ImageTemplateLastRunStatus
プロパティ値
managedResourceTags
サービスによって作成されたリソース グループまたはリソースに適用されるタグ。
managedResourceTags?: {[propertyName: string]: string}
プロパティ値
{[propertyName: string]: string}
optimize
イメージに対して実行する最適化を指定します。
optimize?: ImageTemplatePropertiesOptimize
プロパティ値
provisioningError
プロビジョニング エラー (注: このプロパティはシリアル化されません)。 サーバーによってのみ設定できます。
provisioningError?: ProvisioningError
プロパティ値
provisioningState
リソースのプロビジョニング状態注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
provisioningState?: ProvisioningState
プロパティ値
source
stagingResourceGroup
イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 このフィールドが空の場合は、ランダムな名前のリソース グループが作成されます。 このフィールドに指定されたリソース グループが存在しない場合は、同じ名前で作成されます。 指定されたリソース グループが存在する場合は、イメージ テンプレートと同じリージョンに空である必要があります。 このフィールドが空であるか、指定されたリソース グループが存在しない場合、作成されたリソース グループはテンプレートの削除中に削除されますが、指定されたリソース グループが存在する場合、リソース グループに作成されたリソースはテンプレートの削除中に削除され、リソース グループ自体は残ります。
stagingResourceGroup?: string
プロパティ値
string
validate
結果のイメージに対して実行される構成オプションと検証の一覧。
validate?: ImageTemplatePropertiesValidate
プロパティ値
vmProfile
継承されたプロパティの詳細
id
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
id?: string
プロパティ値
string
location
リソースが存在する地理的な場所
location: string
プロパティ値
string
TrackedResource.location から継承
name
リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name?: string
プロパティ値
string
systemData
createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
systemData?: SystemData
プロパティ値
trackedResource.systemData から継承
tags
リソース タグ。
tags?: {[propertyName: string]: string}
プロパティ値
{[propertyName: string]: string}
type
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
type?: string
プロパティ値
string
trackedResource.type