VirtualMachineExtension Class

Describes a Virtual Machine Extension.

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

Inheritance

azure.mgmt.compute.v2022_11_01.models._models_py3.ResourceWithOptionalLocation

VirtualMachineExtension

Constructor

VirtualMachineExtension(*, location: str | None = None, 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, enable_automatic_upgrade: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, instance_view: _models.VirtualMachineExtensionInstanceView | None = None, suppress_failures: bool | None = None, protected_settings_from_key_vault: _models.KeyVaultSecretReference | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location.
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.
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	<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.
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	KeyVaultSecretReference The extensions protected settings that are passed by reference, and consumed from key vault.

Variables

Name	Description
location	str Resource location.
id	str Resource Id.
name	str Resource name.
type	str Resource type.
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.
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	<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.
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	KeyVaultSecretReference The extensions protected settings that are passed by reference, and consumed from key vault.