| title | How to use Microsoft Entra workbooks |
|---|---|
| description | Learn how to use Azure Monitor workbooks for Microsoft Entra ID, for analyzing identity related activity, trends, and gaps. |
| ms.topic | how-to |
| ms.date | 10/02/2024 |
| ms.reviewer | sarbar |
Workbooks are found in Microsoft Entra ID and in Azure Monitor. The concepts, processes, and best practices are the same for both types of workbooks, however, workbooks for Microsoft Entra ID cover only those identity management scenarios that are associated with Microsoft Entra ID.
When using workbooks, you can either start with an empty workbook, or use an existing template. Workbook templates enable you to quickly get started using workbooks without needing to build from scratch.
- Public templates published to a gallery are a good starting point when you're just getting started with workbooks.
- Private templates are helpful when you start building your own workbooks and want to save one as a template to serve as the foundation for multiple workbooks in your tenant.
[!INCLUDE workbook prerequisites]
-
Sign in to the Microsoft Entra admin center as at least a Reports Reader.
-
Browse to Entra ID > Monitoring & health > Workbooks.
- Workbooks: All workbooks created in your tenant
- Public Templates: Prebuilt workbooks for common or high priority scenarios
- My Templates: Templates you created
-
Select a report or template from the list. Workbooks might take a few moments to populate.
- Search for a template by name.
- Select the Browse across galleries to view templates that aren't specific to Microsoft Entra ID.
Workbooks can be created from scratch or from a template. When creating a new workbook, you can add elements as you go or use the Advanced Editor option to paste in the JSON representation of a workbook, copied from the workbooks GitHub repository.
To create a new workbook from scratch:
-
Browse to Entra ID > Monitoring & health > Workbooks.
-
Select + New.
-
Select an element from the + Add menu.
For more information on the available elements, see Creating an Azure Workbook.
To create a new workbook from a template:
-
Browse to Entra ID > Monitoring & health > Workbooks.
-
Select a workbook template from the Gallery.
-
Select Edit from the top of the page.
- Each element of the workbook has its own Edit button.
- For more information on editing workbook elements, see Azure Workbooks Templates
-
Select the Edit button for any element. Make your changes and select Done editing.
-
When you're done editing the workbook, select the Save button. The Save as window opens.
-
Provide a Title, Subscription, Resource Group* and Location
- You must have the ability to save a workbook for the selected Resource Group.
- Optionally choose to save your workbook content to an Azure Storage Account.
-
Select the Apply button.
