Azure Repos with Microsoft Teams

مقالة
04/29/2022
قراءة خلال 7 دقائق

Azure DevOps Services

If you use Microsoft Teams, you can use the Azure Repos app for Teams to easily monitor your repositories. Set up and manage subscriptions to receive notifications in your channel whenever code is pushed/checked in or when a pull request (PR) is created, updated or merged. The app supports monitoring both Git and Team Foundation Version Control (TFVC) repositories.

Notifications image

Read this article to learn how to:

Add the Azure Repos app to your team in Microsoft Teams
Connect the Azure Repos app to your repositories
Manage subscriptions to repository related events in your channel
Using filters effectively to customize subscriptions

Prerequisites

To create subscriptions for repository-related events, you must be a member of the Project Administrators group, or a team administrator. To get added, see Change project-level permissions or Add a team administrator.
To receive notifications, you must enable the Third-party application access via OAuth setting for the Azure DevOps organization. See Change application access policies for your organization.

Note

Notifications are currently not supported inside direct messages.
You can only link the Azure Repos app for Microsoft Teams to a project hosted on Azure DevOps Services.

Add the Azure Repos app to your team in Microsoft Teams

Visit the App store in Microsoft Teams and search for the Azure Repos app. Upon installing, a welcome message from the app displays as shown in the following image. Use the @azure repos handle to start interacting with the app.

Welcome message

Connect the Azure Repos app to your repositories

Once the app has been installed in your team, authenticate yourself to Azure Repos using the @azure repos signin command. Use Sign in with different email if your Microsoft Teams and Azure Boards are in different tenants.
To start monitoring all Git repositories in a project, use the following slash command inside a channel:
```
@azure repos subscribe [project url]
```
The project URL can be to any page within your project (except URLs to repositories).

For example:
```
@azure repos subscribe https://dev.azure.com/myorg/myproject/
```
You can also monitor a specific repository using the following command:
```
@azure repos subscribe [repository url]
```
The repository URL can be to any page within your repository that has your repository name.

For example, for Git repositories, use:
```
@azure repos subscribe https://dev.azure.com/myorg/myproject/_git/myrepository
```
For TFVC repositories, use:
```
@azure repos subscribe https://dev.azure.com/myorg/myproject/_versionControl
```
The subscribe command gets you started with a default subscription. For Git repositories, the channel gets subscribed to the Pull request created event (with target branch = master). For TFVC repositories, the channel is subscribed to the Code checked in event.

Manage subscriptions

To view, add, and remove subscriptions for a channel, use the subscriptions command:

@azure repos subscriptions

The subscription command lists all the current subscriptions for the channel and allows you to add new subscriptions or remove existing ones. When adding subscriptions, you can customize the notifications you get by using various filters, as described in the following section.

[!NOTE] Team administrators aren't able to remove or modify subscriptions created by Project administrators.

View subscriptions

Using filters to get only notifications that you want

When a user subscribes to a repository using the @azure repos subscribe command, a default subscription is created with no filters applied. Often, users need to customize these subscriptions to be notified only when certain conditions are met. For example, users may want to get notified only when PRs have a particular group added as reviewer.

The following steps demonstrate how to customize subscriptions.

Run the @azure repos subscriptions command.
In the list of subscriptions, if there is a subscription that is unwanted or must be modified, select Remove to delete it.
Select the Add subscription button.
Select the required repository and the desired event.
Select the appropriate filters to customize your subscription.

Example: Get notifications only when my team is in the reviewer list for a PR

Add subscription screen 1

Add subscription screen 2

Add subscription screen 3 with filters

Note

All the filters are typically drop-downs. However if the drop-down were to have greater than 100 items, then you will need to enter the values manually.
For the TFVC Code Checked in event, the filter Under path must be of the format $/myproject/path.

To help users search and share information about pull requests, Azure Repos app for Microsoft Teams supports compose extension. You can now search for pull requests by ID or name. For compose extension to work, users will have to sign into Azure Repos project that they are interested in either by running @azure repos signin command or by signing into the compose extension directly.

Compose extension

Previews of pull request URLs

When a user pastes the URL of a PR, a preview is shown like the one in the following image. This helps to keep PR-related conversations contextual and accurate.

URL unfurling

For this feature to work, users have to be signed-in. Once they are signed in, this feature will work for all channels in a Team.

Remove subscriptions and repositories from a channel

Many a time, users want to clean up their channel by removing repositories and subscriptions. Use the below command to achieve the same.
```
  @azure repos unsubscribe all [project url]
```
For example:
```
  @azure repos unsubscribe all https://dev.azure.com/myorg/myproject
```

This command will delete all the subscriptions related to any repository in the project and removes the repositories from the channel. Only project admins can run this command.

Threaded notifications

To logically link a set of related notifications and also to reduce the space occupied by notifications in a channel, notifications are threaded. All notifications linked to a particular pull request will be linked together.

Compact view of threaded notifications

Compact thread

Expanded view of threaded notifications

Expanded thread

Command reference

The following table lists all the azure repos commands you can use in your Teams channel.

Command	Functionality
@azure repos subscribe [repository url/ project url]	Subscribe to a repository or all repositories in a project to receive notifications
@azure repos subscriptions	Add or remove subscriptions for this channel
@azure repos signin	Sign in to your Azure Repos organization
@azure repos signout	Sign out from your Azure Repos organization
@azure repos feedback	Report a problem or suggest a feature
@azure repos unsubscribe all [project url]	Remove all repositories (belonging to a project) and their associated subscriptions from a channel

Multi-tenant support

In your organization if you are using a different email or tenant for Microsoft Teams and Azure DevOps, perform the following steps to sign in and connect based on your use case.

Case	Email ID and tenant in Microsoft Teams	Email ID and tenant in Azure DevOps	Steps to take
1	email1@abc.com (tenant 1)	email1@abc.com (tenant 1)	Sign in using Sign in button.
2	email1@abc.com (tenant 1)	email1@abc.com (tenant 2)	Sign in the Azure DevOps account In the same browser, start a new tab, navigate to https://teams.microsoft.com/ Run the `signin` command and choose the Sign in button.
3	email1@abc.com (tenant 1)	email2@pqr.com (tenant 2)	Sign in using Sign in with different email address, in the email id picker use the email2 to sign in to Azure DevOps.
4	email1@abc.com (tenant 1)	email2@pqr.com (non default tenant 3)	This scenario is not supported today.

Troubleshooting

If you are experiencing the following errors when using the Azure Repos App, follow the procedures in this section.

Sorry, something went wrong. Please try again.
Configuration failed. Please make sure that the organization '{organization name}' exists and that you have sufficient permissions.

Sorry, something went wrong. Please try again.

The Azure Repos app uses the OAuth authentication protocol, and requires Third-party application access via OAuth for the organization to be enabled. To enable this setting, navigate to Organization Settings > Security > Policies, and set the Third-party application access via OAuth for the organization setting to On.

Enable the Third-party application access via OAuth for the organization setting

Configuration failed. Please make sure that the organization '{organization name}' exists and that you have sufficient permissions.

Sign out of Azure DevOps by navigating to https://aka.ms/VsSignout using your browser.

Open an In private or incognito browser window and navigate to https://aex.dev.azure.com/me and sign in. In the dropdown under the profile icon to the left, select the directory that contains the organization containing the repository to which you wish to subscribe.

In the same browser, start a new tab and sign in to https://teams.microsoft.com/. Run the @Azure Repos signout command and then run the @Azure Repos signin command in the channel where the Azure Repos app for Microsoft Teams is installed.

Select the Sign in button and you'll be redirected to a consent page like the one in the following example. Ensure that the directory shown beside the email is same as what was chosen in the previous step. Accept and complete the sign-in process.

Consent to the requested app permissions

If these steps don't resolve your authentication issue, please out to us at Developer Community.