MachineExtensionUpdate interface
Describes a Machine Extension Update.
- 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 available. |
force |
How the extension handler should be forced to update even if the extension configuration has not changed. |
protected |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
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. |
Inherited Properties
tags | Resource tags |
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?: boolean
Property Value
boolean
enableAutomaticUpgrade
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
enableAutomaticUpgrade?: boolean
Property Value
boolean
forceUpdateTag
How the extension handler should be forced to update even if the extension configuration has not changed.
forceUpdateTag?: string
Property Value
string
protectedSettings
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettings?: {[propertyName: string]: any}
Property Value
{[propertyName: string]: any}
publisher
The name of the extension handler publisher.
publisher?: string
Property 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?: string
Property Value
string
typeHandlerVersion
Specifies the version of the script handler.
typeHandlerVersion?: string
Property Value
string
Inherited Property Details
tags
Resource tags
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From ResourceUpdate.tags