Articles in this section

See more
Print

Office 365 Users | Enforce License Profile rule

Avatar
Tatiana Golubovich
  • Updated
Follow

 

Rule description

This Microsoft 365 rule queries the specified scope and assigns the selected license profile for each user that satisfies the criteria.

For more information about license profiles please see License Profiles – Cayosoft Help Center.

 

When to use this rule

You can use this rule in the following scenarios: 

  1. Enforce license profiles to hybrid users in bulk.
  2. Report about license profiles that are currently assigned to users.
  3. Clear license profiles currently assigned to users and keep existing licenses.
  4. Clear license profiles currently assigned to users and revoke existing licenses.
  5. Reapply currently assigned profiles.

 

Rule Settings

Query Section

Setting name Description

General Settings

  

Use previous provision rule results instead of this query

 When used in a runbook, will take the users from the output of certain supported provisioning rule instead of directly through this query section.
Limit scope to this Azure AD Administrative Unit

You can select Azure AD Administrative Unit to limit the Web Query scope.

By default, the value is taken from the Virtual Admin Unit setting.
Query criteria Query criteria are sent to the target platform with other query parameters to reduce the number of returned objects and may improve query performance.

Apply to unlicensed users only

It is possible to select whether to run the rule for all users or only for those who don't have a license. 

Exclude Office 365 disabled users

This setting allows to exclude Office 365 disabled users from the rule scope or to include them.

Include users with this profile

Specify with which profiles users should be included in the query scope:

  1. Any profile. 
  2. Profile not set.
  3. Profile that is selected from the list of configured profiles.

More options

  

Properties to Display

To display additional Office 365 properties for each object found by the query, add those properties to the list. 

System properties

List of properties required for this rule to be executed correctly.

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.

Sort by

Sort result objects list.

MS Graph query condition (OData)

By default Query criteria is used. But when the MS Graph query condition is specified, it overrides the Query criteria setting.

Example: find all Office 365 user accounts with displayname starting with 'Adam.'

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>. 

Limit result set

 

The maximum number of users returned from Office 365 by default is 2000. 

Tip: It is possible to change the default value in Microsoft Office 365 extension 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.

More Options

 

Stop rule if tenant licensing change detected

 

It is recommended to stop the rule execution if a tenant licensing change is discovered.

Tip: If licensing change is detected, you should click Update License in Microsoft Office 365 extension. For details, see KB20181017-1.

Stop rule if errors exceed

 

Too many errors may indicate rule misconfiguration or problems with connectivity.

Set this value to some integer value, indicating the number of occurred errors, when the rule execution should stop. 

Exclude shared mailboxes

Specify if shared mailboxes should be excluded.

 

Action Section

Setting name Description
Run mode

Two options are possible:

  1. Report only - get the report about profiles that are currently assigned to users in the rule scope.
  2. Enforce and report - enforce the profile defined in the rule and report about the results.
License profile

Select one of the configured license profiles or specify if:

  1. Reapply currently assigned profile.
  2. Clear profile and keep existing licenses.
  3. Clear profile and revoke existing licenses.
Users with deleted profiles

Specify what should be done if the license profile should be reapplied but this profile was deleted:

  1. Skip and report.
  2. Clear profile and keep existing licenses.
  3. Clear profile and revoke all licenses.
Free selection behavior

Specify if the license with the Free selection enforcement option should be assigned to a user: 

  1. Default - assign licenses marked as Free selection (selected) inside the profile but only for users without existing license assignments. 
  2. Always ignore - don't assign licenses with Free selection (selected).
  3. Always assign - assign licenses with Free selection (selected).
Change UsageLocation only if not set Specify whether to keep the current user's usage location or change it to a new one.
Usage Location

Select the usage location.

Important: If Office 365 user accounts don't have a location attribute set, Office 36 license won't apply to them, and the rule will stop with the error.

If you use Usage Location from AD value for this setting, you must be sure all Active Directory user accounts, that fall under this rule, have the location attribute set.

 

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
8.2.0 The rule is introduced in the product.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.