Package version:

InterfaceMachineExtensionProperties

Describes the properties of a Machine Extension.

interface MachineExtensionProperties {
    autoUpgradeMinorVersion?: boolean;
    enableAutomaticUpgrade?: boolean;
    forceUpdateTag?: string;
    instanceView?: MachineExtensionInstanceView;
    protectedSettings?: {
        [propertyName: string]: any;
    };
    provisioningState?: string;
    publisher?: string;
    settings?: {
        [propertyName: string]: any;
    };
    type?: string;
    typeHandlerVersion?: string;
}

Properties

autoUpgradeMinorVersion? enableAutomaticUpgrade? forceUpdateTag? instanceView? protectedSettings? provisioningState? 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.

OptionalinstanceView

instanceView?: MachineExtensionInstanceView

The machine extension instance view.

OptionalprotectedSettings

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

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

Optional ReadonlyprovisioningState

provisioningState?: string

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

Optionalpublisher

publisher?: string

The name of the extension handler publisher.

Optionalsettings

settings?: {
    [propertyName: string]: 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.

Settings

Member Visibility