Microsoft Azure Service Bus connection

Introduction

A Microsoft Azure Service Bus connection, created using the Microsoft Azure Service Bus connector, establishes access to Microsoft Azure Service Bus. Once a connection is configured, you can create instances of Microsoft Azure Service Bus activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a Microsoft Azure Service Bus connection

A new Microsoft Azure Service Bus connection is created using the Microsoft Azure Service Bus connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing Microsoft Azure Service Bus connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a Microsoft Azure Service Bus connection

Each user interface element of the Microsoft Azure Service Bus connection configuration screen is described below.

The interface used during connection configuration depends on the Authentication Type selected:

• Azure Active Directory: Authorize requests to Service Bus entities using an Azure Active Directory application. For more information on this option, see Microsoft's documentation Authenticate from an application.

  Note

  The Azure Active Directory application must be assigned certain roles to grant access to a Service Bus namespace. For information on Azure's built-in roles for authorizing access to a Service Bus namespace, see Azure built-in roles for Azure Service Bus in Microsoft's documentation Authenticate from an application.

• Shared access signatures: Authorize requests to Service Bus entities using a primary key assigned to an authorization policy rule.

Azure Active Directory

If Azure Active Directory is selected for Authentication Type, this interface is presented:

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Microsoft Azure Service Bus connection and must not contain forward slashes / or colons :. This name is also used to identify the Microsoft Azure Service Bus endpoint, which refers to both a specific connection and its activities.

• Authentication Type: Use the menu to select Azure Active Directory to authorize requests to Service Bus entities using Azure Active Directory application. For more information on this option, see Microsoft's documentation Authenticate from an application.

  Note

  The Azure Active Directory application must be assigned certain roles to grant access to a Service Bus namespace. For information on Azure's built-in roles for authorizing access to a Service Bus namespace, see Azure built-in roles for Azure Service Bus in Microsoft's documentation Authenticate from an application.

• Namespace / Hostname: Enter the Service Bus namespace or namespace address using the namespace name as a hostname. For example, both spsbusns1028 and spsbusns1028.servicebus.windows.net are valid and point to the same Service Bus namespace.

• Tenant ID: Enter the Directory (tenant) ID for the app registration.

• Client ID: Enter the Application (client) ID for the app registration.

• Client Secret: Enter the client secret for the app registration.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Shared access signatures

If Shared Access Signatures is selected for Authentication Type, this interface is presented:

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Microsoft Azure Service Bus connection and must not contain forward slashes / or colons :. This name is also used to identify the Microsoft Azure Service Bus endpoint, which refers to both a specific connection and its activities.

• Authentication Type: Use the menu to select Shared Access Signatures to authorize requests to Service Bus entities using a primary key assigned to an authorization policy rule.

• Namespace / Hostname: Enter the Service Bus namespace or namespace address using the namespace name as a hostname. For example, both spsbusns1028 and spsbusns1028.servicebus.windows.net are valid and point to the same Service Bus namespace.

• Policy Name: Enter the namespace authorization policy rule name for the connection. By default, Service Bus namespaces have a RootManageSharedAccessKey administrator policy. It is recommended that you create another policy for integration use.

  Important

  • To use the Send Message activity, the authorization policy rule must include send rights.
  • To use the Consume Queue and Consume Topic activities, the authorization policy rule must include listen rights.

• Primary Key: Enter the primary key that corresponds with the Policy Name. Every authorization policy rule is assigned its own primary key.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Microsoft Azure Service Bus connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

• 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: 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: 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.