Configure Microsoft Entra Connect cloud sync

Completed

Once the Microsoft Entra Cloud Sync prerequisites are met, organizations must complete the following tasks to install Microsoft Entra Connect cloud sync:

  1. Install the Microsoft Entra Connect provisioning agent.
  2. Verify the agent is installed.
  3. Verify the agent is running.
  4. Configure Microsoft Entra Connect cloud sync provisioning.

Each of these tasks is outlined in the following sections.

Task 1 - Install the Microsoft Entra Connect provisioning agent

This task examines the installation process for the Microsoft Entra Connect provisioning agent and how to initially configure it in the Azure portal.

Note

This unit deals with installing the provisioning agent by using the Microsoft Entra Connect Provisioning Agent wizard. For information on installing the Microsoft Entra Connect provisioning agent by using a command-line interface (CLI), see Install the Microsoft Entra Connect provisioning agent by using a CLI and PowerShell.

You should complete the following steps to install the Microsoft Entra Connect provisioning agent:

  1. Sign in to the server you'll use with enterprise admin permissions.

  2. Sign in to the Azure portal, and then go to Microsoft Entra ID.

  3. On the menu on the left, select Microsoft Entra Connect.

  4. On the Provision from Active Directory window, select Manage Microsoft Entra Cloud Sync.

    screenshot of the Provision from Active Directory window showing the Manage Microsoft Entra Cloud Sync option selected.

  5. On the Microsoft Entra Connect cloud sync screen, select the Download agent option that appears in the menu bar at the top of the page.

  6. On the Microsoft Entra provisioning Agent window that appears, select the Accept terms & download button.

  7. Once the agent has completed downloading, select Open file. This option will start the installation.

  8. On the Microsoft Entra Connect Provisioning Agent Package screen, accept the licensing terms and select Install.

  9. On the Welcome to Microsoft Entra Connect provisioning agent configuration wizard page, select Next.

  10. Sign in with your Microsoft Entra Global Administrator account.

  11. On the Configure Service Account page, select either Create gMSA, or Use custom gMSA.

    screenshot of the Configure Service Account window showing the Create gMSA option and the Use custom gMSA option.

  12. If you allow the agent to create the account, enter the domain administrator credentials to create the group managed service account that will be used to run the agent service and then select Next. The account that's created will be named provAgentgMSA$.

  13. If you specify Use custom gMSA, you'll be prompted to provide this account.

  14. On the Connect Active Directory page, select Next. Your current domain is automatically displayed. If you wish to add more domains, enter them and select Add Directory. Then sign in with an administrator account from that domain.

  15. You can optionally manage the preference of domain controllers the agent will use by selecting Add Directory and then selecting the Select domain controller priority check box. A list of domain controllers will appear. Order the list of domain controllers and then select OK.

  16. On the Agent installation page, confirm the settings and the account that will be created and then select Confirm.

  17. After this operation finishes, a message should appear that indicates the agent installation is complete. Select Exit.

  18. If you still see the initial Microsoft Entra Connect Provisioning Agent Package screen, select Close.

Task 2 - Verify the agent is installed

Agent verification occurs in the Azure portal and on the local server that's running the agent. You should complete this task to verify the agent is being seen by Azure:

  1. Sign in to the Azure portal.

  2. In the navigation pane, select Microsoft Entra ID > Microsoft Entra Connect.

  3. On the Microsoft Entra Connect page, in the center pane, select Manage cloud sync.

  4. On the Microsoft Entra Connect cloud sync screen, select the Review all agents option that appears on the menu bar.

  5. On the On-premises provisioning agents screen, the agents that you installed are displayed. Verify the agent you installed appears and that its Status is active.

    Screenshot of the On-premises provisioning agents window showing the newly created agent and its Active status highlighted.

Task 3 - Verify the agent is running

On the local server in which the agent is installed, you should then complete this task to verify the agent is running:

  1. Sign in to the server with an administrator account.

  2. Open Services by going to it or by selecting Start > Run > Services.msc.

  3. Under Services, verify Microsoft Entra Connect Agent Updater and Microsoft Entra Connect Provisioning Agent are present. and that their status is Running.

    screenshot of the Services window showing the Microsoft Entra Connect Agent and Updater services highlighted.

Task 4 - Configure Microsoft Entra Connect cloud sync provisioning

Once the agent is installed, it must be configured and enabled before it will start synchronizing users. Complete this task to configure the agent:

  1. Sign in to the Azure portal, and then go to Microsoft Entra ID.

  2. On the menu on the left, select Microsoft Entra Connect.

  3. On the Provision from Active Directory window, select Manage Microsoft Entra Cloud Sync.

  4. Select New configuration.

  5. On the New provisioning configuration screen, select the domain you want to sync and whether to enable password hash sync. Select Create.

  6. The Edit cloud sync configuration screen will appear. Update the following sections of this screen to configure the agent:

    1. Scope. Configure whether all users are in scope, or configure scoping filters to provision specific users and groups.

    2. Manage attributes. You can map attributes between your on-premises user/group objects and the objects in Microsoft Entra ID. You can customize the default attribute-mappings according to your business needs. In doing so, you can change or delete existing attribute-mappings, or create new attribute-mappings.

    3. Validate (recommended). Select the Provision a user button. This option verifies that synchronization is working as expected before enabling the configuration. It does so by testing with individual users that you enter after selecting the Provision a user button.

    4. Settings. Enter a Notification email address. This email will be notified when provisioning isn't healthy. It's recommended that you keep the Prevent accidental deletion check box selected. You should also set the Accidental deletion threshold to a number that you wish to be notified about.

    5. Deploy. Select Enable to sync the users and groups that are in scope as defined in the Scope section.

      screenshot of the Edit cloud sync configuration screen.

  7. Move the selector to Enable and then select Save.