PatchExtension interface

The Extension Patch Request object.

Properties

autoUpgradeMinorVersion

Flag to note if this extension participates in auto upgrade of minor version, or not.

autoUpgradeMode

The upgrade mode for auto upgrade. The default is "compatible".

configurationProtectedSettings

Configuration settings that are sensitive, as name-value pairs for configuring this extension.

configurationSettings

Configuration settings, as name-value pairs for configuring this extension.

releaseTrain

ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.

version

Version of the extension for this extension, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'.

Property Details

autoUpgradeMinorVersion

Flag to note if this extension participates in auto upgrade of minor version, or not.

autoUpgradeMinorVersion?: boolean

Property Value

boolean

autoUpgradeMode

The upgrade mode for auto upgrade. The default is "compatible".

autoUpgradeMode?: string

Property Value

string

configurationProtectedSettings

Configuration settings that are sensitive, as name-value pairs for configuring this extension.

configurationProtectedSettings?: Record<string, string>

Property Value

Record<string, string>

configurationSettings

Configuration settings, as name-value pairs for configuring this extension.

configurationSettings?: Record<string, string>

Property Value

Record<string, string>

releaseTrain

ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.

releaseTrain?: string

Property Value

string

version

Version of the extension for this extension, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'.

version?: string

Property Value

string