Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
In order to complete the steps below, you must have Application Administrator or Global administrator role in AzureMicrosoft Entra.
The registration consists of the following steps:
Table of Contents |
---|
The following steps have to be done only once per bot. Once it's done, the bot can be used in multiple Azure tenantsMicrosoft Entra tenants.
Info |
---|
Azure Active Directory is now Microsoft Entra ID. |
Creating a bot channel registration
Step 1 - Log in to the Azure portal.
Step 2 - Search for Azure Bot in the search box on the top, then click on the link under the Marketplace section.
Step 3 - In the left panel, provide a unique name at the Bot handle, then select the Subscription, the Resource group, and the Location of the bot channel registration. The Location should be the same region where the Verba Bot virtual machine resides in Azure.Image Removed. Set the Type of App to either Single Tenant or Multi Tenant. If the Bot will be used by multiple tenants, then select Multi Tenant.
Image Added
Step 4 - Click on the Review + Create button and if the configuration is correct the Create button again. Creating the Azure Bot may take some seconds. Azure will actually create an App Registration and a Bot Service assigned to it.
Adding a Teams Channel to the Bot Service
Step 5 - Once the Bot Channels Registration is completed, search for Bot Services in the search box on the top, then click on the Bot Services link under the Services section.
(Alternatively, the Bot Services can be also found by opening the hamburger menu in the upper right corner, then selecting All services, then the AI + machine learning category.)
Step 6 - Select the Bot Service from the list that was created previously using the name provided at Step 3 (Bot handle).
Step 7 - In the second left panel, under the Bot managementSettings section, click on the Channels menu.
Image RemovedImage Added
Step 8 - Under the Add featured channelAvailable channels section select the Teams icon (Configure Microsoft Teams channel) Microsoft Teams option.
Step 9 - Accept the terms of service, select the Microsoft Teams Commercial option, then click Apply.
Step 910 - Select the Calling tab, then tick the Enable calling checkbox.
Step 1011 - At the Webhook (for calling) setting, provide the following URL: https://verba_bot_vm.domain.com:9440/api/calling
Replace the verba_bot_vm part with the hostname of the Azure virtual machine which will host the Verba Bot service. At the domain part, use the domain of the Teams tenant (also specified in the SSL certificate).
Step 1112 - Click on the SaveApply button. Agree with the terms of service.
Configuring authentication for the bot
Step 1213 - Search for App registrations in the search box on the top, then click on the App registrations link under the Services section.
(Alternatively, the App registrations can be also found by opening the hamburger menu in the upper right corner, then selecting the Azure Active Directory Microsoft Entra ID, then selecting App registrations in the left panel.)
Step 1314 - Select the App Registration from the list that was created previously using the name provided at Step 3 (Bot handle).
Step 1415 - Take a note of the Application (client) ID and the Directory (tenant) ID. They will be needed later.
Image Modified
Step 1516 - Select the Certificates & secrets menu in the left panel.
Image Modified
Step 1617 - Under the Client secrets section, click on the New Client Secret button.
Step 1718 - Provide a Description, set when the secret Expires, then click on the Add button.
Step 1819 - Take a note of the new Client secret. It will be needed later.
Step 1920 - In the left panel, under the Manage section, click on the Authentication menu.
Step 2021 - Under the Platform configuration sections, click on the Add a platform button.
Step 2122 - In the right panel, select Web.
Step 2223 - Provide a Redirect URI. It can be any website. Take a note of the URI provided, it will be needed later.
Step 2324 - Click on the Configure button in the bottom.
Configuring permissions to the bot
Step 2425 - In the left panel, under the Manage section, click on the API permissions menu.
Step 2526 - Click on the Add a permission button.
Step 2627 - Select Microsoft Graph, then select Application permissions.
Step 2728 - Select the following permissions:
- Calendars.Read
- Calls.AccessMedia.All
- Calls.JoinGroupCall.All
- Calls.JoinGroupCallAsGuest.All
- OnlineMeetings.Read.All
- User.Read.All
Info | ||
---|---|---|
| ||
The same App Registration can be used for the chat recording. In that case, add the following permissions also:
If the Chat recording will be used, the protected API access has to be requested. See Protected API Access for Chat Recording section at the bottom. |
Step 2829 - Click on the Add permissions button.
Granting admin consent to the permissions
Note | ||
---|---|---|
| ||
In the case when the recorded Teams environment and the recording bot are in separate Azure Microsoft Entra tenants, the following steps have to be done using the Tenant ID of the Azure Microsoft Entra tenant where the Teams environment to record resides, and also using a user that has the Teams Service Admin or Global Admin role in that tenant. In order to gather the Tenant ID for Step 29, you have to log in to the Azure portal of that tenant, then go to the Azure Active Directoryto Microsoft Entra ID. Multi-Tenant configuration:If the same bot is being used in multiple tenants, then the following steps have to be done for each tenants using the guidelines above. |
Step 2930 - Build the consent URL. The format is the following:
Code Block |
---|
https://login.microsoftonline.com/{tenant_id}/adminconsent?client_id={microsoft_app_id}&state=12345&redirect_uri={redirect_uri} |
Replace the {tenant_id} part with the Directory (tenant) ID and the {microsoft_app_id} part with the Application (client) ID from Step 14. Replace {redirect_uri} part with the URI from Step 22.
Step 3031 - Copy the previously created consent URL into the browser, then hit enter. Log in with a Teams Service Admin or Global Admin user of the Azure Microsoft Entra tenant where the Teams environment to record resides. Click on the Accept button. The page will redirect to the webpage provided in the Redirect URI setting.
2N Recording
Step 31 32 (Optional) - In the case of 2N recording, all the steps above have to be done twice. Take a note of the second Application (client) ID also at Step 14. It will be needed in the next part of the configuration guide.
Protected API Access for Chat Recording
Step 32 (Optional) - If the same App Registration will be used for Chat recording also, then the following form has to be sent:
https://aka.ms/teamsgraph/requestaccess
At the Data Retention setting select “It is obvious to any admin installing this app that it will make a copy of Microsoft Teams messages”. On the second page, leave the URLs empty.
Panel | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
The Microsoft Teams Bot can be also registered using Azure CLI and PowerShell commands. Step 1 - Download and install the Azure CLI. Step 2 - Open PowerShell and log in to Azure using the az login command. For example:
Step 3 - Create the App registration using the az ad app create command. Provide an App secret also. When it is done, take a note of the App Id; it will be needed in the later commands, in Verba configuration, and in the Teams recording policy.
Step 4 (Optional) - Assign an user to the App registration as owner using the az ad app owner add command:
Step 5 - Add permissions to the App registration using the az ad app permission add command:
Step 6 (Optional) - If the same App Registration will be used for Chat recording also, then add the following permissions also:
Step 7 - Grant admin consent using the az ad app permission admin-consent command:
Step 8 - Create the Bot channels registration using the az bot create command:
Step 9 - Add the Teams channel to the Bot channels registration using the az bot msteams create command:
Step 10 (Optional) - If the Chat recording will be used, the prteted API access has to be requested. See Protected API Access for Chat Recording section at the bottom. |