Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MachineExtensionProperties

Package version

Describes the properties of a Machine Extension.

Hierarchy

  • MachineExtensionProperties

Index

Properties

Optional autoUpgradeMinorVersion

autoUpgradeMinorVersion: undefined | false | true

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.

Optional forceUpdateTag

forceUpdateTag: undefined | string

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

Optional instanceView

The machine extension instance view.

Optional protectedSettings

protectedSettings: Record<string, unknown>

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

Optional provisioningState

provisioningState: undefined | 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.

Optional publisher

publisher: undefined | string

The name of the extension handler publisher.

Optional settings

settings: Record<string, unknown>

Json formatted public settings for the extension.

Optional type

type: undefined | string

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

Optional typeHandlerVersion

typeHandlerVersion: undefined | string

Specifies the version of the script handler.

Generated using TypeDoc