Share via


VMExtension Class

The configuration for virtual machine extensions.

Constructor

VMExtension(*args: Any, **kwargs: Any)

Variables

Name Description
name
str

The name of the virtual machine extension. Required.

publisher
str

The name of the extension handler publisher. Required.

type
str

The type of the extensions. Required.

type_handler_version
str

The version of script handler.

auto_upgrade_minor_version

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

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.

provision_after_extensions

The collection of extension names.

Attributes

auto_upgrade_minor_version

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.

auto_upgrade_minor_version: bool | None

enable_automatic_upgrade

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

enable_automatic_upgrade: bool | None

name

The name of the virtual machine extension. Required.

name: str

protected_settings

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

protected_settings: Any | None

provision_after_extensions

The collection of extension names.

provision_after_extensions: list[str] | None

publisher

The name of the extension handler publisher. Required.

publisher: str

settings

JSON formatted public settings for the extension.

settings: Any | None

type

The type of the extensions. Required.

type: str

type_handler_version

The version of script handler.

type_handler_version: str | None