VirtualMachineExtensionImageProperties interface

Describes the properties of a Virtual Machine Extension Image.

Properties

computeRole

The type of role (IaaS or PaaS) this extension supports.

extensionFeatureMetadata

Additional metadata about extension features, including compliance and capability tags.

handlerSchema

The schema defined by publisher, where extension consumers should provide settings in a matching schema.

operatingSystem

The operating system this extension supports.

releaseCategory

Categorizes the type of change introduced (e.g., BugFix, SecurityFix, CompatibilityUpdate, NewFeature, Other).

releaseNotes

Summary of changes or updates in this extension version.

runProfile

Specifies when and how the extension should be executed.

supportsMultipleExtensions

Whether the handler can support multiple extensions.

urgencyLevel

Indicates the urgency level for applying this extension update.

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.

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