VirtualMachineScaleSetExtensionProperties Class

Describes the properties of a Virtual Machine Scale Set Extension.

Constructor

VirtualMachineScaleSetExtensionProperties()

Variables

Name	Description
force_update_tag	str If a value is provided and is different from the previous value, the extension handler will 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".
type_handler_version	str Specifies the version of the script handler.
auto_upgrade_minor_version	bool 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.
enable_automatic_upgrade	bool 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.
protected_settings	Any The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisioning_state	str The provisioning state, which only appears in the response.
provision_after_extensions	list[str] Collection of extension names after which this extension needs to be provisioned.
suppress_failures	bool 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.
protected_settings_from_key_vault	<xref:<xref:"KeyVaultSecretReference">> The extensions protected settings that are passed by reference, and consumed from key vault.

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

If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.

forceUpdateTag: str

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 version of the script handler.

typeHandlerVersion: str