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

VirtualMachineExtension interface

包:

@azure/arm-compute

介绍虚拟机扩展。

Extends

ResourceWithOptionalLocation

属性

autoUpgradeMinorVersion	指示如果扩展在部署时可用，则是否应使用较新的次要版本。 但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。
enableAutomaticUpgrade	指示如果有较新版本的可用扩展，则平台是否应自动升级扩展。
forceUpdateTag	应如何强制更新扩展处理程序，即使扩展配置尚未更改。
instanceView	虚拟机扩展实例视图。
protectedSettings	该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。
protectedSettingsFromKeyVault	扩展保护的设置，这些设置通过引用传递，并从密钥保管库使用
provisionAfterExtensions	扩展名称的集合，之后需要预配此扩展。
provisioningState	预配状态，仅显示在响应中。 注意：此属性不会被序列化。 它只能由服务器填充。
publisher	扩展处理程序发布者的名称。
settings	扩展的 Json 格式公共设置。
suppressFailures	指示是否将禁止从扩展引发的故障， (操作故障（如未连接到 VM）将不会被禁止，而不考虑此值) 。 默认值为 false。
typeHandlerVersion	指定脚本处理程序的版本。
typePropertiesType	指定扩展的类型;例如“CustomScriptExtension”。

继承属性

id	资源 ID 注意：此属性不会被序列化。 它只能由服务器填充。
location	资源位置
name	资源名称 注意：此属性不会被序列化。 它只能由服务器填充。
tags	资源标记
type	资源类型 注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

autoUpgradeMinorVersion

指示如果扩展在部署时可用，则是否应使用较新的次要版本。 但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。

autoUpgradeMinorVersion?: boolean

属性值

boolean

enableAutomaticUpgrade

指示如果有较新版本的可用扩展，则平台是否应自动升级扩展。

enableAutomaticUpgrade?: boolean

属性值

boolean

forceUpdateTag

应如何强制更新扩展处理程序，即使扩展配置尚未更改。

forceUpdateTag?: string

属性值

string

instanceView

虚拟机扩展实例视图。

instanceView?: VirtualMachineExtensionInstanceView

属性值

VirtualMachineExtensionInstanceView

protectedSettings

该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。

protectedSettings?: any

属性值

any

protectedSettingsFromKeyVault

扩展保护的设置，这些设置通过引用传递，并从密钥保管库使用

protectedSettingsFromKeyVault?: KeyVaultSecretReference

属性值

KeyVaultSecretReference

provisionAfterExtensions

扩展名称的集合，之后需要预配此扩展。

provisionAfterExtensions?: string[]

属性值

string[]

provisioningState

预配状态，仅显示在响应中。 注意：此属性不会被序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

publisher

扩展处理程序发布者的名称。

publisher?: string

属性值

string

settings

扩展的 Json 格式公共设置。

settings?: any

属性值

any

suppressFailures

指示是否将禁止从扩展引发的故障， (操作故障（如未连接到 VM）将不会被禁止，而不考虑此值) 。 默认值为 false。

suppressFailures?: boolean

属性值

boolean

typeHandlerVersion

指定脚本处理程序的版本。

typeHandlerVersion?: string

属性值

string

typePropertiesType

指定扩展的类型;例如“CustomScriptExtension”。

typePropertiesType?: string

属性值

string

继承属性详细信息

id

资源 ID 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自ResourceWithOptionalLocation.id

location

资源位置

location?: string

属性值

string

继承自ResourceWithOptionalLocation.location

name

资源名称 注意：此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自ResourceWithOptionalLocation.name

tags

资源标记

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自ResourceWithOptionalLocation.tags

type

资源类型 注意：此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ResourceWithOptionalLocation.type