Share via

VirtualMachineExtension Class

  • Reference

Describes a Virtual Machine Extension.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.compute.v2019_03_01.models._models_py3.Resource
VirtualMachineExtension

Constructor

VirtualMachineExtension(*, location: str, tags: Dict[str, str] | None = None, force_update_tag: str | None = None, publisher: str | None = None, type_properties_type: str | None = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, instance_view: _models.VirtualMachineExtensionInstanceView | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
force_update_tag
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_properties_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.
settings
<xref:JSON>

Json formatted public settings for the extension.
protected_settings
<xref:JSON>

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

The virtual machine extension instance view.

Variables

Name Description
id
str

Resource Id.
name
str

Resource name.
type
str

Resource type.
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
force_update_tag
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_properties_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.
settings
<xref:JSON>

Json formatted public settings for the extension.
protected_settings
<xref:JSON>

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.
instance_view
VirtualMachineExtensionInstanceView

The virtual machine extension instance view.