VirtualMachineExtension interface
Describes a Virtual Machine Extension.
- Extends
Properties
| auto |
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 |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
| force |
How the extension handler should be forced to update even if the extension configuration has not changed. |
| instance |
The virtual machine extension instance view. |
| protected |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
| provisioning |
The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server. |
| publisher | The name of the extension handler publisher. |
| settings | Json formatted public settings for the extension. |
| type |
Specifies the version of the script handler. |
| type |
Specifies the type of the extension; an example is "CustomScriptExtension". |
Inherited Properties
| id | Resource Id NOTE: This property will not be serialized. It can only be populated by the server. |
| location | Resource location |
| name | Resource name NOTE: This property will not be serialized. It can only be populated by the server. |
| tags | Resource tags |
| type | Resource type NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
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?: booleanProperty Value
boolean
enableAutomaticUpgrade
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
enableAutomaticUpgrade?: booleanProperty Value
boolean
forceUpdateTag
How the extension handler should be forced to update even if the extension configuration has not changed.
forceUpdateTag?: stringProperty Value
string
instanceView
The virtual machine extension instance view.
instanceView?: VirtualMachineExtensionInstanceViewProperty Value
protectedSettings
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettings?: Record<string, unknown>Property Value
Record<string, unknown>
provisioningState
The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: stringProperty Value
string
publisher
The name of the extension handler publisher.
publisher?: stringProperty Value
string
settings
Json formatted public settings for the extension.
settings?: Record<string, unknown>Property Value
Record<string, unknown>
typeHandlerVersion
Specifies the version of the script handler.
typeHandlerVersion?: stringProperty Value
string
typePropertiesType
Specifies the type of the extension; an example is "CustomScriptExtension".
typePropertiesType?: stringProperty Value
string
Inherited Property Details
id
Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
id?: stringProperty Value
string
Inherited From Resource.id
location
name
Resource name NOTE: This property will not be serialized. It can only be populated by the server.
name?: stringProperty Value
string
Inherited From Resource.name
tags
Resource tags
tags?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}
Inherited From Resource.tags
type
Resource type NOTE: This property will not be serialized. It can only be populated by the server.
type?: stringProperty Value
string
Inherited From Resource.type