What is the Azure AD Connect Administration Agent?

The Azure AD Connect Administration Agent is a component of Azure AD Connect that can be installed on an Azure AD Connect server. The agent is used to collect specific data from your hybrid Active Directory environment. The collected data helps a Microsoft support engineer troubleshoot issues when you open a support case.

Note

The Azure AD Connect Administration Agent is no longer part of the Azure AD Connect installation, and it can't be used with Azure AD Connect version 2.1.12.0 or later.

The Azure AD Connect Administration Agent waits for specific requests for data from Azure Active Directory (Azure AD). The agent then takes the requested data from the sync environment and sends it to Azure AD, where it's presented to the Microsoft support engineer.

The information that the Azure AD Connect Administration Agent retrieves from your environment isn't stored. The information is shown only to the Microsoft support engineer to help them investigate and troubleshoot an Azure AD Connect-related support case.

By default, the Azure AD Connect Administration Agent isn't installed on the Azure AD Connect server. To assist with support cases, you must install the agent to collect data.

Install the Azure AD Connect Administration Agent

To install the Azure AD Connect Administration Agent on the Azure AD Connect server, first be sure you meet some prerequisites, and then install the agent.

Prerequisites:

  • Azure AD Connect is installed on the server.
  • Azure AD Connect Health is installed on the server.

Screenshot that shows the admin agent on the server.

The Azure AD Connect Administration Agent binaries are placed on the Azure AD Connect server.

To install the agent:

  1. Open PowerShell as administrator.
  2. Go to the directory where the application is located: cd "C:\Program Files\Microsoft Azure Active Directory Connect\Tools".
  3. Run ConfigureAdminAgent.ps1.

When prompted, enter your Azure AD Hybrid Identity Administrator credentials. These credentials should be the same credentials you entered during Azure AD Connect installation.

After the agent is installed, you'll see the following two new programs in Add/Remove Programs in Control Panel on your server:

Screenshot that shows the Add/Remove Programs list that includes the new programs you added.

What data in my sync service is visible to the Microsoft support engineer?

When you open a support case, the Microsoft support engineer can see this information for a specific user:

  • The relevant data in Windows Server Active Directory (Windows Server AD).
  • The Windows Server AD connector space on the Azure AD Connect server.
  • The Azure AD connector space on the Azure AD Connect server.
  • The metaverse in the Azure AD Connect server.

The Microsoft support engineer can't change any data in your system, and they can't see any passwords.

What if I don't want the Microsoft support engineer to access my data?

After the agent is installed, if you don't want the Microsoft support engineer to access your data for a support call, you can disable the functionality by modifying the service config file:

  1. In Notepad, open C:\Program Files\Microsoft Azure AD Connect Administration Agent\AzureADConnectAdministrationAgentService.exe.config.

  2. Disable the UserDataEnabled setting as shown in the following example. If the UserDataEnabled setting exists and is set to true, set it to false. If the setting doesn't exist, add the setting.

    <appSettings>
      <add key="TraceFilename" value="ADAdministrationAgent.log" />
      <add key="UserDataEnabled" value="false" />
    </appSettings>
    
  3. Save the config file.

  4. Restart the Azure AD Connect Administration Agent service as shown in the following figure:

    Screenshot that shows how to restart the Azure AD Connect Administrator Agent service.

Next steps

Learn more about integrating your on-premises identities with Azure Active Directory.