Package version:

Interface ExtensionParameters

Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.

interface ExtensionParameters {
    autoUpgradeMinorVersion?: boolean;
    enableAutomaticUpgrade?: boolean;
    forceUpdateTag?: string;
    protectedSettings?: any;
    publisher?: string;
    settings?: any;
    type?: string;
    typeHandlerVersion?: string;
}

Properties

autoUpgradeMinorVersion? enableAutomaticUpgrade? forceUpdateTag? protectedSettings? publisher? settings? type? typeHandlerVersion?

Properties

OptionalautoUpgradeMinorVersion

autoUpgradeMinorVersion?: boolean

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.

OptionalenableAutomaticUpgrade

enableAutomaticUpgrade?: boolean

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

OptionalforceUpdateTag

forceUpdateTag?: string

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

OptionalprotectedSettings

protectedSettings?: any

Protected settings (may contain secrets).

Optionalpublisher

publisher?: string

The name of the extension handler publisher.

Optionalsettings

settings?: any

Json formatted public settings for the extension.

Optionaltype

type?: string

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

OptionaltypeHandlerVersion

typeHandlerVersion?: string

Specifies the version of the script handler. Latest version would be used if not specified.

Settings

Member Visibility