AAD Connect configuration documenter is a tool to generate documentation of an Azure AD Connect installation. Currently, the documentation is only limited to the Azure AD Connect sync configuration.
The goal of this project is to:
- To enable quick understanding of the synchronization configuration and "how it happens"!
- To build confidence in getting things right when making changes to the default configuration!!
- To know what was changed when you applied a new build / configuration of Azure AD Connect or added/updated custom sync rules!!!
The current capabilities of the tool include:
- Documentation of the complete configuration of Azure AD Connect sync.
- Documentation of any changes in the configuration of two Azure AD Connect sync servers or changes from a given configuration baseline.
- Generation of the PowerShell deployment script to migrate the sync rule differences or customizations from one server to another.
Prerequisites:
- .NET Framework 4.5 to be able to run the tool.
- A modern browser (e.g. Microsoft Edge) to view the report.
- A fair understanding of MIIS 2003 / ILM 2007 / FIM 2010 / MIM 2016 / AAD Sync sync engine technical concepts to be able to understand the report. A sample report generated by the tool can be found listed in the Wiki section.
How to use the tool:
- Download the latest release AzureADConnectSyncDocumenter.zip from the releases tab under the Code tab.
- UNBLOCK the downloaded zip file using the Right Click | Properties menu and then checking the Unblock check-box from the General tab.
- Extract the zip file to an empty local folder on a machine which has .NET Framework 4.5 installed.
- This will extract the Documenter application binaries along with the sample data files for "Contoso".
- Make sure that the tool runs by double-clicking on the .cmd file AzureADConnectSyncDocumenter-Contoso.cmd.
- Export the Server Configuration of your pilot / test Azure AD Connect sync server by running Get-ADSyncServerConfiguration cmdlet defined in ADSync module shipped with Azure AD Connect.
Import-Module ADSync
Get-ADSyncServerConfiguration -Path "<CompletePathToOutputFolder>"
- Copy the configuration export files produced in the previous step to a folder under the "Data" directory of the Documenter tool.
- e.g. the "Pilot" configuration files for the customer "Contoso" are provided as a sample under the "Data\Contoso\Pilot" folder. This is the folder where the files of the to be or end-state configuration are located. So, for example, in a swing migration project the "Pilot" or "Target" configuration will be the configuration of the "old" server, since the goal is to build a new server with the configuration as close to the old server as possible.
- If you want to document the changes from a specific baseline, export the server configuration of your baseline / production Azure AD Connect server and copy the output to a folder under the Documenter "Data" directory.
- e.g. the "Production" configuration files for the customer "Contoso" are provided as a sample under the "Data\Contoso\Production" folder. This is the folder where the files of the as-is or baseline configuration are located.
- Make a copy of AzureADConnectSyncDocumenter-Contoso.cmd with a name appropriate for your environment (say AzureADConnectSyncDocumenter-Fabrikam.cmd) and edit your copy for the values of "Pilot" and "Production" directories.
- If you don't have a baseline / production config, specify the same path as the "Pilot" config.
- Run your updated batch file. Upon successful execution, the generated report will be found in the Documenter "Report" folder.
!!NOTE!! If the name(s) of the connector(s) do(es) not exactly match between the supplied "Pilot" and "Production" configuration files, then before running the tool, "prep" the exported config files by manually editing the xml files located in the "Connectors" folder so that the name of the connector(s) match. The name of the connector is located inside the "name" element at the start of the content.
A sample report generated by the tool can be found listed in the Wiki section.
https://aka.ms/aadConnectConfigDocumenter
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.