MachineExtensionProperties interface
Describes the properties of a Machine Extension.
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 available. |
| force |
How the extension handler should be forced to update even if the extension configuration has not changed. |
| instance |
The 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 type of the extension; an example is "CustomScriptExtension". |
| type |
Specifies the version of the script handler. |
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 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 machine extension instance view.
instanceView?: MachineExtensionInstanceViewProperty Value
protectedSettings
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettings?: {[propertyName: string]: any}Property Value
{[propertyName: string]: any}
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?: {[propertyName: string]: any}Property Value
{[propertyName: string]: any}
type
Specifies the type of the extension; an example is "CustomScriptExtension".
type?: stringProperty Value
string
typeHandlerVersion
Specifies the version of the script handler.
typeHandlerVersion?: stringProperty Value
string