service-bus-connections

page_type	languages	products
sample	azurepowershell	azure logic-apps azure-resource-manager azure-service-bus

Connect to Azure Service Bus queues from Azure Logic Apps and deploy with Azure DevOps Pipelines

This sample shows how to create a logic app that handles messages in an Azure Service Bus queue and deploy the app by using Azure DevOps Pipelines. The logic app creates Azure Service Bus API connections: one connection reads messages from the queue while the other connection sends messages to the queue. To learn more about the template and definition files in this sample and how they work, review Samples file structure and definitions.

How this sample works

This sample uses the outputs from creating Azure Service Bus connections and defines these output variables in the connectors-template.json file:

"outputs": {
   "serviceBusManagedApiId": {
      "type": "string",
      "value": "[variables('serviceBusConnectionId')]"
   },
   "serviceBusConnId1": {
      "type": "string",
      "value": "[resourceId('Microsoft.Web/connections', concat(variables('serviceBusConnectionName'), '-1'))]"
   },
   "serviceBusConnId2": {
      "type": "string",
      "value": "[resourceId('Microsoft.Web/connections', concat(variables('serviceBusConnectionName'), '-2'))]"
   },
   "logicAppName": {
      "type": "string",
      "value": "[variables('logicAppName')]"
   }
}

The logic-app-definition-parameters.json file replaces the serviceBusConnId1, serviceBusConnId2, and serviceBusManagedApiId values and updates the logic app's definition with the resulting values:

{
   "$connections": {
      "value": {
         "servicebus-1": {
            "connectionId": "{serviceBusConnId1}",
            "connectionName": "servicebus-1",
            "id": "{serviceBusManagedApiId}"
         },
         "servicebus-2": {
            "connectionId": "{serviceBusConnId2}",
            "connectionName": "servicebus-2",
            "id": "{serviceBusManagedApiId}"
         }
      }
   }
}

Prerequisites

• Install Azure PowerShell 2.4.0 on your platform.

Set up sample

To set up, deploy, and run this sample, you can use the command line or set up an Azure DevOps pipeline.

Command line

To run this sample from the command line, follow these steps.

1. Clone or download this sample repository.

2. Sign in to Azure by running this command from any command line tool that you want.

   Connect-AzAccount

3. To target your deployment, select the appropriate Azure context to use.

4. To push a full deployment for this sample to Azure, run this command from the PowerShell directory that contains this sample:

   ./full-deploy.ps1 -groupId <groupId> -environment <environment> -location <regionName>

Azure DevOps

This sample uses multi-stage YAML pipelines. To set up the sample pipeline, follow these steps:

1. Make sure that the multi-stage pipeline preview feature is enabled.

2. Clone or fork the samples repository into your own repository.

3. Choose one of these steps:

   • Create an Azure Resource Manager service connection that has the name "Azure Samples Subscription" in your project that points to the Azure subscription that you want to use for deployment.

   • Edit all instances of azureSubscription: 'Azure Samples Subscription' in the ./powershell/azure-pipelines.yml file by using the name for an existing Azure Resource Manager service connection in your project.

   [!NOTE] To use the Azure Resource Manager service connection, make sure that the connection has selected the Allow all pipelines to use this connection checkbox. Otherwise, you must authorize the pipeline that you create in the next step.

4. Update these ./pipeline/azure-pipelines.yml variables:

   • groupId: A value that's unique to you or your organization and is used to start the names for all resources and resource groups that are created

   • location: The name for the Azure region where you want to deploy the resources

   • abbrevLocationName: The abbreviated region name that's used in resource names

5. Create a new pipeline in your project that uses the ./powershell/azure-pipelines.yml file from this sample.

   

Supporting documentation

To learn more about the different parts in these samples, review these topics:

• Concepts introduces the main concepts that underlie these samples.

• Naming convention describes the naming convention to use when creating the resources in these samples.

• Samples file structure and definitions explains the purpose for each file in these samples.

• Scaling expands on the reasons why these samples provide the capability to scale by increasing the number of copies for the logic apps deployed and organizing resources into separate resource groups.

Resources

This sample creates these resources:

To learn about the scripts in this sample and how they work, review Samples file structure and definitions.

This sample also implements these template and definition files:

File name	Description
shared-template.json	This template creates a single service bus resource that sets up the queue_1 and queue_2 queues.
connectors-template.json	This template creates two Service Bus API connections. Both connections are set up with the connection strings for the service bus that's created by the shared_template.json file.
logic-app-template.json	This template creates a shell for a logic app definition, which is blank to support separating the template from the definition.
logic-app-definition.json	This file defines a basic logic app that gets a message from queue_1 by using one API connection and sends the message to queue_2 by using the other API connection.
logic-app-definition-parameters.json	This file contains the setup information for the Azure Service Bus connectors.

Clean up

When you're done with the sample, delete the resource groups that were created by the sample. To remove all the resource groups with names that start with a specific groupId value, run this command from the PowerShell directory that contains this sample:

./clean-up.ps1 -groupId <groupId>