Share via

VmssExtension interface

  • Reference
Package:
@azure/arm-servicefabricmanagedclusters

Specifies set of extensions that should be installed onto the virtual machines.

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 of the extension available.
forceUpdateTag

If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
name

The name of the extension.
protectedSettings

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

Collection of extension names after which this extension needs to be provisioned.
provisioningState

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

The name of the extension handler publisher.
settings

Json formatted public settings for the extension.
setupOrder

Indicates the setup order for the extension.
type

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

Specifies the version of the script handler.

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 of the extension available.

enableAutomaticUpgrade?: boolean

Property Value

boolean

forceUpdateTag

If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.

forceUpdateTag?: string

Property Value

string

name

The name of the extension.

name: string

Property Value

string

protectedSettings

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

protectedSettings?: Record<string, unknown>

Property Value

Record<string, unknown>

provisionAfterExtensions

Collection of extension names after which this extension needs to be provisioned.

provisionAfterExtensions?: string[]

Property Value

string[]

provisioningState

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

provisioningState?: string

Property Value

string

publisher

The name of the extension handler publisher.

publisher: string

Property Value

string

settings

Json formatted public settings for the extension.

settings?: Record<string, unknown>

Property Value

Record<string, unknown>

setupOrder

Indicates the setup order for the extension.

setupOrder?: string[]

Property Value

string[]

type

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

type: string

Property Value

string

typeHandlerVersion

Specifies the version of the script handler.

typeHandlerVersion: string

Property Value

string