VirtualMachineExtensionUpdate interface

Describes a Virtual Machine Extension.

Extends

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.

protectedSettings

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

publisher

The name of the extension handler publisher.

settings

Json formatted public settings for the extension.

type

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

typeHandlerVersion

Specifies the version of the script handler.

Inherited Properties

tags

Resource tags

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

protectedSettings

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

protectedSettings?: Record<string, unknown>

Property Value

Record<string, unknown>

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

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

type?: string

Property Value

string

typeHandlerVersion

Specifies the version of the script handler.

typeHandlerVersion?: string

Property Value

string

Inherited Property Details

tags

Resource tags

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

Property Value

{[propertyName: string]: string}

Inherited From UpdateResource.tags