Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MachineExtension

Package version

Describes a Machine Extension.

Hierarchy

  • MachineExtension

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 enableAutomaticUpgrade

enableAutomaticUpgrade: undefined | false | true

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.

Optional forceUpdateTag

forceUpdateTag: undefined | string

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

Optional id

id: undefined | string

Gets or sets the Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional instanceView

The machine extension instance view.

Optional location

location: undefined | string

Gets or sets the location.

Optional name

name: undefined | string

Gets or sets the name. NOTE: This property will not be serialized. It can only be populated by the server.

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 systemData

systemData: SystemData

The system data. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | {}

Gets or sets the Resource tags.

Optional type

type: undefined | string

Gets or sets the type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional typeHandlerVersion

typeHandlerVersion: undefined | string

Specifies the version of the script handler.

Optional typePropertiesType

typePropertiesType: undefined | string

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

Generated using TypeDoc