VirtualMachineExtensionImageProperties interface
Describes the properties of a Virtual Machine Extension Image.
Properties
| compute |
The type of role (IaaS or PaaS) this extension supports. |
| extension |
Additional metadata about extension features, including compliance and capability tags. |
| handler |
The schema defined by publisher, where extension consumers should provide settings in a matching schema. |
| operating |
The operating system this extension supports. |
| release |
Categorizes the type of change introduced (e.g., BugFix, SecurityFix, CompatibilityUpdate, NewFeature, Other). |
| release |
Summary of changes or updates in this extension version. |
| run |
Specifies when and how the extension should be executed. |
| supports |
Whether the handler can support multiple extensions. |
| urgency |
Indicates the urgency level for applying this extension update. |
| vm |
Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS. |
Property Details
computeRole
The type of role (IaaS or PaaS) this extension supports.
computeRole: string
Property Value
string
extensionFeatureMetadata
Additional metadata about extension features, including compliance and capability tags.
extensionFeatureMetadata?: ExtensionFeatureMetadata
Property Value
handlerSchema
The schema defined by publisher, where extension consumers should provide settings in a matching schema.
handlerSchema: string
Property Value
string
operatingSystem
The operating system this extension supports.
operatingSystem: string
Property Value
string
releaseCategory
Categorizes the type of change introduced (e.g., BugFix, SecurityFix, CompatibilityUpdate, NewFeature, Other).
releaseCategory?: string
Property Value
string
releaseNotes
Summary of changes or updates in this extension version.
releaseNotes?: string
Property Value
string
runProfile
Specifies when and how the extension should be executed.
runProfile?: string
Property Value
string
supportsMultipleExtensions
Whether the handler can support multiple extensions.
supportsMultipleExtensions?: boolean
Property Value
boolean
urgencyLevel
Indicates the urgency level for applying this extension update.
urgencyLevel?: string
Property Value
string
vmScaleSetEnabled
Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
vmScaleSetEnabled?: boolean
Property Value
boolean