---
schema_version: "1"
id: 387cc6eda0588b3549371edbb6ae1099c363f2d261cca5f33aad2ab6a8d3ed70
title: Using Anypoint Studio to Configure Azure Event Hubs Connector 1.2
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/azure-event-hubs-connector/latest/azure-event-hubs-connector-studio-configuration.md
canonical_url: https://docs.mulesoft.com/azure-event-hubs-connector/latest/azure-event-hubs-connector-studio-configuration
source_site: docs.mulesoft.com
content_type: documentation
content_hash: b253a03d6785f6aef7dc1ff0132a9238aff5fcf22127ab7068b8647c70b474d4
description: MuleSoft Documentation Site
release: "1.2"
latest: true
---
---
product: Azure Event Hubs Connector
version: 1.2
is-latest-version: true
---

# Using Anypoint Studio to Configure Azure Event Hubs Connector 1.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-input-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Use Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If,
after reading this topic, you need additional information about the connector fields, refer to the
[Azure Event Hub Connector Reference](https://docs.mulesoft.com/azure-event-hubs-connector/latest/azure-event-hubs-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Anypoint Connector for Azure Event Hubs Messaging (Azure Event Hubs Messaging Connector) to your
Mule project to automatically populate the XML code with the connector’s namespace and schema
location and add the required dependencies to the project’s `pom.xml` file:

1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

2.  In the **Add Dependencies to Project** window, type `azure event hubs messaging` in the search
    field.

3.  Click **Azure Event Hubs Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Azure Event Hubs Connector:

- HTTP Listener  
  Initiates a flow each time it receives a request on the configured host and port

- Scheduler  
  Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener source, follow these steps:

1.  In the **Mule Palette** view, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the HTTP Listener source in the app.

6.  On the **General** tab, specify the connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Azure Event Hubs Messaging Connector, follow these steps:

1.  In the **Mule Palette** view, select **Azure Event Hubs** and then select the desired operation.

2.  Drag the operation onto the Studio canvas to the right of the source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication that the
connector requires to access the target Azure Event Hubs system. Azure Event Hubs Connector supports
SAS authentication and Active Directory authentication.

To configure the global element for Azure Event Hubs Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the configuration screen for the operation, click the plus sign (**+**) next to the
    **Connector configuration** field to access the global element configuration fields.

3.  On the **General** tab, in **Connection**, select the authentication method to configure:

    - [SAS authentication](#config-sas)

    - [Active Directory authentication](#config-active)

4.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

5.  Click **Test Connection** to confirm that Mul runtime can connect with the specified server.

6.  Click **OK**.

### Configure SAS Authentication

Enter the following information on the **General** tab of the **Global Element Properties** screen
to configure SAS authentication:

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Namespace</p></td><td><div><div><p>String</p></div></div></td><td><p>Azure Event Hubs namespace name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Access Key Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Shared access key provided by Azure.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Shared Access Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Shared access key value provided by Azure.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Event Hub Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Azure Event Hub name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Share Connection</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Toggles the builder to use the same connection for producers or consumers.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Checkpoint Store Type</p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AzureBlobStorageSasAuthentication">Configure Azure Blob Storage SAS Authentication</a></p></li><li><p><a href="#AzureBlobStorageActiveDirectoryAuthentication">Configure Azure Blob Storage Active Directory Authentication</a></p></li></ul></div></div></td><td><p>Selects the Azure Blob Storage connection.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p>Reconnection</p></div></div></td><td><p>Configures a reconnection strategy to use when the connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

### Configure Active Directory Authentication

Enter the following information on the **General** tab of the **Global Element Properties** screen
to configure Active Directory authentication.

Using this authentication type enables you to configure **Token Credential Properties** or **Use
default credentials**.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Token Credential Properties</p></td><td><div><div><p><a href="#TokenCredentialProperties">Configure Token Credential Properties</a></p></div></div></td><td><p>Acquires a token via service principal authentication.</p></td><td></td><td></td></tr><tr><td><p>Use Azure Default Credential</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Use the DefaultAzureCredentials mechanism.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Namespace</p></td><td><div><div><p>String</p></div></div></td><td><p>Azure Event Hubs namespace name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authority Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the Azure Active Directory host. Defaults to <a href="https://login.microsoftonline.com/">https://login.microsoftonline.com/</a></p></td><td></td><td></td></tr><tr><td><p>Event Hub Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Event Hub name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Share Connection</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Toggles the builder to use the same connection for producers or consumers.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Checkpoint Store Type</p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AzureBlobStorageSasAuthentication">Configure Azure Blob Storage SAS Authentication</a></p></li><li><p><a href="#AzureBlobStorageActiveDirectoryAuthentication">Configure Azure Blob Storage Active Directory Authentication</a></p></li></ul></div></div></td><td><p>Select the checkpointing connection provider.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p>Reconnection</p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

### Configure Azure Blob Storage SAS Authentication

The following table shows the fields for configuring **Azure blob storage sas authentication**.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Container Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Container name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Account Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account name of the Azure account.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Account Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account key of the Azure account.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Configure Azure Blob Storage Active Directory Authentication

The following table shows the fields to configure **Azure blob storage active directory
authentication**.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Token Credential Properties</strong></p></td><td><div><div><p><a href="#TokenCredentialProperties">Configure Token Credential Properties</a></p></div></div></td><td><div><div><p>Acquires a token via service principal authentication.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Use Azure Default Credential</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If you set this flag to <code>true</code>, DefaultAzureCredential Class(Azure.Identity) is created to get a token to authenticate.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Container Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Container name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Account Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account name of the Azure account.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Authority Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the Azure active directory host. Defaults to <a href="https://login.microsoftonline.com/">https://login.microsoftonline.com/</a></p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Configure Token Credential Properties

The following table shows the fields for configuring **Token credentials properties**.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Tenant Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Tenant ID.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Client ID.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Client secret.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Configuration Examples

The following example shows the configuration for **Sas Authentication** with **Azure blob storage
sas authentication** in Studio:

![Configuration of azure blob storage SAS authentication](/mulesoft/current/en-us/azure-event-hubs-connector/latest/_images/aeh-sas.png)

In the **Configuration XML** editor, the `azure-eventhubs:sas-authentication-connection` and
`azure-eventhubs:azure-blob-storage-sas-authentication` configurations look like this:

```xml
	<azure-eventhubs:azure-eventhubs-config name="sas" doc:name="Azure Event Hubs Connector Azure Event Hubs" >
		<azure-eventhubs:sas-authentication-connection namespace="${config.namespace}" sharedAccessKeyName="${sas-config.sharedAccessKeyName}" sharedAccessKey="${sas-config.sharedAccessKey}" eventHubName="${config.eventHuName}" >
			<azure-eventhubs:checkpoint-store-type >
				<azure-eventhubs:azure-blob-storage-sas-authentication containerName="${bs-config.containerName}" accountName="${bs-config.accountName}" accountKey="${bs-config.accountKey}" />
			</azure-eventhubs:checkpoint-store-type>
		</azure-eventhubs:sas-authentication-connection>
	</azure-eventhubs:azure-eventhubs-config>
```

The following example shows the configuration for **Active directory authentication** with **Azure
blob storage sas authentication** and **Token credentials properties** in Studio:

![Configuration of active directory authentication with client credentials](/mulesoft/current/en-us/azure-event-hubs-connector/latest/_images/aeh-active-directory-client.png)

In the **Configuration XML** editor, the
`azure-eventhubs:active-directory-authentication-connection`,
`azure-eventhubs:azure-blob-storage-sas-authentication`, and
`azure-eventhubs:token-credential-properties` configurations look like this:

```xml
<azure-eventhubs:azure-eventhubs-config name="ActiveDirectory" doc:name="Azure Event Hubs Connector Azure Event Hubs" >
		<azure-eventhubs:active-directory-authentication-connection namespace="${config.namespace}" eventHubName="${config.eventHubName}" >
			<azure-eventhubs:token-credential-properties tenantId="${ad-config.tenantId}" clientId="${ad-config.clientId}" clientSecret="${ad-config.clientSecret}" />
			<azure-eventhubs:checkpoint-store-type >
				<azure-eventhubs:azure-blob-storage-sas-authentication containerName="${bs.config.containerName}" accountName="${bs.config.accountName}" accountKey="${bs.config.containerName}" />
			</azure-eventhubs:checkpoint-store-type>
		</azure-eventhubs:active-directory-authentication-connection>
	</azure-eventhubs:azure-eventhubs-config>
```

The following example shows the configuration for **Active directory authentication** with **Azure
blob storage active directory authentication** and **Use azure default credentials** in Studio:

![Configuration of active directory authentication with default client credentials](/mulesoft/current/en-us/azure-event-hubs-connector/latest/_images/aeh-active-directory-default-client.png)

In the **Configuration XML** editor, the
`azure-eventhubs:active-directory-authentication-connection`,
`azure-eventhubs:azure-blob-storage-sas-authentication` , and `useAzureDefaultCredential`
configurations look like this:

```xml
<azure-eventhubs:azure-eventhubs-config name="ActiveDirectory" doc:name="Azure Event Hubs Connector Azure Event Hubs"  >
		<azure-eventhubs:active-directory-authentication-connection namespace="${config.namespace}" eventHubName="${config.eventHubName}" useAzureDefaultCredential="true">
			<azure-eventhubs:checkpoint-store-type >
				<azure-eventhubs:azure-blob-storage-active-directory-authentication containerName="${bs-config.containerName}" accountName="${bs-config.accountName}" >
					<azure-eventhubs:token-credential-properties tenantId="${ad-config.tenantId}" clientId="${ad-config.clientId}" clientSecret="${ad-config.clientSecret}" />
				</azure-eventhubs:azure-blob-storage-active-directory-authentication>
			</azure-eventhubs:checkpoint-store-type>
		</azure-eventhubs:active-directory-authentication-connection>
	</azure-eventhubs:azure-eventhubs-config>
```

## Configure Additional Connector Fields

After you configure a global element for Azure Event Hubs Connector, configure the other required
fields for the connector. The required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  OS console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Use Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Azure Event Hubs Messaging Reference](https://docs.mulesoft.com/azure-event-hubs-connector/latest/azure-event-hubs-connector-reference)

- [Salesforce Help](https://help.salesforce.com)