Search

Microsoft Exchange

Version 26.2.9623

Microsoft Exchange

You can use the Microsoft Exchange connector from the CData Sync application to capture data from Microsoft Exchange and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Microsoft Exchange Connector

To enable Sync to use data from Microsoft Exchange, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Sources tab and locate the Microsoft Exchange row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. This action opens the Add Connection dialog box.

    Note: If the Configure Connection icon is not available, click the Download Connector icon to install the Microsoft Exchange connector.

  5. Enter a name for your connection in the Add Connection dialog box.

  6. Click Add to open the Settings tab for your connector.

For more information about installing new connectors, see Connections.

Authenticate to Microsoft Exchange

After you add the connector, you need to set the required properties.

  • Platform: Select the platform that is associated with your Exchange server. The default platform is Exchange_Online.

  • Server: Enter the address of the Exchange server to which you want to connect.

  • Office365 Environment: Select the Microsoft Office 365 environment to use when you connect to Microsoft Exchange.

CData Sync supports the ability to connect to local and cloud-hosted Microsoft Exchange files. Select your connection type below to proceed to the relevant section that contains the connection details.

OAuth

CData Sync provides an embedded OAuth application with which to connect. To use the application, select OAuth for Auth Scheme. No additional properties are required.

Azure Active Directory

To connect with an Azure Active Directory (AD) user account, specify the following properties:

  • Auth Scheme: Select AzureAD.

  • Azure Tenant: Enter the Microsoft Exchange tenant that is used to access data, either by name (for example, contoso.omnicrosoft.com) or identifier.

Azure Managed Service Identity

To leverage Azure Managed Service Identity (MSI) when CData Sync is running on an Azure virtual machine, select Azure MSI for Auth Scheme. No additional properties are required.

Azure Service Principal

To connect with an Azure service principal and client secret, set the following properties:

  • Auth Scheme: Select AzureServicePrincipal.

  • Azure Tenant: Enter the Microsoft Online tenant to which you want to connect.

  • OAuth Client Id: Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth Client Secret: Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

To obtain the OAuth client Id and client secret for your application:

  1. Log in to the Azure portal.

  2. In the left navigation pane, select All services. Then, search for and select App registrations.

  3. Click New registrations.

  4. Enter an application name and select Any Azure AD Directory - Multi Tenant.

  5. After you create the application, copy the application (client) Id value that is displayed in the Overview section. Use this value as the OAuth client Id.

  6. Navigate to the Certificates & Secrets section and select New Client Secret for the application.

  7. Specify the duration and save the client secret. After you save it, the key value is displayed.

  8. Copy this value because it is displayed only once. You will use this value as the OAuth client secret.

  9. On the Authentication tab, make sure to select Access tokens (used for implicit flows).

Azure Service Principal Certificate

To connect with an Azure service principal and client certificate, set the following properties:

  • Auth Scheme: Select AzureServicePrincipalCert.

  • Azure Tenant: Enter the Microsoft Online tenant to which you want to connect.

  • OAuth Client Id: Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth JWT Cert: Enter your Java web tokens (JWT) certificate store.

  • OAuth JWT Cert Type: Enter the type of key store that contains your JWT Certificate. The default type is PEMKEY_BLOB.

  • (Optional) OAuth JWT Cert Password: Enter the password for your OAuth JWT certificate.

  • (Optional) OAuth JWT Cert Subject: Enter the subject of your OAuth JWT certificate.

To obtain the OAuth certificate for your application:

  1. Log in to the Azure portal.

  2. In the left navigation pane, select All services. Then, search for and select App registrations.

  3. Click New registrations.

  4. Enter an application name and select Any Azure AD Directory - Multi Tenant.

  5. After you create the application, copy the application (client) Id value that is displayed in the Overview section. Use this value as the OAuth client Id.

  6. Navigate to the Certificates & Secrets section and select Upload certificate. Then, select the certificate to upload from your local machine.

  7. Specify the duration and save the client secret. After you save it, the key value is displayed.

  8. Copy this value because it is displayed only once. You will use this value as the OAuth client secret.

  9. On the Authentication tab, make sure to select Access tokens (used for implicit flows).

Complete Your Connection

To complete your connection:

  1. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

  2. If you authenticate with oauth, click Connect to Microsoft Exchange to connect to your Microsoft Exchange account.

  3. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Microsoft Exchange, see Microsoft Exchange Connector for CData Sync.