Edit

Install extensions

  • Article

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019 | TFS 2018

Learn how to install, assign, disable, and uninstall extensions, which add new features and capabilities for Azure DevOps.

For more information about extensions, see the developing and publishing overviews.

Prerequisites

  • To install extensions, you must be a member of the Project Collection Administrators group. Organization owners are automatically members of this group. If you don't have permissions, you can request extensions instead or look up a project collection administrator.
  • Private extensions must be shared with your organization to be installed. Check out the publishing documentation for information on how to share private extensions.
  • Only members of the Project Collection Administrators group or who have "Edit collection-level information" permissions can install extensions. Organization owners are automatically members of this group. If you don't have permissions, you can request extensions instead or look up a project collection administrator.

Note

To use an existing Azure subscription for billing, you must have at least co-administrator permissions for that subscription. If you don't have permissions, an Azure Account Administrator or Service Administrator can add you as co-administrator to the Azure subscription in the Azure portal.

Your project collection reuses your Azure subscription for future Marketplace purchases. Where can I find more info about Azure billing?

Install an extension

Install an extension to your organization by doing the following steps.

  1. Sign in to your organization (https://dev.azure.com/{yourorganization}).

  2. Select the shopping bag icon, and then select Browse Marketplace.

    Screenshot showing highlighted shopping bag icon and Browse Marketplace button selection.

  3. Find the extension that you want to install and select Get it free.

    Screenshot showing red square highlighting Get it free button.

  4. Select your organization from the dropdown menu, and then select Install to install the extension.

    Select organization for this extension

Your extension is now installed! You can now go to your organization to use your extension. Also, tell your team about this extension, so they can start using its capabilities.

Extension installed

  1. Open your Azure DevOps Server home page (https://{server}:DefaultCollection).

  2. Open the extensions menu and choose Browse Marketplace.

    Browse Marketplace

  3. Find the extension that you want to install. Use the search box to filter the list of extensions.

    Select an extension

  4. Select the extension and choose Get or Get it free. Or, for some third-party extensions, choose Get Started to show pricing information and extension-specific installation instructions.

    Get the extension

    If you don't have permission to install the extension, you can request an administrator to install it for you. Your request gets stored in Azure DevOps Server and is ready for attention from an administrator.

  5. Select the project collection where you want to install this extension and choose Install.

    Select project collection and choose Install.

  6. After installation is complete, go to the project collection or return to the Marketplace to find other extensions.

    Installation done

  1. From your Azure DevOps Server home page (https://{server}:8080/tfs/), go to the project collection where you want to install the extension.

  2. Open the extensions menu and choose Browse Marketplace.

    Screenshot showing highlighted Browse Marketplace button.

  3. Find and select the extension that you want to install.

    Screenshot showing selected extension example.

  4. Select the extension, and then Install.

  5. Confirm the project collection that you want to install this extension to.

    Selection showing Project collection.

  6. Finish installing your extension.

  7. Assign the extension to users who need access. Otherwise, you can go to your project collection to use your extension. Tell your team about this extension, so they can start using its capabilities too.

    Screenshot showing installed extension confirmation.

Install extensions when disconnected

When you're disconnected from Azure DevOps Server, you can install free and preview extensions. First, you download the extension, then upload it to Azure DevOps Server, and then install it in a project collection.

Download from the Marketplace

  1. Sign in to the Marketplace > Azure DevOps.

  2. Find the extension that you want to install.

    Screenshot showing search for extension in the Marketplace.

    Screenshot showing search for extension.

  3. Download and save your extension.

    Screenshot showing download extension.

Upload extension to Azure DevOps

  1. Browse for your downloaded extensions (https://{server}:8080/tfs/_gallery).

  2. Select Manage extensions.

    Screenshot showing selection, Manage extensions button.

  3. Select Upload new extension.

    Screenshot showing selection, Upload new extension button.

    Why can't I upload extensions?

Tip

The maximum size for upload is 25MB. If you can't work around this requirement, Report a problem in the Developer Community.

Install extension in your project collection

  1. Select and install the extension that you uploaded.

    Screenshot showing extension selection.

  2. Choose the project collection where you want to install the extension.

    Screenshot showing Continue button selection.

  3. Review the permissions that the extension gets when it's installed. Finish installing your extension.

    Screenshot showing review of permissions granted to the extension.

    You can now go to your project collection to use your extension. Tell your team about this extension, so they can start using its capabilities too.

Install preinstalled extensions (first-party) for disconnected TFS

Note

This section is only for adding pre-installed extensions (first-party), if you're installing extensions that aren't pre-installed with TFS, see the section Install extensions when disconnected.

For first-party extensions that come preinstalled with TFS, here's an alternate method of installation that prevents compatibility issues.

  1. Hover over the shopping bag and select Manage extensions

    Select Manage extensions.

  2. Once on the Extensions page, select Browse local extensions

    On the Extensions page, Browse local extensions

  3. Scroll down until you see the "Plan and track" category, which includes Delivery Plans. Select Delivery Plans.

    Choose your extension

  4. You're redirected to a local extension page for Delivery Plans where you select Install. Installation works when you're online and offline.

    Delivery plans extension gallery

Several extensions are preinstalled in the local extensions gallery. Users can install these extensions without requiring an external connection to Marketplace or the internet.

Tip

Extensions that have previously been installed from Marketplace appear in the local gallery automatically so that they can easily be installed into other project collections.

  1. Open the extensions menu and choose Manage Extensions.

    On the extensions menu, choose Manage extensions.

  2. In the Extensions page, choose Browse local extensions

    Browse local extensions

  3. Choose the extension you want to install.

    Choose a local extension

  4. Select the project collection where you want to install this extension and choose Install.

    Select the project collection where you want to install this extension and choose Install.

  5. After installation is complete, go to the project collection or return to the Marketplace to find other extensions.

    Installation done

Uninstall or disable an extension

  1. Sign in to your organization (https://dev.azure.com/{yourorganization}).

  2. Select gear icon Organization settings.

    Open Organization settings

  3. Select Extensions, and then select the extension that you want to uninstall or disable.

    Select uninstall or disable for extension

  4. Select Uninstall or select the ellipses (...), and then select Disable.

    Disable or uninstall extension

To uninstall extensions in a collection, perform the following steps.

  1. Go to the local gallery management portal (http://{server}:8080/tfs/_gallery/manage).

  2. For the wanted extension, select the ellipses (...), and then select Remove.

    Remove extension

Enable or list extensions through the command line

Enable an extension with the az devops extension enable command. To get started, see Get started with Azure DevOps CLI.

az devops extension enable --extension-name
                           --publisher-name
                           [--org]

Parameters - enable extension

  • extension-name: The name of the extension to enable.
  • publisher-name: The name of the extension publisher.
  • org: Azure DevOps organization URL. Configure the default organization with az devops configure -d organization=ORG_URL. Required if not configured as default or picked up using git config. Example: --org https://dev.azure.com/MyOrganizationName/.

Example - enable extension

The following command enables the Timetracker extension and shows the result in table format.

az devops extension enable --extension-name Timetracker --publisher-name 7pace --output table

Publisher Id    Extension Id    Name         Version      Last Updated     States
--------------  --------------  -----------  -----------  ---------------  --------
7pace           Timetracker     Timetracker  5.0.1.34507  2019-11-13       none

List extensions

You can list the extensions that are installed in your organization with the az devops extension list command. To get started, see Get started with Azure DevOps CLI.

az devops extension list [--include-built-in {false, true}]
                         [--include-disabled {false, true}]
                         [--org]

Optional parameters - list extensions

  • include-built-in: Include the built-in extensions. Accepted values are true (default) and false.
  • include-disabled: Include the disabled extensions. Accepted values are true (default) and false.
  • org: Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up using git config. Example: --org https://dev.azure.com/MyOrganizationName/.

Example - list extensions

The following command lists extensions in your organization. It excludes the disabled and built-in extensions, and shows the results in table format.

az devops extension list --include-built-in false --include-disabled false -output table

Publisher Id    Extension Id             Name                     Version              Last Updated     States         		 Flags
--------------  -----------------------  -----------------------  -------------------  ---------------  -----------------------  -------
ms              vss-analytics            Analytics                18.160.0.2130149925  2019-11-22       multiVersion, truste...  trusted
ms              vss-code-search          Code Search              18.160.0.1640944814  2019-11-22       multiVersion, truste...  trusted
ms              vss-plans                Delivery Plans           18.160.0.1266795967  2019-11-25       multiVersion, truste...  trusted
ms-eswm         dependencytracker        Dependency Tracker       2.1910.12801         2019-10-28       none
ms-devlabs      workitem-feature-tim...  Feature timeline and...  0.0.357              2019-10-14       none
AgileParts      gantt                    GANTT chart              1.0.79               2019-10-25       none
gordon-bee...   github                   GitHub Widget            0.10.0               2016-03-16       none
ms-devlabs      vsts-extensions-mult...  Multivalue control       2.2.26               2019-11-15       none
agile-exte...   product-vision           Product Vision           2.0.6                2019-06-04       none
mohitbagra      related-workitems        Related Work items       2.0.4                2017-11-12       none
YodLabs         TagsManager2             Tags Manager             0.9.31               2019-02-04       none
ms-devlabs      team-calendar            Team Calendar            2.0.15               2019-11-01       none
ms              vss-testmanager-web      Test Manager for TFS...  18.160.0.2130893445  2019-11-25       multiVersion, truste...  trusted
mmanela         vsts-workitem-recent...  Who recently viewed ...  1.0.4                2019-03-22       none
ottostreif...   wiql-editor              Wiql Editor              2.0.90               2019-06-21       none
mohitbagra      workitem-checklist       Work item checklist      3.2.4                2019-06-24       none
mohitbagra      witoneclickactions       Work item form one c...  2.3.2                2018-04-03       none
ms-devlabs      WorkItemVisualizatio...  Work Item Visualizat...  1.4.64               2018-04-03       none

List extension information

You can list the details about an extension with the az devops extension show command. To get started, see Get started with Azure DevOps CLI.

az devops extension show --extension-name
                         --publisher-name
                         [--org]

Parameters - list extension information

  • extension-name: The name of the extension.
  • publisher-name: The name of the extension publisher.
  • org: Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up using git config. Example: --org https://dev.azure.com/MyOrganizationName/.

Example - list extension information

The following command shows information about the Timetracker extension in table format.

az devops extension show --extension-name Timetracker --publisher-name 7pace --output table

Publisher Id    Extension Id    Name         Version      Last Updated     States
--------------  --------------  -----------  -----------  ---------------  --------
7pace           Timetracker     Timetracker  5.0.1.34507  2019-11-13       disabled

Frequently asked questions (FAQs)

Q: Why don't I see my organization from the Marketplace installation page?

A: If you don't see your organization when buying from the Azure DevOps Marketplace, try the following steps:

  1. Check the identity that you use to sign in to the Visual Studio Marketplace. In the upper-right corner, select your user name to view your profile.
  2. On the left, make sure your email address and directory are correct.
  3. Close all browser windows.
  4. Open a private or incognito browsing session.
  5. Sign in to the Visual Studio Marketplace. Use the identity of a user in the organization that you want.

Tip

Azure DevOps might ask you to choose between "work or school account" or "personal account". If so, then you used an email address that's the same for a Microsoft account and a "work or school account" that your organization manages in Azure Active Directory. Although these identities have the same email address, they're still separate identities with different profiles, security settings, and permissions. Choose the identity for the user in the organization that you want to select.

Q: Why can't I install an extension?

A: You can't install extensions for one of the following reasons.

Q: Why can't users access extension features?

A: Users can't access an extension for one of the following reasons:

  • Most extensions require that users have at least Basic access, not Stakeholder. For example, you can install the free Code Search extension, but each user must have at least Basic access to search for code. To help your team improve app quality, you can install the free Test & Feedback extension. You experience different capabilities, based on your access level and whether you work offline or connected to Azure DevOps Services or on-premises Azure DevOps Server. For more information, see the extension's description in the Visual Studio Marketplace, Azure DevOps tab.

  • If you're using an organization and you started a free extension trial, your trial might have expired. To check whether your trial expired:

    1. On your organization toolbar, select Users.
    2. Go to the extension pane.
    3. Check for an expiration message to find if or when your extension expired.

  • If you're using an organization and you paid for this extension, make sure that you assigned this extension to users.

    1. On your organization toolbar, go to Users.
    2. Go to the extension pane.
    3. Check whether the extension is assigned to the user. If it isn't, assign the extension to the user.

For more information, see Assign extensions to users.

Q: What happened to my preview extension?

A: Your extension may have been moved out of preview. After a preview period, an extension longer is generally available as a paid extension. A grace period may be offered before you have to buy the extension. All preview extensions automatically convert to a free trial before you have to buy the extension.

Q: Why can't I install extensions for Azure DevOps Server? (on-premises)

A: You can't install extensions for Azure DevOps Server for one of the following reasons:

  • You must be a member of the Project Collection Administrators group or have the Edit collection-level information permission set to Allow in the project collection where you want to install extensions. If you don't have permissions, you can request extensions instead.
  • You might get an error that says you already installed or requested the extension. If so, check with a member of the Project Collection Administrators group and ask them to assign the extension to you. For more information, see Request an increase in permission levels.

Q: Why don't I see the project collection I want? (on-premises)

A: You must be a member of your project collection. Follow these steps to check your identity that you use to sign in to the Marketplace.

  1. On your Azure DevOps Server web portal home page (https://{server}:8080/tfs/), go to the top-right corner of the page, and select your user name to view your profile.

  2. On the left side of your profile, make sure that your email address and directory are correct.

  3. Close all browser windows.

  4. Open a private or incognito browsing session.

  5. Sign in to your Azure DevOps Server home page (https://{server}:8080/tfs/) with the identity that's a user in the project collection where you want to install the extension.

    Azure DevOps might ask you to choose between a "work or school organization" or "personal account." This message means that you used an email address that's the same for a Microsoft account and a "work or school account" managed by your organization in Azure Active Directory. Although these identities have the same email address, they're still separate identities with different profiles, security settings, and permissions. Choose the identity that's the user in your project collection.

  6. From your project collection, go to the Marketplace.

Q: Why doesn't the extension that I want show a download button? (on-premises)

A: Some extensions work only with Azure DevOps Services for one of the following reasons:

  • The extension uses Azure DevOps features that aren't released yet for Azure DevOps Server.
  • The extension manifest indicates that the extension is available only for Azure DevOps Services (targets = Microsoft.Visualstudio.Services.Cloud).
  • The extension manifest indicates that the extension is an integration (targets = Microsoft.Visualstudio.Services.Integration).

Q: Why can't I upload extensions to Azure DevOps Server? (on-premises)

A: You must be a member of the Team Foundation Administrators group. You must also have Edit instance-level information permissions for the Azure DevOps Server where you want to upload extensions.

Q: How do I get support for Azure subscriptions, billing, and Marketplace?

A: Depending on the support you need, choose from the following articles:

Note

The Azure DevOps support team is unable to support Visual Studio Marketplace extensions. To get support on marketplace extensions, locate the extension you're using in the Visual Studio Marketplace. On the extension page, you can find a link to the GitHub repository where you can create an issue, or a link to get community support.

Next steps

Manage extension permissions