Get extensions for Team Foundation Server (TFS)

Last Update: 7/29/2017

TFS 2017 | TFS 2015 Update 3

To add new features and capabilities to your TFS, install extensions from the Visual Studio Marketplace.

TIP

To learn about building your own TFS extensions, see developing and publishing extensions.

Install extensions while connected to TFS

What do I need to install extensions?

Project collection administrators with Edit collection-level information permissions can install extensions. If you don't have permissions, you can request extensions instead.

For paid extensions, you'll need an Azure subscription to bill your purchase. If you don't have an Azure subscription, you can create a new subscription when you make your first purchase.

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, have an Azure Account Administrator or Service Administrator go to the Azure classic portal and add you as Co-administrator to the Azure subscription that you want to use for billing. Co-administrator permissions are available only in the classic Azure portal.

Your team project collection will reuse your Azure subscription for future Visual Studio Marketplace purchases. Where can I find more info about Azure billing?

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

  2. From your team project collection, go to the Visual Studio Marketplace.

    Browse Marketplace in new navigation

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

    Select a TFS extension

    TFS is connected to the Marketplace, so the Marketplace automatically filters and shows on-premises extensions only.

  4. Based on the extension that you select, install or buy the extension.

    • For free or preview extensions, click Install.
    • For extensions that you haven't paid for access yet, click Buy.
    • For extensions that you've already paid for access, expand Buy, and select Install for paid users.

    Install or buy the extension

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

    Select team project collection

  6. If you chose a paid extension, select the Azure subscription that you'll use to pay for extension access.

    For paid extensions, select an Azure subscription for billing

    Then select the number of users who will need paid access to the extension.

    Select number of users who need paid extension access

  7. Finish installing your extension.

  8. If you installed a paid extension, make sure to assign the extension to users who need access. Otherwise, you can go to your team project collection to use your extension. Also, remember tell your team about this extension, so they can start using its capabilities too.

    Extension installed

    Need help?

Install extensions for disconnected TFS

While you're disconnected from TFS, you can install free and preview extensions, but not paid extensions, by downloading them, uploading them to your TFS, and then installing them in a team project collection.

Who can upload extensions?

Team Foundation administrators with Edit instance-level information permissions can upload extensions.

Who can install extensions?

Project collection administrators with Edit collection-level information permissions can install extensions. If you don't have permissions, you can request extensions instead.

Adding pre-installed extensions (first-party)

NOTE

This section is only for adding pre-installed extensions (first-party), if you're installing extensions that aren't pre-installed with TFS, proceed to the Download step below

With first-party extensions that come pre-installed with TFS, there is an alternate method of installation from below that prevents compatability issues.

In this case, you can manage extensions in disconnected TFS by:

  1. From the shopping bag, select Manage extensions Manage extensions

  2. From there select Browse local extensions

    Browse local extensions

  3. From there, select a listed extension such as Delivery Plans which will redirect you to the local gallery service to install

    Delivery plans extension

  4. Select Install and Confirm to install the extension

Download from Visual Studio Marketplace

  1. Sign in to Visual Studio Marketplace > Visual Studio Team Services.

  2. Find the extension that you want to install.

    View

    View

  3. Download and save your extension.

    Download and save your extension

    Why doesn't the extension have a download button?

Upload to Team Foundation Server

  1. Go to your TFS home page (https://{server}:8080/tfs/).

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

    TFS 2015 Update 3 Browse TFS extensions
    TFS 2017 Browse TFS extensions
  3. Manage your extensions.

    Manage extensions

  4. Upload the extension that you downloaded.

    Find and upload your downloaded extension

    Why can't I upload extensions?

Install in your team project collection

  1. Select and install the extension that you just uploaded.

    Select extension, then click Install

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

    Select team project collection, click Continue

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

    Review the permissions granted to this extension

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

Grant permissions to manage extensions

To grant permissions for managing extensions to users or groups, use TFSSecurity command-line tool.

  1. At the server level, create a group, for example, "TFS Extension Publishers".
    tfssecurity /gcg "TFS Extension Publishers" "publishers who can manage extensions for the server" /server:ServerURL
  2. Grant access to the "TFS Extension Publishers" group to manage extensions.
    tfssecurity /a+ Publisher "//" CreatePublisher n:"[TEAM FOUNDATION]\TFS Extension Publishers" allow /server:ServerURL
    tfssecurity /a+ Publisher "//" PublishExtension n:"[TEAM FOUNDATION]\TFS Extension Publishers" allow /server:ServerURL
    tfssecurity /a+ Publisher "//" UpdateExtension n:"[TEAM FOUNDATION]\TFS Extension Publishers" allow /server:ServerURL
    tfssecurity /a+ Publisher "//" DeleteExtension n:"[TEAM FOUNDATION]\TFS Extension Publishers" allow /server:ServerURL

    For Team Foundation Server "15" RC2 or earlier, use this syntax:
    tfssecurity /a+ Publisher "//" Create n:"[TEAM FOUNDATION]\TFS Extension Publishers" allow /server:ServerURL
    tfssecurity /a+ Publisher "//" Publish n:"[TEAM FOUNDATION]\TFS Extension Publishers" allow /server:ServerURL
    tfssecurity /a+ Publisher "//" Write n:"[TEAM FOUNDATION]\TFS Extension Publishers" allow /server:ServerURL
  3. Add existing users and groups to the "TFS Extension Publishers" group.
    tfssecurity /g+ "[TEAM FOUNDATION]\TFS Extension Publishers" n:User /server:ServerURL
    You can add users later to "TFS Extension Publishers". This is a server-level permission, so updating and deleting an extension will affect all the team project collections that use the extension.

Request extensions for a team project collection

Don't have permissions to install extensions? You can request extensions instead.

  1. While you're disconnected or connected to TFS, try to install the extension.

    Extension details

  2. Select the team project collection where you want to install the extension. If you don't have permissions to install the extension, you can request it now.

    Request extension

    You can review your requests after the Visual Studio Marketplace sends the request to the project collection administrator.

    Go to requests

    Your requests appear on your manage extensions page.

    View requested extensions

    Your project collection administrator can review your request after they get it.

Approve extensions for a team project collection

As a project collection administrator, you'll get email when another team project member requests an extension. When you approve the request, TFS automatically installs the extension.

To approve extensions, you must also have Edit collection-level information permissions.

  1. Go to your TFS home page, then go to your team project (https://{server}:8080/tfs/{team-project-collection}/{team-project}).

  2. Manage your extensions.

    TFS 2017 Manage extensions
    TFS 2015 Update 3 Manage extensions
  3. Review and approve your requested extensions.

    Extensions tab, requested extensions

    After you approve extension requests, TFS automatically installs those extensions.

  4. If you installed paid extensions, go to the next section to assign those extensions, to users who need access so they can start using those extensions.

  5. Remember tell your team about installed extensions, so they can start using their capabilities.

Assign paid extension access to users

After you install a paid extension, you must assign that extension to users who need access, so they can start using that extension's capabilities.

You only have to assign extensions to users who need access. Most extensions require that users have at least Basic access, not Stakeholder. If you have Visual Studio Enterprise subscribers, they automatically get access to specific extensions that are included with their subscriptions as benefits, like Test Manager. If you installed these extensions, you don't have to assign them to Visual Studio Enterprise subscribers in your team project. Visual Studio Test Professional subscribers get access to the Test Manager extension included with their subscription. To grant them access just assign Test Manager. To learn more, see change access levels. To find the access that your extension requires, see the extension's description in the Visual Studio Marketplace.

Who can assign paid extensions to users?

Project collection administrators with Edit collection-level information permissions can assign paid extensions to users.

  1. From your TFS home page, go to your control panel (https://{server}:8080/tfs/_admin).

    Go to TFS settings

  2. Go to your team project collection settings (https://{server}:8080/tfs/{team-project-collection}/_admin).

    Go to your team project collection administration page

  3. Go to your Users hub (https://{server}:8080/tfs/{team-project-collection}/_admin/_userHub).

    Go to Users hub

  4. Go to the extension pane, for example, Test Manager.

    Go to extension pane

  5. Assign your extension to users who need access.

    Assign extension to users

    Extension now assigned

    You can assign the extension to one user, specific users, or to all users at the same time, even going above the number allowed for your extension, if necessary.

  6. Tell your team about this extension, so they can start using its capabilities.

    Need help?

Change number of paid extension users

To update the total number of extension users that you pay for, go to your Team Foundation Server Users hub. To cancel paid access to an extension, reduce your users to zero (0). How do you bill changes in users?

Who can change the number of paid extension users?

Project collection administrators with Edit collection-level information permissions can change the number of paid extension users whose access that you pay for.

  1. From your TFS home page, go to your control panel (https://{server}:8080/tfs/_admin).

    Go to TFS settings

  2. Go to your team project collection settings (https://{server}:8080/tfs/{team-project-collection}/_admin).

    Go to your team project collection administration page

  3. Go to your Users hub (https://{server}:8080/tfs/{team-project-collection}/_admin/_userHub).

    Go to Users hub

  4. Go to the extension pane, for example, Test Manager. Change the number of extension users that you pay for.

    Go to extension pane, edit total paid extension users

  5. Update your total paid extension users.

    Update total paid extension users

    Need help?

Uninstall or disable extensions in Team Foundation Server

When you don't need an extension anymore, you can uninstall or disable this extension.

Charges will continue for a paid extension until you reduce all users to zero (0) for this extension.

Who can uninstall or disable extensions?

Project collection administrators with Edit collection-level information permissions can uninstall or disable extensions.

  1. From your TFS home page (https://{server}:8080/tfs/), go to the team project collection where you want to uninstall or disable the extension.

  2. Manage your extensions.

    TFS 2017 Manage extensions
    TFS 2015 Update 3 Manage extensions
  3. On the extensions tab, select the extension, then uninstall or disable it.

    Uninstall or disable an extension

    Need help?

Q & A

General

Q: What's the difference between free, preview, and paid extensions?

Extensions that are available during preview don't incur charges, aren't fully supported, and have no financially-backed service level agreements.

Paid extensions require that you buy and assign them to users who need access but don't have it already, for example, through subscription benefits. You'll use an Azure subscription to pay for an extension. If you don't have an Azure subscription, you can create a new subscription when you install your extension. If you have multiple subscriptions, you can select the Azure subscription that you want to use. Where can I find more info about Azure billing?

Q: What happened to my preview extension?

A: Your extension is no longer in preview and is now generally available as a paid extension, but offers a grace period before you have to buy the extension. All preview extensions will automatically convert to a free trial before you have to buy the extension.

Install, request, assign, and access extensions

Q: When do I choose Install for paid extensions?

A: You can just choose Install when:

  • You want to install a free or preview extension.
  • You paid for access, uninstalled the extension, and want to reinstall the extension.
  • You just need the extension for Visual Studio subscribers who have access for that extension included with their subscriptions. These subscribers get specific extensions, like Test Manager, included with their subscriptions as benefits. They can use these extensions after they're installed without paid access and assignment. You only have to buy and assign extensions for users who need access.

Q: Why can't I install extensions for TFS?

A: This might happen for these reasons:

Q: Why don't I see the team project collection I want?

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

  1. On your TFS web portal home page (https://{server}:8080/tfs/), go to the top right corner of the page, and click 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 TFS home page (https://{server}:8080/tfs/) with the identity that's a user in the team project collection where you want to install the extension.

    If you're asked to choose "work or school account" or "personal account", this means you used an email address that's the same for a Microsoft account and a "work or school account" that's 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 team project collection.

  6. From your team project collection, go to the Visual Studio Marketplace.

Q: Why can't I buy extensions from Microsoft partners?

A: This might happen for these reasons:

  • Restricted countries

    In some countries, you can't use specific Azure subscriptions to buy extensions or resources from Microsoft partners in the Visual Studio Marketplace, although you can use those same subscriptions to buy extensions published by Microsoft. See Who can purchase applications and services sold/provisioned through the Azure Marketplace?

    If your country is supported in the Azure Marketplace, but not for the extension that you want to purchase, please contact the extension publisher.

  • Credit card required

    Unless you have an Enterprise Agreement, you must have a credit card associated with your Azure subscription. For example, you can't use a Pay-As-You-Go subscription that's set up for invoice billing.

    If you can't use your subscription, try using creating another Pay-As-You-Go Azure subscription with a credit card.

    NOTE

    If you get this message: "This Azure subscription doesn't have a credit card on file. Please select another subscription", select another subscription, or click Create a new Azure subscription to continue.

  • Enterprise Agreement purchases

    To buy extensions or resources from Microsoft partners in the Visual Studio Marketplace, your Azure Enterprise Agreement administrator must enable Azure Marketplace purchases. Go to the Microsoft Azure Enterprise Portal (https://ea.azure.com) > Manage > Enrollment, and enable Azure Marketplace.

    NOTE

    If you get this message: "The ordering account is not eligible to purchase from azure store using Enterprise Agreement.", have your Azure Enterprise Agreement administrator go to the Microsoft Azure Enterprise Portal (https://ea.azure.com) > Manage > Enrollment, and enable Azure Marketplace.

  • Credit card problems

    Purchases from Microsoft partners are charged immediately, not at the end of your billing cycle, like Microsoft resources. This means that if your credit card is declined for any reason, your purchase won't be completed. If this happens, try your purchase again, or contact your credit card customer service.

    NOTE

    If you get this message: "The payment provider declined the transaction. Please check your credit card information", try your purchase again later, or contact your credit card customer service.

Q: Why doesn't the extension I want show a download button?

A: Some extensions work only with Visual Studio Team Services, not TFS, for one of these reasons:

  • The extension uses Team Services features that aren't released yet for TFS.
  • The extension manifest indicates that the extension is available only for Team 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 TFS?

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

Q: Why can't users access extension features?

A: This can happen for these 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, but you'll get different capabilities based on your access level and whether you work offline or connected to Team Services or TFS. For more details, see the extension's description in the Visual Studio Marketplace.

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

    1. On your Team Services account toolbar, go to 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 a Team Services account, and you paid for this extension, make sure that you assigned this extension to users.

    1. On your Team Services account toolbar, go to Users.
    2. Go to the extension pane.
    3. Check whether the extension is assigned to the user. If not, assign the extension to the user.

Learn more about assigning paid extensions to users.

Purchases & billing

Q: How does Azure billing work?

A: When you buy from the Visual Studio Marketplace, you select an Azure subscription to use for billing. If you don't have an Azure subscription, you can sign up either before or during your first purchase. You can set up payment with a credit card, or by invoice in some cases. Charges for your purchases will show up on your monthly Azure bill.

Note: You must keep your Azure subscription in good standing to use your Visual Studio Marketplace purchases. If your Azure subscription is canceled or becomes disabled, for example, because the credit card used for payment expires, then any purchases with this Azure subscription will be deactivated on the 1st day of next month. To continue using your Visual Studio Marketplace purchases, please keep your Azure subscription active and updated.

Q: Can I use an Enterprise Agreement to buy from the Visual Studio Marketplace?

A: Yes, please buy directly from the Visual Studio Marketplace where you can bill purchases to the Azure subscription that was created under your Enterprise Agreement (EA). Don't order Visual Studio Marketplace services through your reseller.

Q: Can I use the Azure Monetary Commitment funds from my Enterprise Agreement to buy from the Visual Studio Marketplace?

A: Yes. You can use these prepaid funds to pay for:

You can't use these funds to pay for Visual Studio cloud subscriptions and non-Microsoft extensions for Team Services and Team Foundation Server.

Q: Can I use the Azure Free Trial to buy from the Visual Studio Marketplace?

A: No, you can't use the Azure Free Trial to pay for Visual Studio Marketplace purchases, which applies to Visual Studio Team Services, HockeyApp plans, Xamarin University, and so on. Instead, set up a separate Pay-As-You-Go Azure subscription, which you can do before or during your purchase.

Q: Can I use the monthly Azure credits from Visual Studio subscriptions or Visual Studio Dev Essentials to buy from the Visual Studio Marketplace?

A: No, you can't use the monthly Azure credits from Visual Studio subscriptions and Visual Studio Dev Essentials to pay for Visual Studio Marketplace purchases. However, you can use the included Azure subscriptions to bill your purchases. Before you make purchases, you must remove your spending limit from these subscriptions.

Spending limit

Important: Remove your spending limit indefinitely. This prevents disabling your Azure subscription when your monthly charges are billed the next month. Otherwise, all resources billed to this subscription will be suspended, including virtual machines and all other workloads.

Remove spending limit indefinitely

Q: Where can I check my bill or correct any billing information on my Azure subscription?

A: If you're the Azure account administrator, visit the Azure Account portal.

Q: How do you bill for extension purchases or changes?

A: For Microsoft extensions:

  • Your charges are prorated during the 1st month of use. After that, they renew and are billed automatically on the 1st day of the calendar month unless you cancel.

  • If you reduce users for a paid extension, those decreases won't take effect until the 1st day of the next calendar month. You're still charged for the users that you've committed for the current month.

  • If you add users for a paid extension, those increases will take effect immediately. Charges for increases are prorated, but only above the number of users that you've committed for the current month.

  • If you reduce users and add users for the same paid extension in the same month, you're not double-charged if you don't go above the number of users that you've committed for the current month.

  • If you uninstall or disable a paid extension, charges will continue unless you cancel the extension by reducing all your users to zero (0).

For non-Microsoft extensions:

  • Your charges start on the day that you purchase and renew on the same day each month until you cancel.

  • Changes to your user plan will be pro-rated on your next bill based on the number of days you were on each plan.

  • If you uninstall or disable a paid extension, charges will continue unless you cancel the extension by reducing all your users to zero (0).

Q: Why is my first Azure bill larger than expected?

A: Charges for your first purchase are prorated during the 1st month and are combined with charges for the next month, which are billed on the 1st day of the calendar month. This means your first Azure bill might include these partial charges and your 1st full month.

Q: What happens if my Azure subscription is disabled?

A: If you're the Azure subscription Account Administrator, check your subscription status in the Account Center, then try to fix your subscription.

Q: How do I get other help or support for Azure subscriptions and billing?

A: Check these topics about Azure billing and subscriptions, the Azure Billing and Subscription FAQ, or try Azure Support.

Q: How do I get support for the Visual Studio Marketplace?

A: Depending on the support you need:

Q: Can I use an Enterprise Agreement to buy from the Visual Studio Marketplace?

A: Yes, please buy directly from the Visual Studio Marketplace where you can bill purchases to the Azure subscription that was created under your Enterprise Agreement (EA). Don't order Visual Studio Marketplace services through your reseller.

Q: How can I tell whether I have the necessary privileges to buy services in the Visual Studio Marketplace through my organization's Enterprise Agreement?

A: The easiest approach to determine if you have the right privileges is to click the Buy button for a service offered in the Visual Studio Marketplace. You need to select an Azure subscription (which is a billing account) from a presented list of Azure subscriptions that are currently linked to your login. Because the name of the Azure subscription defaults to the type of billing account ("Pay-As-You-Go", "Enterprise Agreement", etc.), it is often clear if the Azure subscription is part of your Enterprise Agreement.

Another approach is to attempt to visit the Azure Enterprise Portal. If you can reach it successfully, then you already have either the Enterprise Admin or the Account Owner role. Only Account Owners can set up new Azure billing accounts in an Enterprise Agreement. If you cannot access the Azure Enterprise Portal, then please inquire within your organization to find out who your Enterprise Admin is, and ask that person to add you as an Account Owner within the Azure Enterprise Portal. If you are unable to find this person, you can submit a support ticket and request the contact information. You need your organization's name and your Enterprise Agreement enrollment number for the support ticket.