VMExtension Class
The configuration for virtual machine extensions.
All required parameters must be populated in order to send to server.
Constructor
VMExtension(*, name: str, publisher: str, type: str, 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, provision_after_extensions: List[str] | None = None, **kwargs: Any)
Keyword-Only Parameters
Name | Description |
---|---|
name
|
The name of the virtual machine extension. Required. |
publisher
|
The name of the extension handler publisher. Required. |
type
|
The type of the extensions. Required. |
type_handler_version
|
The version of script handler. Default value: None
|
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. Default value: 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. Default value: None
|
settings
|
<xref:JSON>
JSON formatted public settings for the extension. Default value: None
|
protected_settings
|
<xref:JSON>
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Default value: None
|
provision_after_extensions
|
Collection of extension names after which this extension needs to be provisioned. Default value: None
|
Variables
Name | Description |
---|---|
name
|
The name of the virtual machine extension. Required. |
publisher
|
The name of the extension handler publisher. Required. |
type
|
The type of the extensions. Required. |
type_handler_version
|
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
|
<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. |
provision_after_extensions
|
Collection of extension names after which this extension needs to be provisioned. |