Skip to content

Commit a248aee

Browse files
Merge pull request #1786 from OfficeDev/v-ameyogale/UpdatedReadmeFile
Updated Readme
2 parents d74e5e7 + a76ec81 commit a248aee

File tree

125 files changed

+2000
-175
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+2000
-175
lines changed

samples/app-cache-meetings/nodejs/Readme.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,11 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
5656

5757
```bash
5858
devtunnel host -p 3978 --allow-anonymous
59+
60+
5961
```
6062

63+
6164
2) Clone the repository
6265

6366
```bash
@@ -91,6 +94,22 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
9194
- **Zip** up the contents of the `appManifest` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
9295
- **Upload** the `manifest.zip` to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
9396
- Upload a custom app In meetings (Supported scopes)
97+
98+
### Register you app with Azure AD.
99+
100+
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
101+
2. Select **New Registration** and on the *register an application page*, set following values:
102+
* Set **name** to your app name.
103+
* Choose the **supported account types** (any account type will work)
104+
* Leave **Redirect URI** empty.
105+
* Choose **Register**.
106+
3. On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You’ll need those later when updating your Teams application manifest and in the appsettings.json.
107+
4. Navigate to **API Permissions**, and make sure to add the follow permissions:
108+
Select Add a permission
109+
* Select Add a permission
110+
* Select Microsoft Graph -\> Delegated permissions.
111+
* `User.Read` (enabled by default)
112+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
94113
95114
96115
## Running the sample

samples/app-caching-for-multiple-tabs/nodejs/Readme.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,22 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
8787
- Upload a custom app In meetings (Supported scopes)
8888
8989
90+
### Register you app with Azure AD.
91+
92+
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
93+
2. Select **New Registration** and on the *register an application page*, set following values:
94+
* Set **name** to your app name.
95+
* Choose the **supported account types** (any account type will work)
96+
* Leave **Redirect URI** empty.
97+
* Choose **Register**.
98+
3. On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You’ll need those later when updating your Teams application manifest and in the appsettings.json.
99+
4. Navigate to **API Permissions**, and make sure to add the follow permissions:
100+
Select Add a permission
101+
* Select Add a permission
102+
* Select Microsoft Graph -\> Delegated permissions.
103+
* `User.Read` (enabled by default)
104+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
105+
90106
## Running the sample
91107
92108
**Adding tab (green) to a channel**

samples/app-checkin-location/csharp/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,23 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
126126
- Go to your project directory, the ./AppManifest folder, select the zip folder, and choose Open.
127127
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.
128128
129+
### Register your app with Azure AD.
130+
131+
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
132+
2. Select **New Registration** and on the *register an application page*, set following values:
133+
* Set **name** to your app name.
134+
* Choose the **supported account types** (any account type will work)
135+
* Leave **Redirect URI** empty.
136+
* Choose **Register**.
137+
3. On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You'll need those later when updating your Teams application manifest and in the appsettings.json.
138+
4. Navigate to **API Permissions**, and make sure to add the follow permissions:
139+
Select Add a permission
140+
* Select Add a permission
141+
* Select Microsoft Graph -\> Delegated permissions.
142+
* `User.Read` (enabled by default)
143+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
144+
145+
129146
## Running the sample
130147

131148
**Card with actions check in:**

samples/app-checkin-location/nodejs/Readme.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,23 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
110110
- Zip up the contents of the `appManifest/` folder to create a `manifest.zip`
111111
- Upload the `manifest.zip` to Teams (in the left-bottom *Apps* view, click "Upload a custom app")
112112

113+
### Register your app with Azure AD.
114+
115+
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
116+
2. Select **New Registration** and on the *register an application page*, set following values:
117+
* Set **name** to your app name.
118+
* Choose the **supported account types** (any account type will work)
119+
* Leave **Redirect URI** empty.
120+
* Choose **Register**.
121+
3. On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You'll need those later when updating your Teams application manifest and in the appsettings.json.
122+
4. Navigate to **API Permissions**, and make sure to add the follow permissions:
123+
Select Add a permission
124+
* Select Add a permission
125+
* Select Microsoft Graph -\> Delegated permissions.
126+
* `User.Read` (enabled by default)
127+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
128+
129+
113130
## Running the sample
114131
115132
**Card with actions check in:**

samples/app-checkin-location/python/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,23 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
5656

5757
> If you do not have permission to upload custom apps (uploading), Microsoft 365 Agents Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.
5858
59+
### Register your app with Azure AD.
60+
61+
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
62+
2. Select **New Registration** and on the *register an application page*, set following values:
63+
* Set **name** to your app name.
64+
* Choose the **supported account types** (any account type will work)
65+
* Leave **Redirect URI** empty.
66+
* Choose **Register**.
67+
3. On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You'll need those later when updating your Teams application manifest and in the appsettings.json.
68+
4. Navigate to **API Permissions**, and make sure to add the follow permissions:
69+
Select Add a permission
70+
* Select Add a permission
71+
* Select Microsoft Graph -\> Delegated permissions.
72+
* `User.Read` (enabled by default)
73+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
74+
75+
5976
## Setup for bot
6077

6178
> Note these instructions are for running the sample on your local machine, the tunneling solution is required because the Teams service needs to call into the bot.

samples/app-complete-sample/csharp/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,18 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
7171
NOTE: Teams does not work nor render things exactly like the Bot Emulator, but it is a quick way to see if your bot is running and functioning correctly.
7272

7373
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
74+
A) Select **New Registration** and on the *register an application page*, set following values:
75+
* Set **name** to your app name.
76+
* Choose the **supported account types** (any account type will work)
77+
* Leave **Redirect URI** empty.
78+
* Choose **Register**.
79+
B) On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You'll need those later when updating your Teams application manifest and in the appsettings.json.
80+
C) Navigate to **API Permissions**, and make sure to add the follow permissions:
81+
Select Add a permission
82+
* Select Add a permission
83+
* Select Microsoft Graph -\> Delegated permissions.
84+
* `User.Read` (enabled by default)
85+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
7486

7587
2. Setup for Bot
7688
- Register a Microsoft Entra ID aap registration in Azure portal.

samples/app-complete-sample/nodejs/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,18 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
5858
5959
## To try this sample
6060
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
61+
A) Select **New Registration** and on the *register an application page*, set following values:
62+
* Set **name** to your app name.
63+
* Choose the **supported account types** (any account type will work)
64+
* Leave **Redirect URI** empty.
65+
* Choose **Register**.
66+
B) On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You'll need those later when updating your Teams application manifest and in the appsettings.json.
67+
C) Navigate to **API Permissions**, and make sure to add the follow permissions:
68+
Select Add a permission
69+
* Select Add a permission
70+
* Select Microsoft Graph -\> Delegated permissions.
71+
* `User.Read` (enabled by default)
72+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
6173

6274
2. Register a bot with Azure Bot Service, following the instructions [here](https://docs.microsoft.com/azure/bot-service/bot-service-quickstart-registration?view=azure-bot-service-3.0).
6375
- Ensure that you've [enabled the Teams Channel](https://docs.microsoft.com/azure/bot-service/channel-connect-teams?view=azure-bot-service-4.0)

samples/app-hello-world/csharp/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,21 @@ The simplest way to run this sample in Teams is to use Microsoft 365 Agents Tool
5959
> If you do not have permission to upload custom apps (uploading), Microsoft 365 Agents Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.
6060
6161
## Setup
62+
### Register your app with Azure AD.
63+
64+
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
65+
2. Select **New Registration** and on the *register an application page*, set following values:
66+
* Set **name** to your app name.
67+
* Choose the **supported account types** (any account type will work)
68+
* Leave **Redirect URI** empty.
69+
* Choose **Register**.
70+
3. On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You'll need those later when updating your Teams application manifest and in the appsettings.json.
71+
4. Navigate to **API Permissions**, and make sure to add the follow permissions:
72+
Select Add a permission
73+
* Select Add a permission
74+
* Select Microsoft Graph -\> Delegated permissions.
75+
* `User.Read` (enabled by default)
76+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
6277

6378
### 1. Setup for Bot
6479
- Register a bot with Azure Bot Service, following the instructions [here](https://docs.microsoft.com/azure/bot-service/bot-service-quickstart-registration?view=azure-bot-service-3.0).

samples/app-hello-world/nodejs/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,22 @@ This sample is **optimized for GitHub Copilot Agent Mode** with:
162162
> Note these instructions are for running the sample on your local machine, the tunnelling solution is required because
163163
> the Teams service needs to call into the bot.
164164
165+
### Register your app with Azure AD.
166+
167+
1. Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
168+
2. Select **New Registration** and on the *register an application page*, set following values:
169+
* Set **name** to your app name.
170+
* Choose the **supported account types** (any account type will work)
171+
* Leave **Redirect URI** empty.
172+
* Choose **Register**.
173+
3. On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You'll need those later when updating your Teams application manifest and in the appsettings.json.
174+
4. Navigate to **API Permissions**, and make sure to add the follow permissions:
175+
Select Add a permission
176+
* Select Add a permission
177+
* Select Microsoft Graph -\> Delegated permissions.
178+
* `User.Read` (enabled by default)
179+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
180+
165181
### 1. Setup for Bot
166182
- In Azure portal, create a [Azure Bot resource](https://docs.microsoft.com/azure/bot-service/bot-builder-authentication?view=azure-bot-service-4.0&tabs=csharp%2Caadv2)
167183

samples/app-hello-world/python/README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,20 +80,35 @@ the Teams service needs to call into the bot.
8080
devtunnel host -p 3978 --allow-anonymous
8181
```
8282

83-
3) Create [Azure Bot resource resource](https://docs.microsoft.com/azure/bot-service/bot-service-quickstart-registration) in Azure
83+
3) Register a new application in the [Microsoft Entra ID – App Registrations](https://go.microsoft.com/fwlink/?linkid=2083908) portal.
84+
85+
A) Select **New Registration** and on the *register an application page*, set following values:
86+
* Set **name** to your app name.
87+
* Choose the **supported account types** (any account type will work)
88+
* Leave **Redirect URI** empty.
89+
* Choose **Register**.
90+
B) On the overview page, copy and save the **Application (client) ID, Directory (tenant) ID**. You'll need those later when updating your Teams application manifest and in the appsettings.json.
91+
C) Navigate to **API Permissions**, and make sure to add the follow permissions:
92+
Select Add a permission
93+
* Select Add a permission
94+
* Select Microsoft Graph -\> Delegated permissions.
95+
* `User.Read` (enabled by default)
96+
* Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
97+
98+
4) Create [Azure Bot resource resource](https://docs.microsoft.com/azure/bot-service/bot-service-quickstart-registration) in Azure
8499
- Use the current `https` URL you were given by running the tunneling application. Append with the path `/api/messages` used by this sample
85100
- Ensure that you've [enabled the Teams Channel](https://docs.microsoft.com/azure/bot-service/channel-connect-teams?view=azure-bot-service-4.0)
86101
- __*If you don't have an Azure account*__ you can use this [Azure free account here](https://azure.microsoft.com/free/)
87102
88-
4) In a terminal, go to `samples\app-hello-world`
103+
5) In a terminal, go to `samples\app-hello-world`
89104
90-
5) Activate your desired virtual environment
105+
6) Activate your desired virtual environment
91106
92-
6) Install dependencies by running ```pip install -r requirements.txt``` in the project folder.
107+
7) Install dependencies by running ```pip install -r requirements.txt``` in the project folder.
93108
94-
7) Update the `config.py` configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)
109+
8) Update the `config.py` configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)
95110
96-
8) Run your app with `python app.py`
111+
9) Run your app with `python app.py`
97112
98113
### 4. Setup Manifest for Teams
99114

0 commit comments

Comments
 (0)