ExtensionParameters interface

Package:

@azure/arm-azurestackhci

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

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 available.
forceUpdateTag	How the extension handler should be forced to update even if the extension configuration has not changed.
protectedSettings	Protected settings (may contain secrets).
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. Latest version would be used if not specified.

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 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

Protected settings (may contain secrets).

protectedSettings?: any

Property Value

any

publisher

The name of the extension handler publisher.

publisher?: string

Property Value

string

settings

Json formatted public settings for the extension.

settings?: any

Property Value

any

type

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

type?: string

Property Value

string

typeHandlerVersion

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

typeHandlerVersion?: string

Property Value

string