VMExtension interface

Package:

@azure/arm-batch

The configuration for virtual machine extensions.

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.
name	The name of the virtual machine extension.
protectedSettings	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.
publisher	The name of the extension handler publisher.
settings	JSON formatted public settings for the extension.
type	The type of the extensions.
typeHandlerVersion	The version of script handler.

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

name

The name of the virtual machine extension.

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>

provisionAfterExtensions

Collection of extension names after which this extension needs to be provisioned.

provisionAfterExtensions?: 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

The type of the extensions.

type: string

Property Value

string

typeHandlerVersion

The version of script handler.

typeHandlerVersion?: string

Property Value

string