Microsoft 365 Users with Licenses rule
Rule description
This rule queries Microsoft 365 accounts, filters them by the specified licensing criteria, and returns the resulting accounts and their licensing details.
When to use this rule
Use this rule to get a report with Microsoft 365 users filtered by licensing criteria.
Rule settings
Query section
| Setting name | Description |
|---|---|
Limit scope to this Azure AD Administrative Unit |
This setting defines the search query scope. To improve query performance, limit the scope to a specific Entra ID administrative unit. IMPORTANT: To test the rule configuration, limit the rule scope to an administrative unit that contains test accounts or objects. |
Query criteria |
(missing or bad snippet) |
User state |
Specify the user state to include in the query:
|
Include licensed users |
This setting allows for the inclusion of only licensed or unlicensed users or all users. |
MS365 user mailbox type |
Specify the user mailbox type to include in the query:
|
User type |
Specify the user type to include in the query:
|
Filter by licenses |
You can filter users by assigned licenses and apps/services: License filter conditions are split into two groups: filter by licenses and filter by apps/services. Licenses can be filtered by ALL, ANY, and NOT:
Apps/services filter conditions:
Also, you can add filtering by inheritance of assigned applications and services:
|
Show license assignment paths |
If set to Yes the output report will include the license assignment paths: direct or inherited (GBL-assigned). |
Show service plan details |
If set to Yes the output report will include the names of all apps assigned to the user instead of the aggregate count. If Yes, show service plans in separate columns is selected service plans in separate columns will be displayed. |
Show service plan status |
If set to Yes the output report will include the names and statuses of all apps assigned to the user. |
License details separator character |
The separator is used when displaying multiple licenses or app names in a single output column. Possible separators are:
|
Include only filtered licenses in output |
If set to Yes the output report will only list those assigned licenses explicitly included in the filter above. |
Other Query Settings | |
Properties to Display |
Each object property defined in this setting matches the column that will be displayed in the Web Portal for this web query. To display additional columns, add the required properties to the Properties to display list. To add extension attribute 1 that is synchronized from AD, you need to use a value like:
Copy
|
System properties |
(missing or bad snippet) |
Sort by |
Sort result objects list. |
| Post-query filter |
To hide unwanted data based on criteria, not supported by the Microsoft 365 query criteria above, set the filtering conditions here. TIP: For optimal performance, use the Query criteria above to filter objects whenever possible. |
| Limit result set |
This setting is used to optimize performance by limiting the number of objects returned by the Microsoft Graph API. Unlike query criteria, any post-filters on the returned objects are applied after they are returned, which means that the final set of returned objects could be less than the number configured here despite these objects existing in the source system. |
| MS Graph query condition (OData) |
By default, Query criteria are used. But when the MS Graph query condition is specified, it overrides the Query criteria setting. See this article for examples: How to use Query Builder dialog for Query Criteria and Filter rule settings. |
Initialization script | |
| Script |
Usually, rules use query criteria to limit the query search scope. It improves the performance of the executed rule. Due to the PowerShell limitations, it is not possible to use calculated expressions in query criteria. That is the point where the initialization script can help. You can initialize a global variable in this setting and then use it in query criteria. IMPORTANT: To use a variable, declared in the initialization script, in the query scope, it must be global: Example: Update AD users, created in the last ten days.
|
Output Section
This section defines the output format of this rule.
To get more information about this section, please see the Rule Output section article.
Enforce/Schedule Section
This section defines the schedule for how often to run the rule.
To get more information about this section, please see the Rule Enforce/Schedule section article.
Comments
0 comments
Please sign in to leave a comment.