你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Virtual Machine Image Templates - List By Resource Group

参考

服务:: Image Builder

API 版本:: 2022-07-01

获取与指定资源组关联的 VM 映像模板的相关信息。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	ImageTemplateListResult	还行
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List images by resource group

示例请求

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

/** Samples for VirtualMachineImageTemplates ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2022-07-01/examples/ListImageTemplatesByRg.json
     */
    /**
     * Sample code: List images by resource group.
     *
     * @param manager Entry point to ImageBuilderManager.
     */
    public static void listImagesByResourceGroup(com.azure.resourcemanager.imagebuilder.ImageBuilderManager manager) {
        manager.virtualMachineImageTemplates().listByResourceGroup("myResourceGroup", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.imagebuilder import ImageBuilderClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-imagebuilder
# USAGE
    python list_image_templates_by_rg.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ImageBuilderClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_image_templates.list_by_resource_group(
        resource_group_name="myResourceGroup",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2022-07-01/examples/ListImageTemplatesByRg.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armvirtualmachineimagebuilder_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/virtualmachineimagebuilder/armvirtualmachineimagebuilder/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2022-07-01/examples/ListImageTemplatesByRg.json
func ExampleVirtualMachineImageTemplatesClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armvirtualmachineimagebuilder.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVirtualMachineImageTemplatesClient().NewListByResourceGroupPager("myResourceGroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ImageTemplateListResult = armvirtualmachineimagebuilder.ImageTemplateListResult{
		// 	Value: []*armvirtualmachineimagebuilder.ImageTemplate{
		// 		{
		// 			Name: to.Ptr("myImageTemplate"),
		// 			Type: to.Ptr("Microsoft.VirtualMachineImages/imageTemplates"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate"),
		// 			Location: to.Ptr("westus"),
		// 			Identity: &armvirtualmachineimagebuilder.ImageTemplateIdentity{
		// 				Type: to.Ptr(armvirtualmachineimagebuilder.ResourceIdentityTypeUserAssigned),
		// 				UserAssignedIdentities: map[string]*armvirtualmachineimagebuilder.UserAssignedIdentity{
		// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": &armvirtualmachineimagebuilder.UserAssignedIdentity{
		// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					},
		// 				},
		// 			},
		// 			Properties: &armvirtualmachineimagebuilder.ImageTemplateProperties{
		// 				Customize: []armvirtualmachineimagebuilder.ImageTemplateCustomizerClassification{
		// 					&armvirtualmachineimagebuilder.ImageTemplateShellCustomizer{
		// 						Name: to.Ptr("Shell customization example"),
		// 						Type: to.Ptr("Shell"),
		// 						ScriptURI: to.Ptr("https://example.com/path/to/script.sh"),
		// 				}},
		// 				Distribute: []armvirtualmachineimagebuilder.ImageTemplateDistributorClassification{
		// 					&armvirtualmachineimagebuilder.ImageTemplateManagedImageDistributor{
		// 						Type: to.Ptr("ManagedImage"),
		// 						ArtifactTags: map[string]*string{
		// 							"tagName": to.Ptr("value"),
		// 						},
		// 						RunOutputName: to.Ptr("image_it_pir_1"),
		// 						ImageID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1"),
		// 						Location: to.Ptr("1_location"),
		// 				}},
		// 				Source: &armvirtualmachineimagebuilder.ImageTemplateManagedImageSource{
		// 					Type: to.Ptr("ManagedImage"),
		// 					ImageID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image"),
		// 				},
		// 				VMProfile: &armvirtualmachineimagebuilder.ImageTemplateVMProfile{
		// 					OSDiskSizeGB: to.Ptr[int32](64),
		// 					VMSize: to.Ptr("Standard_D2s_v3"),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("myOtherImageTemplate"),
		// 			Type: to.Ptr("Microsoft.VirtualMachineImages/imageTemplates"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myOtherImageTemplate"),
		// 			Location: to.Ptr("eastus"),
		// 			Identity: &armvirtualmachineimagebuilder.ImageTemplateIdentity{
		// 				Type: to.Ptr(armvirtualmachineimagebuilder.ResourceIdentityTypeUserAssigned),
		// 				UserAssignedIdentities: map[string]*armvirtualmachineimagebuilder.UserAssignedIdentity{
		// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": &armvirtualmachineimagebuilder.UserAssignedIdentity{
		// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					},
		// 				},
		// 			},
		// 			Properties: &armvirtualmachineimagebuilder.ImageTemplateProperties{
		// 				Customize: []armvirtualmachineimagebuilder.ImageTemplateCustomizerClassification{
		// 					&armvirtualmachineimagebuilder.ImageTemplateShellCustomizer{
		// 						Name: to.Ptr("Shell customization example"),
		// 						Type: to.Ptr("Shell"),
		// 						ScriptURI: to.Ptr("https://example.com/path/to/script.sh"),
		// 				}},
		// 				Distribute: []armvirtualmachineimagebuilder.ImageTemplateDistributorClassification{
		// 					&armvirtualmachineimagebuilder.ImageTemplateManagedImageDistributor{
		// 						Type: to.Ptr("ManagedImage"),
		// 						RunOutputName: to.Ptr("singleImage"),
		// 						ImageID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/baseimage-cus"),
		// 						Location: to.Ptr("centralus"),
		// 					},
		// 					&armvirtualmachineimagebuilder.ImageTemplateSharedImageDistributor{
		// 						Type: to.Ptr("SharedImage"),
		// 						RunOutputName: to.Ptr("gallery"),
		// 						ExcludeFromLatest: to.Ptr(true),
		// 						GalleryImageID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/gallery/baseimages/images/baseimage"),
		// 						ReplicationRegions: []*string{
		// 							to.Ptr("eastus"),
		// 							to.Ptr("westus")},
		// 							StorageAccountType: to.Ptr(armvirtualmachineimagebuilder.SharedImageStorageAccountTypeStandardLRS),
		// 					}},
		// 					Source: &armvirtualmachineimagebuilder.ImageTemplatePlatformImageSource{
		// 						Type: to.Ptr("PlatformImage"),
		// 						Offer: to.Ptr("UbuntuServer"),
		// 						PlanInfo: &armvirtualmachineimagebuilder.PlatformImagePurchasePlan{
		// 							PlanName: to.Ptr("example_plan_name"),
		// 							PlanProduct: to.Ptr("example_plan_product"),
		// 							PlanPublisher: to.Ptr("example_plan_publisher"),
		// 						},
		// 						Publisher: to.Ptr("Canonical"),
		// 						SKU: to.Ptr("18.04-LTS"),
		// 						Version: to.Ptr("18.04.201902121"),
		// 					},
		// 					VMProfile: &armvirtualmachineimagebuilder.ImageTemplateVMProfile{
		// 						OSDiskSizeGB: to.Ptr[int32](64),
		// 						VMSize: to.Ptr("Standard_D8s_v3"),
		// 					},
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ImageBuilderClient } = require("@azure/arm-imagebuilder");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the VM image templates associated with the specified resource group.
 *
 * @summary Gets information about the VM image templates associated with the specified resource group.
 * x-ms-original-file: specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2022-07-01/examples/ListImageTemplatesByRg.json
 */
async function listImagesByResourceGroup() {
  const subscriptionId = process.env["IMAGEBUILDER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["IMAGEBUILDER_RESOURCE_GROUP"] || "myResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new ImageBuilderClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachineImageTemplates.listByResourceGroup(
    resourceGroupName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "value": [
    {
      "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 customization 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
        }
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myOtherImageTemplate",
      "name": "myOtherImageTemplate",
      "location": "eastus",
      "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": "PlatformImage",
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "18.04.201902121",
          "planInfo": {
            "planName": "example_plan_name",
            "planProduct": "example_plan_product",
            "planPublisher": "example_plan_publisher"
          }
        },
        "customize": [
          {
            "type": "Shell",
            "name": "Shell customization example",
            "scriptUri": "https://example.com/path/to/script.sh"
          }
        ],
        "distribute": [
          {
            "type": "ManagedImage",
            "location": "centralus",
            "runOutputName": "singleImage",
            "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/baseimage-cus"
          },
          {
            "type": "SharedImage",
            "galleryImageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/gallery/baseimages/images/baseimage",
            "replicationRegions": [
              "eastus",
              "westus"
            ],
            "runOutputName": "gallery",
            "excludeFromLatest": true,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "vmProfile": {
          "vmSize": "Standard_D8s_v3",
          "osDiskSizeGB": 64
        }
      }
    }
  ],
  "nextLink": "/subscriptions/{subscription-id}/resourceGroup/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates?api-version=2022-07-01&skip-token=2"
}

定义

名称	说明
CloudError	Azure VM 映像生成器服务的错误响应。
CloudErrorBody	Azure VM 映像生成器服务的错误响应。
createdByType	创建资源的标识的类型。
DistributeVersionerLatest	生成基于现有版本号的最新版本号。
DistributeVersionerSource	根据源映像的版本号生成版本号
ImageTemplate	映像模板是由 Microsoft.VirtualMachineImages 提供程序管理的 ARM 资源
ImageTemplateFileCustomizer	将文件上传到 VM（Linux、Windows）。对应于 Packer 文件预配程序
ImageTemplateFileValidator	将验证所需的文件上传到 VM（Linux、Windows）。对应于 Packer 文件预配程序
ImageTemplateIdentity	映像模板的标识。
ImageTemplateLastRunStatus	描述运行映像模板的最新状态
ImageTemplateListResult	列表图像模板操作的结果
ImageTemplateManagedImageDistributor	作为托管磁盘映像进行分发。
ImageTemplateManagedImageSource	描述客户订阅中托管映像的映像源。此映像必须与映像生成器模板位于同一订阅和区域中。
ImageTemplatePlatformImageSource	介绍 azure 库映像的映像源。
ImageTemplatePowerShellCustomizer	在 VM（Windows）上运行指定的 PowerShell。对应于 Packer powershell 预配程序。只能指定“scriptUri”或“内联”之一。
ImageTemplatePowerShellValidator	在验证阶段（Windows）期间运行指定的 PowerShell 脚本。对应于 Packer powershell 预配程序。只能指定“scriptUri”或“内联”之一。
ImageTemplateRestartCustomizer	重新启动 VM 并等待 VM 重新联机（Windows）。对应于 Packer windows-restart 预配程序
ImageTemplateSharedImageDistributor	通过 Azure 计算库进行分发。
ImageTemplateSharedImageVersionSource	描述在 Azure 计算库或直接共享库中是映像版本的映像源。
ImageTemplateShellCustomizer	在自定义阶段（Linux）中运行 shell 脚本。对应于 Packer shell 预配程序。只能指定“scriptUri”或“内联”之一。
ImageTemplateShellValidator	在验证阶段（Linux）中运行指定的 shell 脚本。对应于 Packer shell 预配程序。只能指定“scriptUri”或“内联”之一。
ImageTemplateVhdDistributor	在存储帐户中通过 VHD 进行分发。
ImageTemplateVmProfile	描述用于生成和验证映像的虚拟机
ImageTemplateWindowsUpdateCustomizer	安装 Windows 更新。对应于 Packer Windows 更新预配程序（https://github.com/rgl/packer-provisioner-windows-update）
Optimize	指定要对图像执行的优化。
PlatformImagePurchasePlan	平台映像的购买计划配置。
ProvisioningError	描述创建或更新映像模板时发生的错误
ProvisioningErrorCode	预配失败的错误代码
ProvisioningState	资源的预配状态
ResourceIdentityType	用于映像模板的标识类型。类型“None”将从映像模板中删除任何标识。
RunState	上次运行的状态
RunSubState	上次运行的子状态
SharedImageStorageAccountType	指定要用于存储 Azure 计算库映像版本的存储帐户类型。
systemData	与创建和上次修改资源相关的元数据。
TargetRegion	描述目标区域信息。
UserAssignedIdentity	用户分配的标识属性
Validate	要对生成的映像执行的验证的配置选项和列表。
VirtualNetworkConfig	虚拟网络配置。
VmBoot	优化在映像上应用，以便更快地启动 VM。
VMBootOptimizationState	启用此字段将通过优化最终自定义映像输出来提高 VM 启动时间。

CloudError

Object

Azure VM 映像生成器服务的错误响应。

名称	类型	说明
error	CloudErrorBody	有关错误的详细信息。

CloudErrorBody

Object

Azure VM 映像生成器服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DistributeVersionerLatest

Object

生成基于现有版本号的最新版本号。

名称	类型	默认值	说明
major	integer (int32) minimum: -1	-1	生成的版本号的主要版本。根据此值作为主要版本的版本确定什么是“最新”。 -1 等效于将其保留为未设置。
scheme	string: Latest		要使用的版本号方案。

DistributeVersionerSource

Object

根据源映像的版本号生成版本号

名称	类型	说明
scheme	string: Source	要使用的版本号方案。

ImageTemplate

Object

映像模板是由 Microsoft.VirtualMachineImages 提供程序管理的 ARM 资源

名称	类型	默认值	说明
id	string		资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		映像模板的标识（如果已配置）。
location	string		资源所在的地理位置
name	string		资源的名称
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	生成映像模板时等待的最大持续时间（包括所有自定义、优化、验证和分发）。省略或指定 0 以使用默认值（4 小时）。
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		指定用于描述映像的自定义步骤的属性，如图像源等
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		映像输出需要转到的分发目标。
properties.exactStagingResourceGroup	string		与用于生成映像的映像模板相同的订阅中的暂存资源组 ID。仅当“stagingResourceGroup”字段中指定的值为空时，此只读字段与“stagingResourceGroup”不同。
properties.lastRunStatus	ImageTemplateLastRunStatus		当前正在执行的或上次执行的“run”状态。
properties.optimize	Optimize		指定要对图像执行的优化。
properties.provisioningError	ProvisioningError		预配错误（如果有）
properties.provisioningState	ProvisioningState		资源的预配状态
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		指定用于描述源图像的属性。
properties.stagingResourceGroup	string		与用于生成映像的映像模板相同的订阅中的暂存资源组 ID。如果此字段为空，则会创建一个具有随机名称的资源组。如果此字段中指定的资源组不存在，则会创建具有相同名称的资源组。如果指定的资源组存在，则它必须是空的，并且与映像模板位于同一区域中。如果此字段为空或指定的资源组不存在，则在模板删除期间将删除创建的资源组，但在模板删除期间将删除资源组中创建的资源，并且资源组本身将保留。
properties.validate	Validate		要对生成的映像执行的验证的配置选项和列表。
properties.vmProfile	ImageTemplateVmProfile		描述如何设置虚拟机以生成映像
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object		资源标记。
type	string		资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ImageTemplateFileCustomizer

Object

将文件上传到 VM（Linux、Windows）。对应于 Packer 文件预配程序

名称	类型	说明
destination	string	文件（已创建嵌套目录结构）的绝对路径，该文件（来自 sourceUri）将上传到 VM 中
name	string	用于提供此自定义步骤的上下文的友好名称
sha256Checksum	string	上述 sourceUri 字段中提供的文件的 SHA256 校验和
sourceUri	string	要上传的文件的 URI，用于自定义 VM。它可以是 github 链接、Azure 存储的 SAS URI 等
type	string: File	要在映像上使用的自定义工具的类型。例如，“Shell”可以是 shell 定制器

ImageTemplateFileValidator

Object

将验证所需的文件上传到 VM（Linux、Windows）。对应于 Packer 文件预配程序

名称	类型	说明
destination	string	文件（已创建嵌套目录结构）的绝对路径，该文件（来自 sourceUri）将上传到 VM 中
name	string	用于提供此验证步骤的上下文的友好名称
sha256Checksum	string	上述 sourceUri 字段中提供的文件的 SHA256 校验和
sourceUri	string	要上传到 VM 进行验证的文件的 URI。它可以是 github 链接、Azure 存储 URI（已授权或 SAS），等等
type	string: File	要在映像上使用的验证类型。例如，“Shell”可以是 shell 验证

ImageTemplateIdentity

Object

映像模板的标识。

名称	类型	说明
type	ResourceIdentityType	用于映像模板的标识类型。类型“None”将从映像模板中删除任何标识。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。字典值可以是请求中的空对象（{}）。

ImageTemplateLastRunStatus

Object

描述运行映像模板的最新状态

名称	类型	说明
endTime	string (date-time)	上次运行的结束时间（UTC）
message	string	有关上次运行状态的详细信息
runState	RunState	上次运行的状态
runSubState	RunSubState	上次运行的子状态
startTime	string (date-time)	上次运行的开始时间（UTC）

ImageTemplateListResult

Object

列表图像模板操作的结果

名称	类型	说明
nextLink	string	延续标记。
value	ImageTemplate[]	图像模板数组

ImageTemplateManagedImageDistributor

Object

作为托管磁盘映像进行分发。

名称	类型	说明
artifactTags	object	分发服务器创建/更新项目后，将应用于项目的标记。
imageId	string	托管磁盘映像的资源 ID
location	string	映像的 Azure 位置应匹配（如果映像已存在）
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	要用于关联的 RunOutput 的名称。
type	string: ManagedImage	分布类型。

ImageTemplateManagedImageSource

Object

描述客户订阅中托管映像的映像源。此映像必须与映像生成器模板位于同一订阅和区域中。

名称	类型	说明
imageId	string	客户订阅中托管映像的 ARM 资源 ID
type	string: ManagedImage	指定要从其开始的源图像的类型。

ImageTemplatePlatformImageSource

Object

介绍 azure 库映像的映像源。

名称	类型	说明
exactVersion	string	Azure 库映像中的映像版本。仅当“version”字段中指定的值为“latest”时，此只读字段与“version”不同。
offer	string	azure 库映像映像产品/服务。
planInfo	PlatformImagePurchasePlan	平台映像的购买计划的可选配置。
publisher	string	Azure 库映像中的映像发布服务器。
sku	string	Azure 库映像中的映像 SKU。
type	string: PlatformImage	指定要从其开始的源图像的类型。
version	string	Azure 库映像中的映像版本。如果在此处指定了“latest”，则会在映像生成发生时评估版本，而不是提交模板时评估版本。

ImageTemplatePowerShellCustomizer

Object

在 VM（Windows）上运行指定的 PowerShell。对应于 Packer powershell 预配程序。只能指定“scriptUri”或“内联”之一。

名称	类型	默认值	说明
inline	string[]		要执行的 PowerShell 命令数组
name	string		用于提供此自定义步骤的上下文的友好名称
runAsSystem	boolean	False	如果指定，将使用本地系统用户提升的权限运行 PowerShell 脚本。仅当上面的 runElevated 字段设置为 true 时，才能为 true。
runElevated	boolean	False	如果指定，将使用提升的权限运行 PowerShell 脚本
scriptUri	string		要运行用于自定义的 PowerShell 脚本的 URI。它可以是 github 链接、Azure 存储的 SAS URI 等
sha256Checksum	string		上述 scriptUri 字段中提供的 power shell 脚本的 SHA256 校验和
type	string: PowerShell		要在映像上使用的自定义工具的类型。例如，“Shell”可以是 shell 定制器
validExitCodes	integer[] (int32)		PowerShell 脚本的有效退出代码。 [默认值： 0]

ImageTemplatePowerShellValidator

Object

在验证阶段（Windows）期间运行指定的 PowerShell 脚本。对应于 Packer powershell 预配程序。只能指定“scriptUri”或“内联”之一。

名称	类型	默认值	说明
inline	string[]		要执行的 PowerShell 命令数组
name	string		用于提供此验证步骤的上下文的友好名称
runAsSystem	boolean	False	如果指定，将使用本地系统用户提升的权限运行 PowerShell 脚本。仅当上面的 runElevated 字段设置为 true 时，才能为 true。
runElevated	boolean	False	如果指定，将使用提升的权限运行 PowerShell 脚本
scriptUri	string		要运行的 PowerShell 脚本的 URI 进行验证。它可以是 github 链接、Azure 存储 URI 等
sha256Checksum	string		上述 scriptUri 字段中提供的 power shell 脚本的 SHA256 校验和
type	string: PowerShell		要在映像上使用的验证类型。例如，“Shell”可以是 shell 验证
validExitCodes	integer[] (int32)		PowerShell 脚本的有效退出代码。 [默认值： 0]

ImageTemplateRestartCustomizer

Object

重新启动 VM 并等待 VM 重新联机（Windows）。对应于 Packer windows-restart 预配程序

名称	类型	说明
name	string	用于提供此自定义步骤的上下文的友好名称
restartCheckCommand	string	用于检查重启是否成功的命令 [默认值： '']
restartCommand	string	执行重启的命令 [Default： 'shutdown /r /f /t 0 /c 'packer restart']
restartTimeout	string	指定为数量级和单位字符串的重启超时，例如“5m”（5 分钟）或“2h”（2 小时）[默认值：“5m”]
type	string: WindowsRestart	要在映像上使用的自定义工具的类型。例如，“Shell”可以是 shell 定制器

ImageTemplateSharedImageDistributor

Object

通过 Azure 计算库进行分发。

名称	类型	默认值	说明
artifactTags	object		分发服务器创建/更新项目后，将应用于项目的标记。
excludeFromLatest	boolean	False	指示是否应从最新版本中排除创建的映像版本的标志。省略使用默认值（false）。
galleryImageId	string		Azure 计算库映像的资源 ID
replicationRegions	string[]		[已弃用]将映像复制到的区域列表。仅当未指定 targetRegions 时，才能指定此列表。此字段已弃用 - 请改用 targetRegions。
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		要用于关联的 RunOutput 的名称。
storageAccountType	SharedImageStorageAccountType		[已弃用]用于存储共享映像的存储帐户类型。省略使用默认值（Standard_LRS）。仅当指定 replicationRegions 时，才能指定此字段。此字段已弃用 - 请改用 targetRegions。
targetRegions	TargetRegion[]		要将分布式映像版本复制到的目标区域。此对象取代 replicationRegions，仅当未指定 replicationRegions 时才能指定。
type	string: SharedImage		分布类型。
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		介绍如何为分发生成新的 x.y.z 版本号。

ImageTemplateSharedImageVersionSource

Object

描述在 Azure 计算库或直接共享库中是映像版本的映像源。

名称	类型	说明
exactVersion	string	映像版本的确切 ARM 资源 ID。仅当“imageVersionId”字段中指定的版本名称为“latest”时，此只读字段与“imageVersionId”中的映像版本 ID 不同。
imageVersionId	string	映像版本的 ARM 资源 ID。当映像版本名称为“latest”时，将在映像生成发生时评估版本。
type	string: SharedImageVersion	指定要从其开始的源图像的类型。

ImageTemplateShellCustomizer

Object

在自定义阶段（Linux）中运行 shell 脚本。对应于 Packer shell 预配程序。只能指定“scriptUri”或“内联”之一。

名称	类型	说明
inline	string[]	要执行的 shell 命令数组
name	string	用于提供此自定义步骤的上下文的友好名称
scriptUri	string	要运行用于自定义的 shell 脚本的 URI。它可以是 github 链接、Azure 存储的 SAS URI 等
sha256Checksum	string	scriptUri 字段中提供的 shell 脚本的 SHA256 校验和
type	string: Shell	要在映像上使用的自定义工具的类型。例如，“Shell”可以是 shell 定制器

ImageTemplateShellValidator

Object

在验证阶段（Linux）中运行指定的 shell 脚本。对应于 Packer shell 预配程序。只能指定“scriptUri”或“内联”之一。

名称	类型	说明
inline	string[]	要执行的 shell 命令数组
name	string	用于提供此验证步骤的上下文的友好名称
scriptUri	string	要运行的 shell 脚本的 URI 进行验证。它可以是 github 链接、Azure 存储 URI 等
sha256Checksum	string	scriptUri 字段中提供的 shell 脚本的 SHA256 校验和
type	string: Shell	要在映像上使用的验证类型。例如，“Shell”可以是 shell 验证

ImageTemplateVhdDistributor

Object

在存储帐户中通过 VHD 进行分发。

名称	类型	说明
artifactTags	object	分发服务器创建/更新项目后，将应用于项目的标记。
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	要用于关联的 RunOutput 的名称。
type	string: VHD	分布类型。
uri	string	分布式 VHD Blob 的可选 Azure 存储 URI。省略使用默认的（空字符串），在这种情况下，VHD 将发布到暂存资源组中的存储帐户。

ImageTemplateVmProfile

Object

描述用于生成和验证映像的虚拟机

名称	类型	默认值	说明
osDiskSizeGB	integer (int32) minimum: 0	0	OS 磁盘的大小（以 GB 为单位）。省略或指定 0 以使用 Azure 的默认 OS 磁盘大小。
userAssignedIdentities	string[]		要在生成 VM 和验证 VM 上配置的用户分配托管标识的资源 ID 的可选数组。这可能包括映像模板的标识。
vmSize	string		用于生成、自定义和捕获映像的虚拟机的大小。省略或指定空字符串以使用默认值（第 1 代映像Standard_D1_v2，并为 Gen2 映像指定Standard_D2ds_v4）。
vnetConfig	VirtualNetworkConfig		用于部署生成 VM 和验证 VM 的虚拟网络的可选配置。如果不需要使用任何特定的虚拟网络，则省略。

ImageTemplateWindowsUpdateCustomizer

Object

安装 Windows 更新。对应于 Packer Windows 更新预配程序（https://github.com/rgl/packer-provisioner-windows-update）

名称	类型	默认值	说明
filters	string[]		要选择要应用的更新的筛选器数组。省略或指定空数组以使用默认值（无筛选器）。有关此字段的示例和详细说明，请参阅上面的链接。
name	string		用于提供此自定义步骤的上下文的友好名称
searchCriteria	string		搜索更新的条件。省略或指定空字符串以使用默认值（全部搜索）。有关此字段的示例和详细说明，请参阅上面的链接。
type	string: WindowsUpdate		要在映像上使用的自定义工具的类型。例如，“Shell”可以是 shell 定制器
updateLimit	integer (int32) minimum: 0	0	一次应用的最大更新数。省略或指定 0 以使用默认值（1000）

Optimize

Object

指定要对图像执行的优化。

名称	类型	说明
vmBoot	VmBoot	优化在映像上应用，以便更快地启动 VM。

PlatformImagePurchasePlan

Object

平台映像的购买计划配置。

名称	类型	说明
planName	string	购买计划的名称。
planProduct	string	购买计划的产品。
planPublisher	string	购买计划的发布者。

ProvisioningError

Object

描述创建或更新映像模板时发生的错误

名称	类型	说明
message	string	有关预配失败的详细错误消息
provisioningErrorCode	ProvisioningErrorCode	预配失败的错误代码

ProvisioningErrorCode

枚举

预配失败的错误代码

值	说明
BadCustomizerType
BadDistributeType
BadManagedImageSource
BadPIRSource
BadSharedImageDistribute
BadSharedImageVersionSource
BadSourceType
BadStagingResourceGroup
BadValidatorType
NoCustomizerScript
NoValidatorScript
Other
ServerError
UnsupportedCustomizerType
UnsupportedValidatorType

ProvisioningState

枚举

资源的预配状态

值	说明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

枚举

用于映像模板的标识类型。类型“None”将从映像模板中删除任何标识。

值	说明
None
UserAssigned

RunState

枚举

上次运行的状态

值	说明
Canceled
Canceling
Failed
PartiallySucceeded
Running
Succeeded

RunSubState

枚举

上次运行的子状态

值	说明
Building
Customizing
Distributing
Optimizing
Queued
Validating

SharedImageStorageAccountType

枚举

指定要用于存储 Azure 计算库映像版本的存储帐户类型。

值	说明
Premium_LRS
Standard_LRS
Standard_ZRS

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TargetRegion

Object

描述目标区域信息。

名称	类型	默认值	说明
name	string		区域的名称。
replicaCount	integer (int32) minimum: 1	1	要在此区域中创建的映像版本的副本数。省略使用默认值（1）。
storageAccountType	SharedImageStorageAccountType		指定要用于在此区域中存储映像的存储帐户类型。省略使用默认值（Standard_LRS）。

UserAssignedIdentity

Object

用户分配的标识属性

名称	类型	说明
clientId	string	分配的标识的客户端 ID。
principalId	string	已分配标识的主体 ID。

Validate

Object

要对生成的映像执行的验证的配置选项和列表。

名称	类型	默认值	说明
continueDistributeOnFailure	boolean	False	如果验证失败，并且此字段设置为 false，则不会分发输出图像。这是默认行为。如果验证失败，并且此字段设置为 true，则输出图像（s）仍将分布。请谨慎使用此选项，因为它可能会导致分发错误的图像以供使用。在任一情况下（true 或 false），在验证失败时，将报告端到端映像运行失败。 [注意：如果验证成功，此字段无效。]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		要执行的验证列表。
sourceValidationOnly	boolean	False	如果此字段设置为 true，则直接验证“source”部分中指定的图像。不会运行单独的生成来生成并验证自定义映像。

VirtualNetworkConfig

Object

虚拟网络配置。

名称	类型	说明
proxyVmSize	string	用于将流量传递到生成 VM 和验证 VM 的代理虚拟机的大小。省略或指定空字符串以使用默认值（Standard_A1_v2）。
subnetId	string	预先存在的子网的资源 ID。

VmBoot

Object

优化在映像上应用，以便更快地启动 VM。

名称	类型	说明
state	VMBootOptimizationState	启用此字段将通过优化最终自定义映像输出来提高 VM 启动时间。

VMBootOptimizationState

枚举

启用此字段将通过优化最终自定义映像输出来提高 VM 启动时间。

值	说明
Disabled
Enabled