page_type

description

products

languages

sample

This sample demonstrates how to use the Microsoft Graph .NET SDK to access data in Office 365 from Azure Functions.

ms-graph

microsoft-graph-mail-api

microsoft-graph-change-notifications-api

office-exchange-online

azure-functions

csharp

Microsoft Graph sample Azure Function

This sample demonstrates how to use the Microsoft Graph .NET SDK to access data in Office 365 from Azure Functions.

NOTE: This sample was originally built from a tutorial published on the Microsoft Graph tutorials page. That tutorial has been removed.

Prerequisites

App registrations

This sample requires three Azure AD application registrations:

An app registration for the single-page application so that it can sign in users and get tokens allowing the application to call the Azure Function.
An app registration for the Azure Function that allows it to use the on-behalf-of flow to exchange the token sent by the SPA for a token that will allow it to call Microsoft Graph.
An app registration for the Azure Function webhook that allows it to use the client credential flow to call Microsoft Graph without a user.

NOTE This example requires three app registrations because it is implementing both the on-behalf-of flow and the client credential flow. If your Azure Function only uses one of these flows, you would only need to create the app registrations that correspond to that flow.

Open a browser and navigate to the Azure Active Directory admin center and login using an Microsoft 365 tenant organization admin.
Select Azure Active Directory in the left-hand navigation, then select App registrations under Manage.

Register an app for the single-page application

Select New registration. On the Register an application page, set the values as follows.
- Set Name to Graph Azure Function Test App.
- Set Supported account types to Accounts in this organizational directory only.
- Under Redirect URI, change the dropdown to Single-page application (SPA) and set the value to http://localhost:8080.
Select Register. On the Graph Azure Function Test App page, copy the values of the Application (client) ID and Directory (tenant) ID and save them, you will need them in the later steps.

Register an app for the Azure Function

Return to App Registrations, and select New registration. On the Register an application page, set the values as follows.
- Set Name to Graph Azure Function.
- Set Supported account types to Accounts in this organizational directory only.
- Leave Redirect URI blank.
Select Register. On the Graph Azure Function page, copy the value of the Application (client) ID and save it, you will need it in the next step.
Select Certificates & secrets under Manage. Select the New client secret button. Enter a value in Description and select one of the options for Expires and select Add.
Copy the client secret value before you leave this page. You will need it in the next step.

IMPORTANT This client secret is never shown again, so make sure you copy it now.
Select API Permissions under Manage. Choose Add a permission.
Select Microsoft Graph, then Delegated Permissions. Add Mail.Read and select Add permissions.
Select Expose an API under Manage, then choose Add a scope.
Accept the default Application ID URI and choose Save and continue.
Fill in the Add a scope form as follows:
- Scope name: Mail.Read
- Who can consent?: Admins and users
- Admin consent display name: Read all users' inboxes
- Admin consent description: Allows the app to read all users' inboxes
- User consent display name: Read your inbox
- User consent description: Allows the app to read your inbox
- State: Enabled
Select Add scope.
Copy the new scope, you'll need it in later steps.
Select Manifest under Manage.
Locate knownClientApplications in the manifest, and replace it's current value of [] with ["TEST_APP_ID"], where TEST_APP_ID is the application ID of the Graph Azure Function Test App app registration. Select Save.

NOTE Adding the test application's app ID to the knownClientApplications property in the Azure Function's manifest allows the test application to trigger a combined consent flow. This is necessary for the on-behalf-of flow to work.

Add Azure Function scope to test application registration

Return to the Graph Azure Function Test App registration, and select API Permissions under Manage. Select Add a permission.
Select My APIs, then select Load more. Select Graph Azure Function.
Select the Mail.Read permission, then select Add permissions.
In the Configured permissions, remove the User.Read permission under Microsoft Graph by selecting the ... to the right of the permission and selecting Remove permission. Select Yes, remove to confirm.

Register an app for the Azure Function webhook

Return to App Registrations, and select New registration. On the Register an application page, set the values as follows.
- Set Name to Graph Azure Function Webhook.
- Set Supported account types to Accounts in this organizational directory only.
- Leave Redirect URI blank.
Select Register. On the Graph Azure Function webhook page, copy the value of the Application (client) ID and save it, you will need it in the next step.
Select Certificates & secrets under Manage. Select the New client secret button. Enter a value in Description and select one of the options for Expires and select Add.
Copy the client secret value before you leave this page. You will need it in the next step.
Select API Permissions under Manage. Choose Add a permission.
Select Microsoft Graph, then Application Permissions. Add User.Read.All and Mail.Read, then select Add permissions.
In the Configured permissions, remove the delegated User.Read permission under Microsoft Graph by selecting the ... to the right of the permission and selecting Remove permission. Select Yes, remove to confirm.
Select the Grant admin consent for... button, then select Yes to grant admin consent for the configured application permissions. The Status column in the Configured permissions table changes to Granted for ....

Configure the sample

Run ngrok using the following command. (Only required if using the change notification webhook portion of the sample)
```
ngrok http 7071
```
Rename config.example.js to config.js and replace the following values:
- YOUR_TEST_APP_CLIENT_ID_HERE - replace with the client ID for Graph Azure Function Test App
- YOUR_TENANT_ID_HERE - replace with your tenant ID
- YOUR_AZURE_FUNCTION_CLIENT_ID_HERE - replace with the client ID for Graph Azure Function
Use dotnet user-secrets set in the GraphSampleFunctions directory to set the following values.
- apiClientId - the client ID for Graph Azure Function
- apiClientSecret - the client secret for Graph Azure Function
- ngrokUrl - your ngrok URL (copy from ngrok output)
- tenantId - your tenant ID
- webhookClientId - the client ID for Graph Azure Function Webhook
- webhookClientSecret - the client secret for Graph Azure Function Webhook

NOTE If you restart ngrok, you will need to update the ngrokUrl value in user secrets with the new ngrok URL and restart the Azure Function project.

Run the sample

The following command (run in the GraphSampleFunctions directory) will start the Azure Function project locally on your machine.

func start

To serve the test client, run your favorite command-line HTTP server in the TestClient directory. For example, you can use dotnet-serve.

dotnet serve -h "Cache-Control: no-cache, no-store, must-revalidate" -p 8080

Open your browser to http://localhost:8080 and sign in with a user in your tenant.

Code of conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

tiru007/msgraph-sample-azurefunction-csharp