SetExtensionDeprecationRequest interface

Package:
azure-devops-extension-api

Request payload for setting (creating or updating) an extension's deprecation state. Exposes only the fields a caller may specify; server-resolved data (such as the replacement's display name) is returned on the extension query response, not accepted here.

Properties

customMessage

Optional publisher-provided message shown to users of the deprecated extension.
effectiveDate

Date on which the deprecation takes effect. Defaults to the current time (server-side) when unset.
effectiveFromProductVersion

Optional Visual Studio product version (major.minor) at or after which the extension is deprecated.
replacementName

Optional fully-qualified name ("publisherName.extensionName") of the recommended replacement extension. Null or empty indicates there is no replacement.

Property Details

customMessage

Optional publisher-provided message shown to users of the deprecated extension.

customMessage: string

Property Value

string

effectiveDate

Date on which the deprecation takes effect. Defaults to the current time (server-side) when unset.

effectiveDate: Date

Property Value

Date

effectiveFromProductVersion

Optional Visual Studio product version (major.minor) at or after which the extension is deprecated.

effectiveFromProductVersion: string

Property Value

string

replacementName

Optional fully-qualified name ("publisherName.extensionName") of the recommended replacement extension. Null or empty indicates there is no replacement.

replacementName: string

Property Value

string