Package version:

InterfaceMachineExtensionUpdate

Describes a Machine Extension Update.

interface MachineExtensionUpdate {
    autoUpgradeMinorVersion?: boolean;
    enableAutomaticUpgrade?: boolean;
    forceUpdateTag?: string;
    protectedSettings?: {
        [propertyName: string]: any;
    };
    publisher?: string;
    settings?: {
        [propertyName: string]: any;
    };
    tags?: {
        [propertyName: string]: string;
    };
    type?: string;
    typeHandlerVersion?: string;
}

Hierarchy (view full)

Properties

autoUpgradeMinorVersion? enableAutomaticUpgrade? forceUpdateTag? protectedSettings? publisher? settings? tags? 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?: {
    [propertyName: string]: any;
}

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

Optionalpublisher

publisher?: string

The name of the extension handler publisher.

Optionalsettings

settings?: {
    [propertyName: string]: any;
}

Json formatted public settings for the extension.

Optionaltags

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

Resource tags

Optionaltype

type?: string

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

OptionaltypeHandlerVersion

typeHandlerVersion?: string

Specifies the version of the script handler.

Settings

Member Visibility