AzureAppForMicrosoftTeams/Documentation.md

110 строки
6.8 KiB
Markdown
Исходник Обычный вид История

2020-02-14 13:06:36 +03:00
---
title: Azure with Microsoft Teams
2020-02-19 10:33:22 +03:00
description: Monitor your applications and infrastructure on Azure from Microsoft Teams
2020-02-14 13:06:36 +03:00
ms.date: 02/14/2020
---
2020-02-27 13:03:54 +03:00
# Azure with Microsoft Teams (Private preview)
2020-02-27 11:57:38 +03:00
[Azure](https://azure.microsoft.com/) is a cloud computing service offering by Microsoft. It has over 100 services that help to build, deploy and manage applications across cloud, on-premise and at the edge. Millions of users use Azure services daily.
2020-02-27 11:56:55 +03:00
2020-03-05 10:32:19 +03:00
ChatOps is a team and collaboration centric way of working where in people, conversations, tools, and files are ensembled in one place i.e. workplace messaging apps. Modern day developers spend considerable amount of time on [Microsoft Teams](https://products.office.com/microsoft-teams/group-chat-software) trying to build world class products and services.
2020-02-27 11:56:55 +03:00
2020-03-05 10:32:19 +03:00
Today, considerable amount of time is spent to monitor applications, infrastructure, and to debug issues by developers and IT operations team. This necessitates constant switching of context between Azure (get alerts, diagnose & take remedial actions) and Microsoft Teams (collaborate). Azure app for Microsoft Teams brings best of both the worlds by integrating Azure with Microsoft Teams. Users can get all the alerts from Azure in their Teams channel by linking their channel to an action group on Azure.
2020-02-27 11:56:55 +03:00
2020-03-05 08:56:09 +03:00
## Prerequisites
Authentication to Azure happens via Azure DevOps. To use the app, users need to have an account in Azure DevOps. In case you do not have an Azure DevOps account, you can create one during the signin process.
2020-03-18 22:12:07 +03:00
2020-03-05 08:56:09 +03:00
## Get Started - Add the Azure app to your Team
2020-03-05 09:26:38 +03:00
Download the [manifest](https://github.com/microsoft/AzureAppForMicrosoftTeams/blob/master/manifest.zip) and upload it as a custom app and install it in the team of your choice.
2020-03-03 16:08:22 +03:00
2020-03-03 15:57:25 +03:00
![Add as custom app](./teams/add-as-custom-app.png)
2020-02-14 14:03:16 +03:00
2020-02-27 12:50:14 +03:00
Upon installing, a welcome message is displayed as shown in the following image. Use the ``@azure`` handle to start interacting with the app.
2020-03-03 15:57:57 +03:00
2020-03-03 15:57:25 +03:00
![welcome message](./teams/welcome-message.png)
2020-03-18 22:16:18 +03:00
2020-03-18 22:17:01 +03:00
2020-03-18 22:20:12 +03:00
**_It is recommended that you create a new channel for configuring the app. Depending on how the alerts are configured, the channel can get a little noisy (especially for activity alerts)._**
2020-02-14 13:20:06 +03:00
2020-03-05 08:56:09 +03:00
## Sign in to your app
2020-02-14 14:07:57 +03:00
2020-02-27 12:50:14 +03:00
Once the app is installed in your team, authenticate yourself to Azure app using the ``@azure signin`` command.
2020-02-14 14:07:57 +03:00
2020-03-03 15:57:25 +03:00
![sigin button](./teams/signin-button.png)
2020-03-03 15:58:56 +03:00
2020-03-03 15:57:25 +03:00
![sigin consent](./teams/signin-consent.png)
2020-03-03 15:58:56 +03:00
2020-03-03 15:57:25 +03:00
![sigin success](./teams/signin-success.png)
2020-02-14 14:07:57 +03:00
2020-02-27 12:36:27 +03:00
## Link your channel to action groups
2020-02-27 12:52:05 +03:00
Azure uses action groups to send notifications about applications and infrastructure to users. Action groups help users to configure the medium (SMS, Email, Voice, Mobile app, Webhooks, etc) through which they want to get notified on. Every alert on Azure is mapped to one or more action groups. Azure app for Microsoft Teams allows users to link to action groups of their choice and get notified on the alerts.
2020-02-27 12:36:27 +03:00
1. To view, link and unlink actions groups for a channel, use the following command:
2020-02-14 14:07:57 +03:00
```
@azure actionGroups
```
2020-02-19 10:52:39 +03:00
The `actionGroups` command lists all the action groups linked to a channel.
2020-02-14 14:07:57 +03:00
2020-03-03 15:57:25 +03:00
![action groups command](./teams/action-groups-command.png)
2020-02-14 14:07:57 +03:00
2020-02-27 12:52:55 +03:00
2. Click on 'Link an action group' button. Select a subscription and the action group that you want to link to the channel.
2020-02-18 12:58:40 +03:00
2020-03-03 15:57:25 +03:00
![link action group](./teams/link-action-group.png)
2020-02-18 12:58:40 +03:00
2020-03-05 10:41:02 +03:00
To link an action group to a channel, one must be part of [Azure Monitor Contributor](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/roles-permissions-security#monitoring-contributor) group. When an action group is linked to a channel, a webhook action will be created with the name MicrosoftTeams_AzureApp_<Time_stamp> in the linked action group.
2020-02-18 12:58:40 +03:00
2020-02-19 10:52:39 +03:00
## Unlink an action group from a channel
2020-02-27 12:59:55 +03:00
To unlink an action group, run `@azure actionGroups` command. Click on 'View all action groups' button and select the action group that you want to unlink.
2020-02-14 13:20:06 +03:00
2020-03-03 15:57:25 +03:00
![view-all-action-groups](./teams/view-all-action-groups.png)
2020-02-14 13:20:06 +03:00
2020-02-27 12:59:55 +03:00
To unlink an action group, one must be part of [Azure Monitor Contributor](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/roles-permissions-security#monitoring-contributor) group.
2020-02-14 13:20:06 +03:00
2020-02-18 13:28:49 +03:00
## Receiving notifications
2020-02-19 10:52:39 +03:00
Once an action group is linked to a channel, all alerts sent to the action group will be directed to the channel in the form of notifications.
2020-02-18 13:28:49 +03:00
2020-03-05 09:51:11 +03:00
![metric notification](./teams/metric-notification.png)
2020-02-18 13:28:49 +03:00
2020-02-19 10:52:39 +03:00
For metric alerts, if the user who linked the action group has access to the resource group for which the alert was sent, a time series graph would be additionally rendered.
2020-02-18 13:28:49 +03:00
2020-02-19 10:23:53 +03:00
## Command reference
The following table lists all the commands you can use in your Microsoft Teams channel.
|Command | Functionality |
| -------------------- |----------------|
2020-02-19 10:54:23 +03:00
| @azure actionGroups | View, link or unlink action groups for a channel |
2020-02-19 10:23:53 +03:00
| @azure signin | Sign in to your Azure account |
| @azure signout | Sign out from your Azure account |
| @azure feedback | Report a problem or suggest a feature |
2020-03-05 08:56:09 +03:00
## Limitations
Being a private preview, Azure app has certain limitations as detailed below. We will continue to invest in the app to remove some of these constraints.
* Azure app posts notifications only for **metric alerts**. Support for 'activity log' and 'log alerts' will added soon.
* Azure app supports [Common alert schema](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/alerts-common-schema) notifications only.
* Alerts with multiple conditions or a single metric alert with multiple dimensions are not supported. The notification will have data only for the first dimension.
* To report a problem or suggest a feature, users need to have a GitHub account.
2020-03-05 10:41:02 +03:00
* The app needs to be sideloaded and is not avaialble in Teams app store as we are in private preview.
2020-02-19 10:23:53 +03:00
2020-02-18 13:28:49 +03:00
## Future work
Were constantly at work to improve the app, and soon youll see new features stated below
2020-03-03 16:11:24 +03:00
* Support for activity and log alerts
* Ability to acknowledge and close an alert from the channel (change alert state)
* Ability to get pipeline deployment data (for virtual machines only)
* Threading of notifications
2020-03-05 08:56:09 +03:00
2020-02-14 13:20:06 +03:00
## Troubleshooting
2020-02-14 13:06:36 +03:00
2020-03-03 16:12:53 +03:00
|Issue | Possible cause |
| -------------------- |----------------|
| For metric alerts, the cards are not enriched with time charts |The user who linked the action group does not have access to the resource for which the alert was fired |
2020-02-18 13:28:49 +03:00
2020-02-27 12:41:32 +03:00
## Private preview terms and condition
2020-02-27 12:42:36 +03:00
PREVIEWS ARE PROVIDED "AS-IS," "WITH ALL FAULTS," AND "AS AVAILABLE," AND ARE EXCLUDED FROM THE SERVICE LEVEL AGREEMENTS AND LIMITED WARRANTY. Previews may not be covered by customer support.We may change or discontinue Previews at any time without notice. We also may choose not to release a Preview into "General Availability". Refer [this](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for more details.
2020-02-18 13:28:49 +03:00