Icebreaker App Deployment Guide

12/15/2020 Deployment guide · OfficeDev/microsoft-teams-apps-icebreaker Wiki · GitHub
OfficeDev / microsoft-teams-apps-icebreaker
Code Issues 49 Pull requests 6 Actions Projects Wiki Security Insights
Deployment guide
Jump to bottom
Adrian Solis edited this page on Aug 19, 2019 · 6 revisions
Prerequisites
To begin, you will need:
An Azure subscription where you can create the following kinds of resources:
Azure Logic App
App service
App service plan
Bot channels registration
Azure Cosmos DB account
Application Insights
A copy of the Icebreaker app GitHub repo (https://github.com/officedev/microsoft-teams-
icebreaker-app)
This is not a pre-requisite per se, but here is a video walkthrough of this deployment if you'd
like to follow along as you go through your own deployment. Icebreaker video walkthrough
Step 1: Register Microsoft Azure AD application

Register one multi-tenant Azure AD application with one Secret.
1. Log in to the Azure Portal for your subscription, and go to the “App registrations” blade at
https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Registered
AppsPreview.
2. Click on "New registration", and create an Azure AD application.
i. Name: The name of your Teams app - if you are following the template for a default
deployment, we recommend "Icebreaker".
ii. Supported account types: Select "Accounts in any organizational directory"
iii. Leave the "Redirect URI" field blank.
https://github.com/OfficeDev/microsoft-teams-apps-icebreaker/wiki/Deployment-guide 1/7
3. Click on the "Register" button.
4. When the app is registered, you'll be taken to the app's "Overview" page. Copy the
Application (client) ID; we will need it later. Verify that the "Supported account types" is set
to Multiple organizations.
5. On the side rail in the Manage section, navigate to the "Certificates & secrets" section. In the
Client secrets section, click on "+ New client secret". Add a description for the secret and
select an expiry time. Click "Add".
6. Once the client secret is created, copy its Value; we will need it later.
At this point you have 2 unique values:
One application (client) ID

One client secret
Step 2: Deploy to your Azure subscription

1. Click on the "Deploy to Azure" button below.
2. When prompted, log in to your Azure subscription.
3. Azure will create a "Custom deployment" based on the ARM template and ask you to fill in
the template parameters.
4. Select a subscription and resource group.
We recommend creating a new resource group.

The resource group location MUST be in a datacenter that supports Application
Insights. For an up-to-date list, refer to https://azure.microsoft.com/en-us/global-
infrastructure/services/?products=monitor, under "Application Insights".
5. Fill in the various IDs in the template:
Bot App ID: The Application (client) ID from the Azure AD application created above
Bot App Password: The client secret from the Azure AD application created above
Make sure that the values are copied as-is, with no extra spaces. The template checks that
the GUID is exactly 36 characters.
6. Agree to the Azure terms and conditions by clicking on the check box “I agree to the terms
and conditions stated above” located at the bottom of the page.
7. Click on “Purchase” to start the deployment.
8. Wait for the deployment to finish. You can check the progress of the deployment from the
"Notifications" pane of the Azure Portal.
9. Once completed, navigate to the App Service you have created (it should be of type
Microsoft.Web/sites with a name similar to "icebreaker-XXXXXXXXXXXXX"). Copy its URL; we
will need it later. It should be similar to "https://icebreaker-
XXXXXXXXXXXXX.azurewebsites.net" where the X's are the hash.
Step 3: Create the Teams app package

1. Open the Manifest\manifest.json file in a text editor.
2. Change the placeholder fields in the manifest to values appropriate for your organization.
developer.name (What's this?)
developer.websiteUrl
developer.privacyUrl
developer.termsOfUseUrl
3. Change the “botId” placeholder to your Azure AD application's ID from above. This is the
same GUID that you entered in the template under “Bot App ID”.
4. In the "validDomains" section, replace the placeholder with your App Service's domain. This
is your App Service's URL you copied above WITHOUT the "https://" e.g. "icebreaker-
XXXXXXXXXXXXX.azurewebsites.net".
5. Create a ZIP package with manifest.json , color.png , and outline.png . The two image
files are the icons for your app in Teams.
Make sure that the 3 files are the top level of the ZIP package, with no nested folders.
Step 4: Run the app in Microsoft Teams
1. If your tenant has sideloading apps enabled, you can install your app to a team by following
the instructions below.
Upload package to a team using the Apps tab: https://docs.microsoft.com/en-

us/microsoftteams/platform/concepts/apps/apps-upload#upload-your-package-into-a-
team-using-the-apps-tab
Upload package to a team using the Store: https://docs.microsoft.com/en-
us/microsoftteams/platform/concepts/apps/apps-upload#upload-your-package-into-a-
team-or-conversation-using-the-store
2. You can also upload it to your tenant's app catalog, so that it can be available for everyone
in your tenant to install: https://docs.microsoft.com/en-us/microsoftteams/tenant-apps-
catalog-teams
Troubleshooting
Please see our Troubleshooting page.
Pages 11
Find a Page…
Home
Best practices when using Icebreaker
Continuous Deployment
Cost estimate
Data stores
Deployment guide
Run local
Solution overview
Taking it further
Telemetry
Troubleshooting
Clone this wiki locally
https://github.com/OfficeDev/microsoft-teams-apps-icebreaker.wiki.git

Icebreaker App Deployment Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Icebreaker App Deployment Guide

Uploaded by

Copyright:

Available Formats

12/15/2020 Deployment guide · OfficeDev/microsoft-teams-apps-icebreaker Wiki · GitHub

Code Issues 49 Pull requests 6 Actions Projects Wiki Security Insights

Adrian Solis edited this page on Aug 19, 2019 · 6 revisions

Step 1: Register Microsoft Azure AD application

2. Click on "New registration", and create an Azure AD application.

3. Click on the "Register" button.

At this point you have 2 unique values:

One application (client) ID

Step 2: Deploy to your Azure subscription

2. When prompted, log in to your Azure subscription.

4. Select a subscription and resource group.

We recommend creating a new resource group.

5. Fill in the various IDs in the template:

7. Click on “Purchase” to start the deployment.

Step 3: Create the Teams app package

developer.name (What's this?)

Step 4: Run the app in Microsoft Teams

Upload package to a team using the Apps tab: https://docs.microsoft.com/en-

Best practices when using Icebreaker

Clone this wiki locally

You might also like