Rule description
This is a generic rule to query for Microsoft 365 contacts that satisfy the specified criteria.
When to use this rule
Use this rule to return a specific set of Microsoft 365 contacts. Other rules may use this rule as a basis to accomplish many typical scenarios. Each of these rules can be configured to query for Microsoft 365 contacts and then perform some task against them. Please, search for the "Microsoft 365 contacts" keyword on the Add Rule wizard to see the list of all available rule templates that query for Microsoft 365 contacts.
Query Section
| Setting name | Description |
|---|---|
| General Settings | |
|
Query criteria
|
Query criteria are sent with the query and may improve query performance. Tip: For different samples on the criteria builder, see KB20180410-1.
|
|
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.
|
|
Properties to display |
Each object property defined in this setting matches the column that will be displayed in the Cayosoft Web portal for this web query. To display additional columns, add the required properties to the Properties to display list. Tip: To add extension attribute 1 that is synchronized from AD you need to use a value like "OnPremisesExtensionAttributes/extensionAttribute1~Extension Attribute 1".
|
|
Contact Properties |
|
|
Contact sync status |
Specify account sync status:
|
| Job title | Specify contact attributes. |
| Department | |
| Company name | |
|
Other Query Settings |
|
|
System properties |
List of properties required for this rule to be executed correctly. |
|
Sort by |
Sort result objects list. |
|
Limit result set |
The maximum number of contacts returned from Microsoft 365 by default is 2000. Tip: It is possible to change the default value in Microsoft 365 extension settings.
|
|
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 – Cayosoft Help Center. |
|
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. |
|
Initialization script |
|
|
Script |
Usually, rules use query criteria to limit the query search scope. It improves the performance of the executed rule. Due to 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: $global:<variable name>.
Example: Update AD users, created in the last ten days.
{$global:DatePeriod = (Get-Date).AddDays(-10)}
|
Output Section
This section defines the output format of this rule.
To get more information about this section, please see the 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 Enforce/Schedule section article.
Change History
| Version | Notes |
|---|---|
| 10.3.0 | The rule has been introduced in the product. |
Comments
0 comments
Please sign in to leave a comment.