MachineExtension interface

Package:

@azure/arm-connectedvmware

Describes a Machine Extension.

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.
id	Gets or sets the Id. NOTE: This property will not be serialized. It can only be populated by the server.
instanceView	The machine extension instance view.
location	Gets or sets the location.
name	Gets or sets the name. NOTE: This property will not be serialized. It can only be populated by the server.
protectedSettings	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
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.
systemData	The system data. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Gets or sets the Resource tags.
type	Gets or sets the type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
typeHandlerVersion	Specifies the version of the script handler.
typePropertiesType	Specifies the type of the extension; an example is "CustomScriptExtension".

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

id

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

id?: string

Property Value

string

instanceView

The machine extension instance view.

instanceView?: MachineExtensionPropertiesInstanceView

Property Value

MachineExtensionPropertiesInstanceView

location

Gets or sets the location.

location?: string

Property Value

string

name

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

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>

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>

systemData

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

systemData?: SystemData

Property Value

SystemData

tags

Gets or sets the Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

type

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

type?: string

Property Value

string

typeHandlerVersion

Specifies the version of the script handler.

typeHandlerVersion?: string

Property Value

string

typePropertiesType

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

typePropertiesType?: string

Property Value

string