Package version:

Interface VirtualMachineExtensionUpdate

Describes a Virtual Machine Extension.

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

Hierarchy (view full)

Properties

autoUpgradeMinorVersion? enableAutomaticUpgrade? forceUpdateTag? protectedSettings? protectedSettingsFromKeyVault? publisher? settings? suppressFailures? 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 of the extension available.

OptionalforceUpdateTag

forceUpdateTag?: string

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

OptionalprotectedSettings

protectedSettings?: any

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

OptionalprotectedSettingsFromKeyVault

protectedSettingsFromKeyVault?: KeyVaultSecretReference

The extensions protected settings that are passed by reference, and consumed from key vault

Optionalpublisher

publisher?: string

The name of the extension handler publisher.

Optionalsettings

settings?: any

Json formatted public settings for the extension.

OptionalsuppressFailures

suppressFailures?: boolean

Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

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