VirtualMachineExtensionProperties Class

Describes the properties of a Virtual Machine Extension.

Constructor

VirtualMachineExtensionProperties()

Variables

Name Description
forceUpdateTag
str

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

publisher
str

The name of the extension handler publisher.

type
str

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

typeHandlerVersion
str

Specifies the Major.Minor version of the script handler. Customer is able to specify only the Major.Minor version of an extension, Azure platform will deliver the latest Patch.Hotfix version in the Major.Minor series.

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.

settings
Any

Json formatted public settings for the extension.

protectedSettings
Any

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

provisioningState
str

The provisioning state, which only appears in the response.

instanceView
<xref:<xref:"VirtualMachineExtensionInstanceView">>

The virtual machine extension instance view.

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.

protectedSettingsFromKeyVault
<xref:<xref:"KeyVaultSecretReference">>

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.

Attributes

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: bool

enableAutomaticUpgrade

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

enableAutomaticUpgrade: bool

forceUpdateTag

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

forceUpdateTag: str

instanceView

The virtual machine extension instance view.

instanceView: VirtualMachineExtensionInstanceView

protectedSettings

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

protectedSettings: Any

protectedSettingsFromKeyVault

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

protectedSettingsFromKeyVault: KeyVaultSecretReference

provisionAfterExtensions

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

provisionAfterExtensions: list[str]

provisioningState

The provisioning state, which only appears in the response.

provisioningState: str

publisher

The name of the extension handler publisher.

publisher: str

settings

Json formatted public settings for the extension.

settings: 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: bool

type

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

type: str

typeHandlerVersion

Specifies the Major.Minor version of the script handler. Customer is able to specify only the Major.Minor version of an extension, Azure platform will deliver the latest Patch.Hotfix version in the Major.Minor series.

typeHandlerVersion: str