Package version:

Interface VirtualMachineScaleSetVMExtension

Describes a VMSS VM Extension.

interface VirtualMachineScaleSetVMExtension {
    autoUpgradeMinorVersion?: boolean;
    enableAutomaticUpgrade?: boolean;
    forceUpdateTag?: string;
    id?: string;
    instanceView?: VirtualMachineExtensionInstanceView;
    location?: string;
    name?: string;
    protectedSettings?: any;
    protectedSettingsFromKeyVault?: KeyVaultSecretReference;
    provisionAfterExtensions?: string[];
    provisioningState?: string;
    publisher?: string;
    settings?: any;
    suppressFailures?: boolean;
    type?: string;
    typeHandlerVersion?: string;
    typePropertiesType?: string;
}

Hierarchy (view full)

Properties

autoUpgradeMinorVersion? enableAutomaticUpgrade? forceUpdateTag? id? instanceView? location? name? protectedSettings? protectedSettingsFromKeyVault? provisionAfterExtensions? provisioningState? publisher? settings? suppressFailures? type? typeHandlerVersion? typePropertiesType?

Properties

OptionalautoUpgradeMinorVersion

autoUpgradeMinorVersion?: boolean

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.

OptionalenableAutomaticUpgrade

enableAutomaticUpgrade?: boolean

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

OptionalforceUpdateTag

forceUpdateTag?: string

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

Optional Readonlyid

id?: string

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

OptionalinstanceView

instanceView?: VirtualMachineExtensionInstanceView

The virtual machine extension instance view.

Optionallocation

location?: string

The location of the extension.

Optional Readonlyname

name?: string

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

OptionalprotectedSettings

protectedSettings?: any

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

OptionalprotectedSettingsFromKeyVault

protectedSettingsFromKeyVault?: KeyVaultSecretReference

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

OptionalprovisionAfterExtensions

provisionAfterExtensions?: string[]

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

Optional ReadonlyprovisioningState

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

Optionalpublisher

publisher?: string

The name of the extension handler publisher.

Optionalsettings

settings?: any

Json formatted public settings for the extension.

OptionalsuppressFailures

suppressFailures?: boolean

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.

Optional Readonlytype

type?: string

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

OptionaltypeHandlerVersion

typeHandlerVersion?: string

Specifies the version of the script handler.

OptionaltypePropertiesType

typePropertiesType?: string

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

Settings

Member Visibility