Microsoft Azure ESB Connector¶

Summary¶

The Harmony Microsoft Azure ESB Connector establishes access to Microsoft Azure Service Bus.

The Microsoft Azure ESB connector provides an interface for creating a Microsoft Azure ESB connection, the foundation used for generating instances of Microsoft Azure ESB activities. These activities, once configured, interact with Microsoft Azure Service Bus through the connection.

The Microsoft Azure ESB connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview¶

This connector is used to first configure a Microsoft Azure ESB connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Microsoft Azure ESB connection and its activities are referred to as a Microsoft Azure ESB endpoint:

• Get Queue Message: Retrieves all messages in a Microsoft Azure Service Bus queue and is intended to be used as a source in an operation.

• Unlock Topic Message: Unlocks messages in a Microsoft Azure Service Bus topic and is intended to be used as a target in an operation.

• Delete Queue Message: Deletes messages from a Microsoft Azure Service Bus queue and is intended to be used as a target in an operation.

• Consume Topic (Beta): Consumes messages from a Microsoft Azure Service Bus topic and is intended to be used as a source in an operation.

• Renew Topic Message Lock: Renews message locks in a Microsoft Azure Service Bus topic and is intended to be used as a target in an operation.

• Delete Topic Message: Deletes messages from a Microsoft Azure Service Bus topic and is intended to be used as a target in an operation.

• Send Message: Sends messages to a Microsoft Azure Service Bus queue or topic and is intended to be used as a target in an operation.

• Consume Queue (Beta): Consumes messages from a Microsoft Azure Service Bus queue and is intended to be used as a source in an operation.

• Renew Queue Message Lock: Renews message locks in a Microsoft Azure Service Bus queue and is intended to be used as a target in an operation.

• Get Topic Message: Retrieves messages from a Microsoft Azure Service Bus topic and is intended to be used as a source in an operation.

• Unlock Queue Message: Unlocks messages from a Microsoft Azure Service Bus queue and is intended to be used as a target in an operation.

Prerequisites and Supported API Versions¶

The Microsoft Azure ESB connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Microsoft Azure ESB connector uses the Microsoft Azure Service Bus Client for Java v3.6.7. Refer to the API documentation for information on the schema nodes and fields.

Prior to using the Consume Queue (Beta) and Consume Topic (Beta) activities, certain prerequisites must be met.

Troubleshooting¶

If you experience issues with the Microsoft Azure ESB connector, these troubleshooting steps are recommended:

1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

2. Check the operation logs for any information written during execution of the operation.

3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

4. If using Private Agents, you can check the agent logs for more information.