Share via

VirtualMachineScaleSetVMExtension interface

Package:
@azure/arm-compute-profile-2020-09-01-hybrid

Describes a VMSS VM Extension.

Extends
SubResourceReadOnly

Properties

autoUpgradeMinorVersion

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enableAutomaticUpgrade

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag

How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView

The virtual machine extension instance view.
name

The name of the extension. NOTE: This property will not be serialized. It can only be populated by the server.
protectedSettings

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
publisher

The name of the extension handler publisher.
settings

Json formatted public settings for the extension.
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.
typeHandlerVersion

Specifies the version of the script handler.
typePropertiesType

Specifies the type of the extension; an example is "CustomScriptExtension".

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

autoUpgradeMinorVersion

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

autoUpgradeMinorVersion?: boolean

Property Value

boolean

enableAutomaticUpgrade

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

enableAutomaticUpgrade?: boolean

Property Value

boolean

forceUpdateTag

How the extension handler should be forced to update even if the extension configuration has not changed.

forceUpdateTag?: string

Property Value

string

instanceView

The virtual machine extension instance view.

instanceView?: VirtualMachineExtensionInstanceView

Property Value

VirtualMachineExtensionInstanceView

name

The name of the extension. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

protectedSettings

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

protectedSettings?: Record<string, unknown>

Property Value

Record<string, unknown>

provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publisher

The name of the extension handler publisher.

publisher?: string

Property Value

string

settings

Json formatted public settings for the extension.

settings?: Record<string, unknown>

Property Value

Record<string, unknown>

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

typeHandlerVersion

Specifies the version of the script handler.

typeHandlerVersion?: string

Property Value

string

typePropertiesType

Specifies the type of the extension; an example is "CustomScriptExtension".

typePropertiesType?: string

Property Value

string

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From SubResourceReadOnly.id