Azure Logic Apps Standard Tasks

This extension provides automated build, connections deployment, and release tasks for Azure Logic Apps Standard.

AzureLogicAppsStandardBuild: Consolidates copy and zip operations for the LogicApp source folder.
AzureLogicAppsStandardBusinessProcessArtifactsBuild: Generates business process artifacts in the LogicApp source folder.
AzureLogicAppsStandardConnectionsDeployment: Consolidates connection deployment.
AzureLogicAppsStandardRelease: Consolidates Azure Functions web app deploy and app settings configuration.

For more information, see Azure Integration Services Blog (manual process): Deploying Logic App Standard resource through DevOps pipeline.

Prerequisites

YAML Pipelines: These tasks are supported only with yaml pipelines.
VM image: These tasks require the VM image named ubuntu-latest.

1. Azure Logic Apps Standard Build Task

1.1. Arguments

The following table describes the arguments that you can provide to the Azure Logic Apps Build Azure DevOps Task. Although both deploymentFolder and deploymentWorkflowParametersFile are marked as optional, one of the two must be present when using this task.

Argument name	Required	Description
sourceFolder	Yes	The folder that contains the Standard logic app.
deploymentFolder	No	The folder that contains the workflowparameters folder which has the parameters.json file.
deploymentWorkflowParametersFile	No	The path to the parameters.json file.
archiveFile	Yes	The name for the zip archive.

1.2. Usage

The following shows how to use this task in different scenarios.

1.2.1. Azure Logic Apps Standard Build passing in the deployment folder path

steps:
  - task: AzureLogicAppsStandardBuild@0
    displayName: 'Azure Logic Apps Standard Build'
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)/$(logicAppName)'
      deploymentFolder: '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)'
      archiveFile: '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'

This task copies the logic app found at '$(Build.SourcesDirectory)/$(logicAppName)', replaces the parameters.json file with the one found in the workflowparameters folder in '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)', and creates an archive at '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'.

1.2.2. Azure Logic Apps Standard Build passing in parameters.json file

steps:
  - task: AzureLogicAppsStandardBuild@0
    displayName: 'Azure Logic Apps Standard Build'
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)/$(logicAppName)'
      deploymentWorkflowParametersFile: '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)/workflowparameters/parameters.json'
      archiveFile: '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'

This task copies the logic app found at '$(Build.SourcesDirectory)/$(logicAppName)', replaces the parameters.json file with the one provided at '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)/workflowparameters/parameters.json', and creates an archive at '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'.

1.2.3. Azure Logic Apps Standard Build passing both deployment folder path and path to parameters.json file

steps:
  - task: AzureLogicAppsStandardBuild@0
    displayName: 'Azure Logic Apps Standard Build'
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)/$(logicAppName)'
      deploymentFolder: '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)'
      deploymentWorkflowParametersFile: '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)/otherfolder/parameters.json'
      archiveFile: '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'

When both deploymentFolder and deploymentWorkflowParametersFile is provided, the task will only use the path to the parameters.json file that is passed in. In this case, the task copies the logic app found at '$(Build.SourcesDirectory)/$(logicAppName)', replaces the parameters.json file with the one provided at '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)/otherfolder/parameters.json', and creates an archive at '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'.

2. Azure Logic Apps Standard Business Process Artifacts Build Task

2.1. Prerequisites

Before you run this task, you need to already have the previously described Azure resources. You also need an Azure Resource Manager service connection.

2.1.1. Azure Resource Manager service connection

To deploy to Azure, you need an Azure subscription to use with Azure DevOps Services or Azure DevOps Server for billing and also Project Collection Administrator permissions.

To create the Azure Resource Manager service endpoint, follow the steps in Connect to Microsoft Azure with an Azure Resource Manager service connection.

Important: Make sure that you choose the Azure Resource Manager endpoint type. For more information, see Manage service connections.

2.1.2. Azure CLI

To execute various commands throughout the task's execution, this task requires that you install the Azure CLI on the Azure Pipelines agent. For more information, see Install the Azure CLI.

Important: If an agent is already running on the computer where Azure CLI is installed, make sure that you restart the agent to update all the relevant environment variables.

2.2. Arguments

The following table describes the arguments that you need to provide to the Azure Logic Apps Standard Business Process Artifacts Build Azure DevOps Task.

[!NOTE]

To generate the required artifacts for the build and archive process,

The AzureLogicAppsStandardBusinessProcessArtifactsBuild task must run before the AzureLogicAppsStandardBuild task runs.

Make sure to provide the same value for the targetFolder in the AzureLogicAppsStandardBusinessProcessArtifactsBuild task and the sourceFolder in the AzureLogicAppsStandardBuild task.

Make sure to provide the same values for deploymentFolder and deploymentWorkflowParametersFile in the AzureLogicAppsStandardBuild task as their values in the AzureLogicAppsStandardBusinessProcessArtifactsBuild task.

Although both deploymentFolder and deploymentWorkflowParametersFile are marked as optional, one of the two must exist when you use this task. If you provide both, the parameters.json file at deploymentWorkflowParametersFile is validated and used.

Argument name	Required	Description
connectedServiceName	Yes	The service connection linked to the Azure subscription associated with the logic app to update. This service connection requires subscription permissions to make these changes, for example, the Contributor role.
subscriptionId	Yes	The Azure subscription where the task creates the resources.
appName	Yes	The name for the existing Standard logic app.
targetFolder	Yes	The folder that contains the Standard logic app and is the same folder as the sourceFolder for the AzureLogicAppsStandardBuild task.
deploymentFolder	No	The folder that contains the workflowparameters folder which has the parameters.json file.
deploymentWorkflowParametersFile	No	The path to the parameters.json file.
stagingAppSettingsFilePath	Yes	The path to the app settings file that is generated by the task. This file includes app settings for the business processes mapped to the specified logic app. In the AzureLogicAppsStandardRelease task, use this app settings file for the appSettings parameter value. To include the file with the published pipeline artifact, make sure that you store the file in artifacts staging directory.

2.3 Usage: CI pipeline

The following syntax shows how to use the AzureLogicAppsStandardBusinessProcessArtifactsBuild task with the AzureLogicAppsStandardBuild and AzureLogicAppsStandardRelease tasks:

The AzureLogicAppsStandardBusinessProcessArtifactsBuild task creates tracking profiles in the '$(Build.SourcesDirectory)/$(logicAppName)/Artifacts/TrackingProfiles' directory with parameterized business process versions.
The task adds the required business process artifacts to the logic app source directory before the AzureLogicAppsStandardBuild task processes the directory to generate the .zip file.
The task generates the app settings for the business process in the provided file: '$(Build.ArtifactStagingDirectory)/appsettings_businessprocess_$(Build.BuildId).json'.

2.3.1. Passing in parameters.json file

steps:
  - task: AzureLogicAppsStandardBusinessProcessArtifactsBuild@0
    displayName: 'Build Business Process Artifacts'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      appName: '$(logicAppName)'
      subscriptionId: '$(subscriptionId)'
      stagingAppSettingsFilePath: '$(Build.ArtifactStagingDirectory)/appsettings_businessprocess_$(Build.BuildId).json'
      deploymentWorkflowParametersFile: '$(Build.SourcesDirectory)/$(logicAppName)/parameters.json'
      targetFolder: '$(Build.SourcesDirectory)/$(logicAppName)'

  - task: AzureLogicAppsStandardBuild@0
    displayName: 'Azure Logic Apps Standard Build'
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)/$(logicAppName)'
      deploymentWorkflowParametersFile: '$(Build.SourcesDirectory)/$(logicAppName)/parameters.json'
      archiveFile: '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'

The AzureLogicAppsStandardBusinessProcessArtifactsBuild task updates the provided parameters.json file with the corresponding parameter keys and values. This file comes from the path provided in the deploymentWorkflowParametersFile argument.
The AzureLogicAppsStandardBuild task copies the logic app found at '$(Build.SourcesDirectory)/$(logicAppName)', replaces the parameters.json file with the one provided in the deploymentWorkflowParametersFile argument, and creates an archive at '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'.

2.3.2. Passing in deployment folder

steps:
  - task: AzureLogicAppsStandardBusinessProcessArtifactsBuild@0
    displayName: 'Build Business Process Artifacts'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      appName: '$(logicAppName)'
      subscriptionId: '$(subscriptionId)'
      stagingAppSettingsFilePath: '$(Build.ArtifactStagingDirectory)/appsettings_businessprocess_$(Build.BuildId).json'
      deploymentFolder: '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)'
      targetFolder: '$(Build.SourcesDirectory)/$(logicAppName)'

  - task: AzureLogicAppsStandardBuild@0
    displayName: 'Azure Logic Apps Standard Build'
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)/$(logicAppName)'
      deploymentFolder: '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)'
      archiveFile: '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'

The AzureLogicAppsStandardBusinessProcessArtifactsBuild task updates the parameters.json file under the provided deployment folder with the corresponding parameter keys and values. This file comes from the path '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)/workflowparameters/parameters.json'.
The AzureLogicAppsStandardBuild task copies the logic app found at '$(Build.SourcesDirectory)/$(logicAppName)', replaces the parameters.json file with the one at '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)/workflowparameters/parameters.json', and creates an archive at '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'.

2.3.4. Passing in parameters.json file and deployment folder

steps:
  - task: AzureLogicAppsStandardBusinessProcessArtifactsBuild@0
    displayName: 'Build Business Process Artifacts'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      appName: '$(logicAppName)'
      subscriptionId: '$(subscriptionId)'
      stagingAppSettingsFilePath: '$(Build.ArtifactStagingDirectory)/appsettings_businessprocess_$(Build.BuildId).json'
      deploymentFolder: '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)'
      deploymentWorkflowParametersFile: '$(Build.SourcesDirectory)/$(logicAppName)/parameters.json'
      targetFolder: '$(Build.SourcesDirectory)/$(logicAppName)'

  - task: AzureLogicAppsStandardBuild@0
    displayName: 'Azure Logic Apps Standard Build'
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)/$(logicAppName)'
      deploymentFolder: '$(System.DefaultWorkingDirectory)/deployment/$(logicAppName)'
      deploymentWorkflowParametersFile: '$(Build.SourcesDirectory)/$(logicAppName)/parameters.json'
      archiveFile: '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'

The AzureLogicAppsStandardBusinessProcessArtifactsBuild task updates the provided parameters.json file with the corresponding parameter keys and values. This file comes from the path provided in the deploymentWorkflowParametersFile argument.
The AzureLogicAppsStandardBuild task copies the logic app found at '$(Build.SourcesDirectory)/$(logicAppName)', replaces the parameters.json file with the one provided in the deploymentWorkflowParametersFile argument, and creates an archive at '$(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip'.

2.4. Usage: CD pipeline

steps:
  - task: AzureLogicAppsStandardRelease@0
    displayName: 'Azure Logic Apps Standard Release'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      appName: '$(logicAppName)'
      resourceGroupName: '$(resourceGroupName)'
      appSettings: '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/appsettings_businessprocess_$(Build.BuildId).json'
      package: '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/$(resources.pipeline.cipipeline.runID).zip'

Passes '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/appsettings_businessprocess_$(Build.BuildId).json' file to the appSettings argument in the AzureLogicAppsStandardRelease task.

3. Azure Logic Apps Standard Connections Deployment Task

3.1. Prerequisites

Before you run this task, you'll need an Azure DevOps service connection.

3.1.1. Azure DevOps Service Connection

To deploy to Azure, you'll need an Azure subscription that's linked to Azure DevOps or Azure DevOps Server for billing, which requires Project Collection Administrator permissions.

Create the Azure Resource Manager service endpoint by using the Azure Resource Manager endpoint type. For more information about creating service connections, see Manage service connections.

3.1.2. Azure CLI

This task requires that you install the Azure CLI on the Azure Pipelines agent to execute various commands throughout the task's execution. For more information, see How to install the Azure CLI.

If an agent is already running on the computer where the Azure CLI is installed, make sure that you restart the agent to update all the relevant environment variables.

3.2. Arguments

The following table describes the arguments that you can provide to the Azure Logic Apps Connections Deployment Azure DevOps Task.

Argument name	Required	Description
connectedServiceNameARM	Yes	The service connection linked to the Azure subscription associated with the logic app to update. This service connection must have subscription permissions to make these changes, for example, the Contributor role.
subscriptionId	Yes	The Azure subscription where the task creates the resources.
appName	Yes	The name for the existing Standard logic app.
resourceGroupName	Yes	The Azure resource group where to create the resources.
location	Yes	The Azure region where to create the services.
armTemplatePath	Yes	The folder that contains the connection ARM templates to deploy. This task deploys only the ARM templates that are recognized to have a single connection resource and expects the connection ARM template file names to use the following format: *{connection-name}.parameters.json* and *{connection-name}.template.json*. All connections in this folder will be created.

3.3. Usage

The following example shows how to use this task.

3.3.1. Azure Logic Apps Standard Connections Deployment

steps:
  - task: AzureLogicAppsStandardConnectionsDeployment@0
    displayName: 'Deploy Azure Logic Apps Standard Connections'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      subscriptionId: '$(subscriptionId)'
      appName: '$(logicAppName)'
      resourceGroupName: '$(resourceGroupName)'
      location: '$(resourceGroupLocation)'
      armTemplatePath: '$(Pipeline.Workspace)/$(logicAppIaCArtifactName)'

The connection ARM templates found in the path '$(Pipeline.Workspace)/$(logicAppIaCArtifactName)' are created in the following location and is linked to the Standard logic app named '$(logicAppName)':

Azure subscription: $(subscriptionId)
Resource group: '$(resourceGroupName)'
Location (region): $(resourceGroupLocation)

4. Azure Logic Apps Standard Release Task

4.1. Prerequisites

Before you run this task, the Azure resources described previously must exist and an Azure DevOps service connection is required.

4.1.1. Azure DevOps Service Connection

To deploy to Azure, you'll need an Azure subscription that's linked to Azure DevOps or Azure DevOps Server for billing, which requires Project Collection Administrator permissions.

To create the Azure Resource Manager service endpoint, follow the steps in Connect to Microsoft Azure with an ARM service connection and use the Azure Resource Manager endpoint type. For more information, see Manage service connections.

4.1.2. Azure CLI

This task requires that you install the Azure CLI on the Azure Pipelines agent to execute various commands throughout the task's execution. For more information, see How to install the Azure CLI.

If an agent is already running on the computer where the Azure CLI is installed, make sure that you restart the agent to update all the relevant environment variables.

4.2. Arguments

The following table describes the arguments that you can provide to the Azure Logic Apps Release Azure DevOps Task.

[!NOTE]

Make sure to either manually add appSettings values or pass the app settings in a JSON file for this task.

Argument name	Required	Description
connectedServiceNameARM	Yes	The service connection linked to the Azure subscription associated with the logic app to update. This service connection must have subscription permissions to make these changes, for example, the Contributor role.
appName	Yes	The name for the existing Standard logic app.
resourceGroupName	Yes	The existing Azure resource group that contains the Standard logic app.
appSettings	No	The app settings to add or change for the current logic app. Contains name-value pairs that your logic app loads at startup. Edit these app settings using the following syntax for an object array: Example: [ { "name": "key1", "value": "valueabcd" }, { "name": "key2", "value": "valueefgh" } ]
appSettings	No	Optionally, you can also choose to provide the app settings in a JSON file. Just pass the file path instead of app settings values. For example: \BudgetIT\Web\Config\appsettings.json. You can also use predefined system variables and wildcard characters, for example, $(System.DefaultWorkingDirectory).json*.
package	Yes	The location of the Standard logic app zip package on the automation agent or on a UNC path accessible to the automation agent, for example, \BudgetIT\Web\Deploy\Fabrikam.zip. You can also use predefined system variables and wildcard characters, for example, $(System.DefaultWorkingDirectory).zip*.

4.3. Usage

The following shows how to use this task in different scenarios.

4.3.1. Deploy a Standard logic app

steps:
  - task: AzureLogicAppsStandardRelease@0
    displayName: 'Azure Logic Apps Standard Release'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      appName: '$(logicAppName)'
      resourceGroupName: '$(resourceGroupName)'
      appSettings: |
        []
      package: '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/$(resources.pipeline.cipipeline.runID).zip'

-or-

steps:
  - task: AzureLogicAppsStandardRelease@0
    displayName: 'Azure Logic Apps Standard Release'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      appName: '$(logicAppName)'
      resourceGroupName: '$(resourceGroupName)'
      package: '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/$(resources.pipeline.cipipeline.runID).zip'

The zip package found at '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/$(resources.pipeline.cipipeline.runID).zip' is deployed to the Standard logic app named '$(logicAppName)' in the resource group named '$(resourceGroupName)'.

4.3.2. Deploy a Standard logic app and update app settings by passing values

steps:
  - task: AzureLogicAppsStandardRelease@0
    displayName: 'Azure Logic Apps Standard Release'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      appName: '$(logicAppName)'
      resourceGroupName: '$(resourceGroupName)'
      appSettings: |
        [
          {
            "name": "key1",
            "value": "valueabcd"
          },
          {
            "name": "key2",
            "value": "valueefgh"
          }
        ]
      package: '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/$(resources.pipeline.cipipeline.runID).zip'

4.3.3. Deploy a Standard logic app and update app settings by passing JSON file

steps:
  - task: AzureLogicAppsStandardRelease@0
    displayName: 'Azure Logic Apps Standard Release'
    inputs:
      connectedServiceName: '$(serviceConnectionName)'
      appName: '$(logicAppName)'
      resourceGroupName: '$(resourceGroupName)'
      appSettings: '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/$(resources.pipeline.cipipeline.runID)_appsettings.json'
      package: '$(Pipeline.Workspace)/cipipeline/$(logicAppCIArtifactName)/$(resources.pipeline.cipipeline.runID).zip'

5. Issues and feedback

For any issues and feedback related to the official AzureLogicAppsStandardBuild, AzureLogicAppsStandardBusinessProcessArtifactsBuild, AzureLogicAppsStandardConnectionsDeployment, and AzureLogicAppsStandardRelease tasks, contact the Azure Logic Apps team at ladevex@microsoft.com.

Do you think there might be a security issue? Have you been phished or identified a security vulnerability? Don't report these issues here, but let us know by sending an email to secure@microsoft.com.