Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InstalledExtensionsApi

Hierarchy

  • InstalledExtensionsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

getInstalledExtensionByName

  • getInstalledExtensionByName(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<InstalledExtension>

  • Get an installed extension by its publisher and extension name.

    Parameters

    • params: object
      • apiVersion: string
      • Optional assetTypes?: string
      • extensionName: string
      • organization: string
      • publisherName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<InstalledExtension>

getInstalledExtensions

  • List the installed extensions in the account / project collection.

    Parameters

    • params: object
      • apiVersion: string
      • Optional assetTypes?: string
      • Optional includeDisabledExtensions?: boolean
      • Optional includeErrors?: boolean
      • Optional includeInstallationIssues?: boolean
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<InstalledExtension>>

installExtensionByName

  • installExtensionByName(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<InstalledExtension>

  • Install the specified extension into the account / project collection.

    Parameters

    • params: object
      • apiVersion: string
      • extensionName: string
      • organization: string
      • publisherName: string
      • version: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<InstalledExtension>

uninstallExtensionByName

  • uninstallExtensionByName(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Uninstall the specified extension from the account / project collection.

    Parameters

    • params: object
      • apiVersion: string
      • extensionName: string
      • organization: string
      • publisherName: string
      • Optional reason?: string
      • Optional reasonCode?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

updateInstalledExtension

  • updateInstalledExtension(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<InstalledExtension>

  • Update an installed extension. Typically this API is used to enable or disable an extension.

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<InstalledExtension>

Generated using TypeDoc