Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
page_type description products languages extensions urlFragment
sample
This is a sample application which demonstrates the use of team/Channel subscription that will post notifications when user create/edit/delete team/channel through teams tab.
office-teams
office
office-365
Csharp
contentType createdDate
samples
08/25/2022 11:30:00 AM
officedev-microsoft-teams-samples-graph-change-notification-team-channel

Change Notifications For Team and Channel Using Microsoft Graph C#

This is a sample application which demonstrates use of Team/Channel subscription that will post notifications when user create/edit/delete team/channel.

Included Features

  • Tabs
  • Graph API
  • RSC Permissions
  • Change Notifications

Interaction with bot

Notifications

Prerequisites

  • Microsoft Teams is installed and you have an account (not a guest account)
  • .NET 6.0 SDK.
        # determine dotnet version
        dotnet --version
  • dev tunnel or ngrok latest version or equivalent tunneling solution
  • M365 developer account or access to a Teams account with the appropriate permissions to install an app.

Setup

Note these instructions are for running the sample on your local machine.

  1. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous
  2. Setup for Bot

Register your application with Azure AD

  1. Register a new application in the [Microsoft Entra ID App Registrations portal.
  2. 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.
  3. Navigate to API Permissions, and make sure to add the follow permissions:
  • Select Add a permission

  • Select Microsoft Graph -> Application permissions.

  • Channel.ReadBasic.All,ChannelSettings.Read.All,Directory.ReadWrite.All,Group.ReadWrite.All Team.ReadBasic.All,TeamSettings.Read.All,TeamSettings.ReadWrite.All

  • Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

  1. Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select Expiry date. Click "Add", Once the client secret is created, copy its value because it needs to be placed in the appsettings.json file.

Create Azure bot resource

In Azure portal, create a Azure Bot resource.

  • Ensure that you've enabled the Teams Channel.
  • In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running the tunnelling application. Append with the path /api/messages

Create and install Self-Signed certificate

To include resource data of graph notifications, this Graph API require self-signed certificate. Follow the below steps to create and manage certificate.

  1. You can self-sign the certificate, since Microsoft Graph does not verify the certificate issuer, and uses the public key for only encryption.

  2. Use Azure Key Vault as the solution to create, rotate, and securely manage certificates. Make sure the keys satisfy the following criteria:

    • The key must be of type RSA
    • The key size must be between 2048 and 4096 bits
  3. Follow this documentation for the steps - Create and install Self-Signed certificate

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

A) If you are using Visual Studio

  • Launch Visual Studio
  • File -> Open Folder
  • Navigate to samples/graph-change-notification-team-channel/csharp folder
  • Select ChangeNotiifcation solution file

Instruction for appsetting 1. Provide MicrosoftAppId, MicrosoftAppPassword and MicrosoftAppTenantId in the appsetting that is created in Azure. (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.) 2. Provide the tunnel url as "BaseUrl" in appsetting on which application is running on. 3. You should be having Base64EncodedCertificate and CertificateThumbprint value from Create and install Self-Signed certificate step.

  • Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.

B) This step is specific to Teams.

  • Edit the manifest.json contained in the AppManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)

  • Edit the manifest.json for validDomains with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.

  • 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)

  • 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.)

  • Add the app to personal/team/groupChat scope (Supported scopes)

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Running the sample

You can interact with Teams Tab by subscribing the teams/channel for notifications.

  1. Show Welcome - Channel -> Welcome Message when Channel selected for subscription. Channel-Welcome

  2. Channel Notifications -> Channel Created Update Delete Message CreatedDeletedUpdated-Channel

  3. Show Welcome - Team -> Welcome Message when Team selected for subscription. Team-Welcome

  4. Team Notifications -> Team Update Edit Message TeamEditUpdate

Further reading