Microsoft Exchange connector

The Microsoft Exchange connector lets you perform insert, delete, update, and read operations on tables in both Exchange Web Services (EWS) and Microsoft Graph schema.

Supported versions

This connector supports Exchange Online.

Before you begin

Before using the Microsoft Exchange connector, do the following tasks:

• In your Google Cloud project:
  • Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
  • Grant the roles/connectors.admin IAM role to the user configuring the connector.
  • Grant the following IAM roles to the service account that you want to use for the connector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.

  • Enable the following services:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    To understand how to enable services, see Enabling services.

  If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following:

1. In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.

   Go to the Connections page

2. Click + CREATE NEW to open the Create Connection page.
3. In the Location section, choose the location for the connection.
   1. Region: Select a location from the drop-down list.

      For the list of all the supported regions, see Locations.

   2. Click NEXT.
4. In the Connection Details section, complete the following:
   1. Connector: Select Microsoft Exchange from the drop down list of available Connectors.
   2. Connector version: Select the Connector version from the drop down list of available versions.
   3. In the Connection Name field, enter a name for the Connection instance.

      Connection names must meet the following criteria:

      • Connection names can use letters, numbers, or hyphens.
      • Letters must be lower-case.
      • Connection names must begin with a letter and end with a letter or number.
      • Connection names cannot exceed 49 characters.
   4. Optionally, enter a Description for the connection instance.
   5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
   6. Service Account: Select a service account that has the required roles.
   7. Optionally, configure the Connection node settings:
      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

   Note: You can customize the connection node values only if you are a Pay-as-you-go customer.
   8. Azure Tenant: The Microsoft Online tenant from which the data is accessed. If you don't specify a tenant, your default tentant is used.
   9. Schema: Select EWS or MSGraph schema. The default schema is EWS.
   10. Optionally, you can disable server side filtering by selecting Disable Server Side Filtering.
   11. Click NEXT.
5. In the Destinations section, select the Destination type as Host address and specify the address of the Exchange server to which the connector connects, such as https://outlook.office365.com/EWS/Exchange.asmx.
6. Click NEXT.
7. In the Authentication section, enter the authentication details. To understand how to configure these authentication types, see Configure authentication.

8. Click Next.
9. Review: Review your connection and authentication details.
10. Click Create.

Configure authentication

Enter the details based on the Username and Password authentication

• Username: Username for connector.
• Password: Secret Manager Secret containing the password associated with the connector.

Enter the details based on the OAuth 2.0 - Authorization code authentication

• Client ID: The client ID used for requesting access tokens.
• Scope: A comma-separated list of desired scopes.
• Client secret: The client secret used for requesting access tokens.
• Authorization URL: Authorization URL generated when creating client.

Additional steps after connection creation

If you selected OAuth 2.0 - Authorization code for authentication, you must do the following additional steps after creating the connection:

1. In the Connections page, locate the newly created connection.

   Notice that the Status for the new connector will be Authorization required.

2. Click Authorization required.

   This shows the Edit authorization pane.

3. Copy the Redirect URI value to your external application.
4. Verify the authorization details.
5. Click Authorize.

   If the authorization is successful, the connection status will be set to Active in the Connections page.

Re-authorization for authorization code

If you are using Authorization code authentication type and have made any configuration changes in your Azure Synapse application, you must re-authorize your Azure Synapse connection. To re-authorize a connection, perform the following steps:

1. Click on the required connection in the Connections page.

   This opens the connection details page.

2. Click Edit to edit the connection details.
3. Verify the OAuth 2.0 - Authorization code details in the Authentication section.

   If required, make the necessary changes.

4. Click Save. This takes you to the connection details page.
5. Click Edit authorization in the Authentication section. This shows the Authorize pane.
6. Click Authorize.

   If the authorization is successful, the connection status will be set to Active in the Connections page.

System limitations

The Microsoft Exchange connector can process 4 transactions per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Note: The number of Integration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:

• If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
• If you are a subscription based customer, contact support.

The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

Use the Microsoft Exchange connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

• To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
• To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Actions

The Microsoft Exchange connector provides actions such as MoveItem and SendItem. To understand how to configure the actions, see Action examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - MoveItem

1. In the Configure connector task dialog, click Actions.
2. Select the MoveItem action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

    {
     "ItemId":"The unique ItemId of the item to be sent"
     "ItemChangekey":"The unique ItemChangeKey of the item to be sent"
     "FolderDisplayName":"The display name of the new folder"
     }

Entity operation examples

Example - List all SentItems

This example lists all the records in the SentItems entity.

1. In the Configure connector task dialog, click Entities.
2. Select SentItems from the Entity list.
3. Select the LIST operation, and then click Done.

Example - Get a specific record from the Sentitems entity

This example gets a record that has the Id "568ea947-e03d-ef11-8409-7c1e5217e912" from the SentItems entity.

1. In the Configure connector task dialog, click Entities.
2. Select SentItems from the Entity list.
3. Select the GET operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 568ea947-e03d-ef11-8409-7c1e5217e912 in the Default Value field.

   Here, Id is the primary key value of the SentItems entity.

5. Click Done.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next

• Understand how to suspend and resume a connection.
• Understand how to monitor connector usage.
• Understand how to view connector logs.