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

@azure/arm-imagebuilder package

ImageBuilderClient

接口

DistributeVersioner

介绍如何为分发生成新的 x.y.z 版本号。

DistributeVersionerLatest

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

DistributeVersionerSource

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式)。

ImageBuilderClientOptionalParams

可选参数。

ImageTemplate

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

ImageTemplateAutoRun

指示是否需要在创建/更新时生成映像模板

ImageTemplateCustomizer

描述映像自定义的单元

ImageTemplateDistributor

泛型分发对象

ImageTemplateFileCustomizer

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

ImageTemplateFileValidator

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

ImageTemplateIdentity

映像模板的标识。

ImageTemplateInVMValidator

描述映像 in-VM 验证的单元

ImageTemplateLastRunStatus

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

ImageTemplateListResult

列表图像模板操作的结果

ImageTemplateManagedImageDistributor

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

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

介绍 azure 库映像的映像源。

ImageTemplatePowerShellCustomizer

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

ImageTemplatePowerShellValidator

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

ImageTemplatePropertiesErrorHandling

生成失败时的错误处理选项

ImageTemplatePropertiesOptimize

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

ImageTemplatePropertiesOptimizeVmBoot

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

ImageTemplatePropertiesValidate

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

ImageTemplateRestartCustomizer

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

ImageTemplateSharedImageDistributor

通过 Azure 计算库进行分发。

ImageTemplateSharedImageVersionSource

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

ImageTemplateShellCustomizer

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

ImageTemplateShellValidator

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

ImageTemplateSource

描述用于生成、自定义和分发的虚拟机映像源

ImageTemplateUpdateParameters

用于更新映像模板的参数。

ImageTemplateUpdateParametersProperties

用于更新映像模板的参数。

ImageTemplateVhdDistributor

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

ImageTemplateVmProfile

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

ImageTemplateWindowsUpdateCustomizer

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

Operation

REST API 操作

OperationDisplay

描述操作的对象。

OperationListResult

列出 REST API 操作的请求的结果。 它包含操作列表和 URL nextLink 以获取下一组结果。

Operations

表示操作的接口。

OperationsListNextOptionalParams

可选参数。

OperationsListOptionalParams

可选参数。

PlatformImagePurchasePlan

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

ProvisioningError

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

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

RunOutput

表示通过运行映像模板创建的输出。

RunOutputCollection

列出运行输出操作的结果

SourceImageTriggerProperties

SourceImage 类型的触发器的属性

SystemData

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

TargetRegion

描述目标区域信息。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

Trigger

表示可以调用映像模板生成的触发器。

TriggerCollection

列表触发器操作的结果

TriggerProperties

描述触发器的属性

TriggerStatus

描述触发器的状态

Triggers

表示触发器的接口。

TriggersCreateOrUpdateOptionalParams

可选参数。

TriggersDeleteHeaders

定义Triggers_delete操作的标头。

TriggersDeleteOptionalParams

可选参数。

TriggersGetOptionalParams

可选参数。

TriggersListByImageTemplateNextOptionalParams

可选参数。

TriggersListByImageTemplateOptionalParams

可选参数。

UserAssignedIdentity

用户分配的标识属性

VirtualMachineImageTemplates

表示 VirtualMachineImageTemplates 的接口。

VirtualMachineImageTemplatesCancelOptionalParams

可选参数。

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

可选参数。

VirtualMachineImageTemplatesDeleteHeaders

定义VirtualMachineImageTemplates_delete操作的标头。

VirtualMachineImageTemplatesDeleteOptionalParams

可选参数。

VirtualMachineImageTemplatesGetOptionalParams

可选参数。

VirtualMachineImageTemplatesGetRunOutputOptionalParams

可选参数。

VirtualMachineImageTemplatesListByResourceGroupNextOptionalParams

可选参数。

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

可选参数。

VirtualMachineImageTemplatesListNextOptionalParams

可选参数。

VirtualMachineImageTemplatesListOptionalParams

可选参数。

VirtualMachineImageTemplatesListRunOutputsNextOptionalParams

可选参数。

VirtualMachineImageTemplatesListRunOutputsOptionalParams

可选参数。

VirtualMachineImageTemplatesRunOptionalParams

可选参数。

VirtualMachineImageTemplatesUpdateOptionalParams

可选参数。

VirtualNetworkConfig

虚拟网络配置。

类型别名

AutoRunState

定义 AutoRunState 的值。

CreatedByType

定义 CreatedByType 的值。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户
应用程序
ManagedIdentity
密钥

DistributeVersionerUnion
ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion
OnBuildError

定义 OnBuildError 的值。
KnownOnBuildError 可与 OnBuildError 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

清理
中止

OperationsListNextResponse

包含 listNext 操作的响应数据。

OperationsListResponse

包含列表操作的响应数据。

ProvisioningErrorCode

定义 ProvisioningErrorCode 的值。
KnownProvisioningErrorCode 可与 ProvisioningErrorCode 互换,此枚举包含服务支持的已知值。

服务支持的已知值

BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
其他

ProvisioningState

定义 ProvisioningState 的值。

ResourceIdentityType

定义 ResourceIdentityType 的值。

RunState

定义 RunState 的值。

RunSubState

定义 RunSubState 的值。

SharedImageStorageAccountType

定义 SharedImageStorageAccountType 的值。
KnownSharedImageStorageAccountType 可与 SharedImageStorageAccountType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Standard_LRS
Standard_ZRS
Premium_LRS

TriggerPropertiesUnion
TriggersCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

TriggersDeleteResponse

包含删除操作的响应数据。

TriggersGetResponse

包含获取操作的响应数据。

TriggersListByImageTemplateNextResponse

包含 listByImageTemplateNext 操作的响应数据。

TriggersListByImageTemplateResponse

包含 listByImageTemplate 操作的响应数据。

VMBootOptimizationState

定义 VMBootOptimizationState 的值。

VirtualMachineImageTemplatesCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

VirtualMachineImageTemplatesDeleteResponse

包含删除操作的响应数据。

VirtualMachineImageTemplatesGetResponse

包含获取操作的响应数据。

VirtualMachineImageTemplatesGetRunOutputResponse

包含 getRunOutput 操作的响应数据。

VirtualMachineImageTemplatesListByResourceGroupNextResponse

包含 listByResourceGroupNext 操作的响应数据。

VirtualMachineImageTemplatesListByResourceGroupResponse

包含 listByResourceGroup 操作的响应数据。

VirtualMachineImageTemplatesListNextResponse

包含 listNext 操作的响应数据。

VirtualMachineImageTemplatesListResponse

包含列表操作的响应数据。

VirtualMachineImageTemplatesListRunOutputsNextResponse

包含 listRunOutputsNext 操作的响应数据。

VirtualMachineImageTemplatesListRunOutputsResponse

包含 listRunOutputs 操作的响应数据。

VirtualMachineImageTemplatesUpdateResponse

包含更新操作的响应数据。

枚举

KnownCreatedByType

服务的 CreatedByType 的已知值

KnownOnBuildError

服务接受的 OnBuildError 的已知值。

KnownProvisioningErrorCode

ProvisioningErrorCode 服务的已知值。

KnownSharedImageStorageAccountType

SharedImageStorageAccountType 服务的已知值。

函数

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

函数详细信息

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

byPage 迭代器访问 IteratorResult 上的 value 的对象。

返回

string | undefined

可在将来调用期间传递到 byPage() 的延续标记。