Groups web query
The Groups web query displays Microsoft Office 365 group objects. Groups web query is included in the built-in Microsoft Office 365 container.
NOTE: Room Lists are not displayed in the Groups web query.
Groups web query settings
| 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 admin unit. IMPORTANT: To test rule configuration, limit the rule scope to an Entra ID admin unit that contains test accounts or objects. |
| Query criteria | Use the setting to filter out objects by the property values. Query criteria are sent with the query to the target system; the target system filters data before it returns the resulting set.The default value for this setting is specified in the Web query default filter field in Microsoft 365 extension settings, set to include all objects by default. See How to use Query Builder dialog for Query Criteria and Filter rule settings for use cases. |
| Post-query filter |
To hide unwanted data based on criteria, not supported by the target system in the query criteria, set the filtering conditions here. Example: filter by the found object Distinguished Name. TIP: For optimal performance, use the Query criteria above to filter objects whenever possible. |
| Group type |
Specify the type of groups that should be included in the web query scope:
|
| 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. |
| Group type filters | |
| Membership type |
Specify membership type:
|
| Group sync status |
Specify group sync status:
|
| Privacy |
Specify privacy:
NOTE: Applies only to Microsoft 365 type groups. Limiting group privacy uses a post-filter and will decrease the rule performance. Please note that group privacy can be set only during group creation. |
| Group search filters | |
|
Specify group properties for search. |
| Classification equals |
Specify group classification. NOTE: Classification is searched by classic Entra ID classification values. |
| Number of members less than or equal to | Filtering by the number of members requires loading per group properties and will decrease rule performance if used. |
| Number of owners less than or equal to | Filtering by the number of owners requires loading per group user properties and will decrease rule performance if used. |
| Date time filters | |
| Minimum group age (hours) | Specify the minimum age in hours for the Microsoft 365 groups. Will return groups older than specified hours. 0 returns all groups. Uses a post filter which will affect the rule performance. |
| Maximum group age (hours) | Specify the maximum age in hours for the Microsoft 365 groups. Will return groups older than specified hours. Uses a post filter which will affect the rule performance. |
| Expiration date (days until) | Will return groups set to expire within specified days. |
| Last renew date (days ago) | Will return groups whose last expiration renewal date happened the specified (or more) days ago. Uses a post filter which will affect the rule performance. |
| Last sync time (days ago) | Will return groups last synced the specified (or more) days ago. Cloud-only groups that were never synced are excluded. Uses a post filter which will affect the rule performance. |
| Licensing Filters | |
| Licensed groups | Will return groups that have assigned licenses and are used for Group-based licensing. Uses a post filter which will affect the rule performance. |
| Map to text file | |
| Select data source |
Specify the text file to be imported. The […] (three dots) button allows the user to browse for the file and the Create/Edit button allows the creation or editing of the existing file in the built-in Data Source editor. |
| Separator used in file | Specify the separator used in the source CSV file. |
| Data source anchor attribute | Select a column in the data source that contains the attribute value for identifying and mapping a computer. |
| System anchor attribute | Specify group anchor attribute. |
| Other Query Settings | |
| Sort by | Sort result object list. |
| 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. |
| MS Graph advanced queries | Enables consistency level eventually which uses an index that might not be up-to-date with recent changes to the object. |
| Default number of objects to show |
Select the number of objects to display in the Users web query in the Web Portal. By default, the global Web Portal setting from the Web Portal Customization > Default number of objects to show is used. Learn more in Web Portal settings. |
| Initialization script | |
| Initialization 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.
|
Web Actions tab
For details review the following article: How to add, remove or re-arrange Web actions within a Web Query.
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.
Change History
| Version | Notes |
|---|---|
| 11.1.0 | The Groups web query has been updated with new settings. |
| 10.4.0 | The Groups web query has been updated. |
Comments
0 comments
Please sign in to leave a comment.