Share via

VirtualMachineExtension interface

  • Reference
Package:
@azure/arm-compute

Describes a Virtual Machine Extension.

Extends
ResourceWithOptionalLocation

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

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

The virtual machine extension instance view.
protectedSettings

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

The extensions protected settings that are passed by reference, and consumed from key vault
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.
suppressFailures

Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
typeHandlerVersion

Specifies the version of the script handler.
typePropertiesType

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

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

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

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

forceUpdateTag?: string

Property Value

string

instanceView

The virtual machine extension instance view.

instanceView?: VirtualMachineExtensionInstanceView

Property Value

VirtualMachineExtensionInstanceView

protectedSettings

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

protectedSettings?: any

Property Value

any

protectedSettingsFromKeyVault

The extensions protected settings that are passed by reference, and consumed from key vault

protectedSettingsFromKeyVault?: KeyVaultSecretReference

Property Value

KeyVaultSecretReference

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?: any

Property Value

any

suppressFailures

Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

suppressFailures?: boolean

Property Value

boolean

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

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From ResourceWithOptionalLocation.id

location

Resource location

location?: string

Property Value

string

Inherited From ResourceWithOptionalLocation.location

name

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

name?: string

Property Value

string

Inherited From ResourceWithOptionalLocation.name

tags

Resource tags

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

Property Value

{[propertyName: string]: string}

Inherited From ResourceWithOptionalLocation.tags

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ResourceWithOptionalLocation.type