Rule description
This rule queries the specified Microsoft SQL data source and suspends Microsoft 365 user accounts according to the Microsoft 365 user account suspend configuration.
When to use this rule
Use this rule when you need to suspend Microsoft 365 user accounts based on the data in the external data source, for example, the HR system.
Rule Settings
Query Section
Setting name | Description |
---|---|
SQL Instance
|
Specify the name of the SQL Instance as defined in the Utils Extension SQL Server configuration. Using the Default SQL Instance setting will retrieve the current setting from the SQL Connection settings of the Utils extension.
Note: For more information, please see the Connecting to Microsoft SQL Server data source article.
|
SQL Database Name |
Specify database name from selected SQL Instance. |
SQL Table |
Specify SQL Table or View from the selected database. Click the [...] button to display a list of tables from which to choose. |
SQL Credentials |
Specify the database from the data source SQL Instance. Click the [...] button to enter SQL Credentials.
Note: Cayosoft Administrator does not support Windows Authentication for connecting to a Microsoft SQL Server database. The database connection must use SQL Server Authentication, where the credentials (username and password) are created and managed within SQL Server itself. Mixed Mode refers to the SQL Server configuration that allows both SQL Server Authentication and Windows Authentication, but only SQL Server Authentication is supported by Cayosoft.
|
Data Source Filter |
You can use the point-and-click filter builder for the specified data source. Note: If the 'Where' Clause is also specified, it will be applied and the 'DataSource Filter' will be ignored.
|
Data Source Anchor attribute |
Select the column in the data source that will be used to find a matching user account in Microsoft 365 and suspend a matching account. The value of this column in the data source is compared to the Office 365 Anchor Attribute value in Microsoft 365. |
Office 365 Anchor attribute |
Select the attribute in Microsoft 365 to compare the Data Source Anchor Attribute when searching for a matching user account. |
More options | |
Return These SQL Columns
|
Specify columns returned by the data source. |
Where Clause |
Define a WHERE statement in the SQL query sent to the data source to limit the rows returned by SQL Server. |
Properties to display |
Select properties to display for each object found by the query. |
Filter SQL Data
|
Set the filtering conditions to only return objects or data that need to be processed by the rule. Example: filter by Name column.
|
Filter Office 365 users |
To hide unwanted data set the filtering conditions here. |
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 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)}
|
Action Section
Setting name | Description |
---|---|
Microsoft 365 Suspend configuration |
Specify the existing Microsoft 365 Suspend configuration that should be applied during the Microsoft 365 user suspend. It is possible to use the default Microsoft 365 User Suspend configuration or create a custom Suspend configuration. |
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.