Create and manage integration accounts for B2B workflows in Azure Logic Apps with the Enterprise Integration Pack

Article
04/06/2023

Applies to: Azure Logic Apps (Consumption + Standard)

Before you can build business-to-business (B2B) and enterprise integration workflows using Azure Logic Apps, you need to create an integration account resource. This account is a scalable cloud-based container in Azure that simplifies how you store and manage B2B artifacts that you define and use in your workflows for B2B scenarios, for example:

You also need an integration account to electronically exchange B2B messages with other organizations. When other organizations use protocols and message formats different from your organization, you have to convert these formats so your organization's system can process those messages. With Azure Logic Apps, you can build workflows that support the following industry-standard protocols:

This article shows how to complete the following tasks:

Create an integration account.
Link your integration account to a logic app resource.
Change the pricing tier for your integration account.
Unlink your integration account from a logic app resource.
Move an integration account to another Azure resource group or subscription.
Delete an integration account.

If you're new to creating B2B enterprise integration workflows in Azure Logic Apps, review the following documentation:

Prerequisites

An Azure account and subscription. If you don't have an Azure subscription, sign up for a Azure account. Make sure that you use the same Azure subscription for both your integration account and logic app resource.
Whether you're working on a Consumption or Standard logic app workflow, your logic app resource must already exist before you can link your integration account.
- For Consumption logic app resources, this link is required before you can use the artifacts from your integration account with your workflow. Although you can create your artifacts without this link, the link is required when you're ready to use these artifacts.
- For Standard logic app resources, this link is optional, based on your scenario:
  - If you have an integration account with the artifacts that you need or want to use, you can link the integration account to each Standard logic app resource where you want to use the artifacts.
  - Some Azure-hosted integration account connectors, such as AS2, EDIFACT, and X12, let you create a connection to your integration account. If you're just using these connectors, you don't need the link.
  - The built-in connectors named Liquid and Flat File let you select maps and schemas that you previously uploaded to your logic app resource or to a linked integration account.
    
    If you don't have or need an integration account, you can use the upload option. Otherwise, you can use the linking option, which also means you don't have to upload maps and schemas to each logic app resource. Either way, you can use these artifacts across all child workflows within the same logic app resource.
Basic knowledge about how to create logic app workflows. For more information, see the following documentation:
- Quickstart: Create an example Consumption logic app workflow in multi-tenant Azure Logic Apps
- Create an example Standard logic app workflow in single-tenant Azure Logic Apps

Create integration account

Integration accounts are available in different tiers that vary in pricing. Based on the tier you choose, creating an integration account might incur costs. For more information, review Azure Logic Apps pricing and billing models and Azure Logic Apps pricing.

Based on your requirements and scenarios, determine the appropriate integration account tier to create. The following table describes the available tiers:

Tier	Description
Basic	For scenarios where you want only message handling or to act as a small business partner that has a trading partner relationship with a larger business entity. Supported by the Azure Logic Apps SLA.
Standard	For scenarios where you have more complex B2B relationships and increased numbers of entities that you must manage. Supported by the Azure Logic Apps SLA.

For this task, you can use the Azure portal, Azure CLI, or Azure PowerShell.

Important

For you to successfully link and use your integration account with your logic app, make sure that both resources exist in the same Azure subscription and Azure region.

Portal
Azure CLI

In the Azure portal, sign in with your Azure account credentials.
In the Azure portal search box, enter integration accounts, and select Integration accounts.
Under Integration accounts, select Create.

On the Create an integration account pane, provide the following information about your integration account:

Property	Required	Value	Description
Subscription	Yes	<Azure-subscription-name>	The name for your Azure subscription
Resource group	Yes	<Azure-resource-group-name>	The name for the Azure resource group to use for organizing related resources. For this example, create a new resource group named FabrikamIntegration-RG.
Integration account name	Yes	<integration-account-name>	Your integration account's name, which can contain only letters, numbers, hyphens (`-`), underscores (`_`), parentheses (`()`), and periods (`.`). This example uses Fabrikam-Integration.
Region	Yes	<Azure-region>	The Azure region where to store your integration account metadata. Either select the same location as your logic app resource, or create your logic apps in the same location as your integration account. For this example, use China East 2.
Pricing Tier	Yes	<pricing-level>	The pricing tier for the integration account, which you can change later. For this example, select Basic. For more information, review the following documentation: - Logic Apps pricing model - Logic Apps limits and configuration - Logic Apps pricing
Enable log analytics	No	Unselected	For this example, don't select this option.

When you're done, select Review + create.

After deployment completes, Azure opens your integration account.

Prepare your environment for the Azure CLI

You can use the local Azure CLI.

If you prefer, install the Azure CLI to run CLI reference commands.
Local Azure CLI, see how to install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.
- Sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, see Sign in with the Azure CLI.
- When you're prompted, install the Azure CLI extension on first use. For more information about extensions, see Use extensions with the Azure CLI.
- Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.

To add the az logic integration-account extension, use the az extension add command:
```
az extension add --name logic
```
To create a resource group or use an existing resource group, run the az group create command:
```
az group create --name myresourcegroup --location chinanorth
```
To list the integration accounts for a resource group, use the az logic integration-account list command:
```
az logic integration-account list --resource-group myresourcegroup
```
To create an integration account, run the az logic integration-account create command:
```
az logic integration-account create --resource-group myresourcegroup \
    --name integration_account_01 --location chinanorth --sku name=Standard
```
Your integration account name can contain only letters, numbers, hyphens (-), underscores (_), parentheses (()), and periods (.).

To view a specific integration account, use the az logic integration-account show command:
```
az logic integration-account show --name integration_account_01 --resource-group myresourcegroup
```
You can change your SKU, or pricing tier, by using the az logic integration-account update command:
```
az logic integration-account update --sku name=Basic --name integration_account_01 \
    --resource-group myresourcegroup
```
For more information about pricing, see these resources:

To import an integration account by using a JSON file, use the az logic integration-account import command:

az logic integration-account import --name integration_account_01 \
    --resource-group myresourcegroup --input-path integration.json

Link to logic app

For you to successfully link your integration account to your logic app resource, make sure that both resources use the same Azure subscription and Azure region.

Consumption
Standard

This section describes how to complete this task using the Azure portal. If you use Visual Studio and your logic app is in an Azure Resource Group project, you can link your logic app to an integration account by using Visual Studio.

In the Azure portal, open your logic app resource.
On your logic app's navigation menu, under Settings, select Workflow settings. Under Integration account, open the Select an Integration account list, and select the integration account you want.
To finish linking, select Save.

After your integration account is successfully linked, Azure shows a confirmation message.

Now your logic app workflow can use the artifacts in your integration account plus the B2B connectors, such as XML validation and flat file encoding or decoding.

Find your integration account's callback URL

Before you can link your integration account to a Standard logic app resource, you need to have your integration account's callback URL.

In the Azure portal, sign in with your Azure account credentials.
In the Azure portal search box, find and select your integration account. To browse existing accounts, enter integration accounts, and then select Integration accounts.
From the Integration accounts list, select your integration account.
On your selected integration account's navigation menu, under Settings, select Callback URL.
Find the Generated Callback URL property value, copy the value, and save the URL to use later for linking.

Link integration account to Standard logic app

Azure portal

In the Azure portal, open your Standard logic app resource.
On your logic app's navigation menu, under Settings, select Configuration.
On the Configuration pane, check whether the app setting named WORKFLOW_INTEGRATION_ACCOUNT_CALLBACK_URL exists.
If the app setting doesn't exist, under the Configuration pane toolbar, select New application setting.
Provide the following values for the app setting:

Property Value

Name WORKFLOW_INTEGRATION_ACCOUNT_CALLBACK_URL

Value <integration-account-callback-URL>
When you're done, select OK. When you return to the Configuration pane, make sure to save your changes. On the Configuration pane toolbar, select Save.

Visual Studio Code

From your Standard logic app project in Visual Studio Code, open the local.settings.json file.

In the Values object, add an app setting that has the following properties and values, including the previously saved callback URL:

Property	Value
Name	WORKFLOW_INTEGRATION_ACCOUNT_CALLBACK_URL
Value	<integration-account-callback-URL>

This example shows how a sample app setting might appear:

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobStorage": "UseDevelopmentStorage=true",
        "FUNCTIONS_WORKER_RUNTIME": "node",
        "WORKFLOW_INTEGRATION_ACCOUNT_CALLBACK_URL": "https://prod-03.chinanorth.logic.azure.cn:443/integrationAccounts/...."
    }
}

When you're done, save your changes.

Change pricing tier

To increase the limits for an integration account, you can upgrade to a higher pricing tier, if available. For example, you can upgrade from the Free tier to the Basic tier or Standard tier. You can also downgrade to a lower tier, if available. For more information pricing information, review the following documentation:

Upgrade pricing tier

To make this change, you can use either the Azure portal or the Azure CLI.

Portal
Azure CLI

Sign in to the Azure portal with your Azure account credentials.
In the main Azure search box, enter integration accounts, and select Integration accounts.

Azure shows all the integration accounts in your Azure subscriptions.
Under Integration accounts, select the integration account that you want to move. On your integration account menu, select Overview.
On the Overview pane, select Upgrade Pricing Tier, which lists any available higher tiers. When you select a tier, the change immediately takes effect.

If you haven't done so already, install the Azure CLI prerequisites.
Open the Azure CLI on your local Computer.

At the command prompt, enter the az resource command, and set skuName to the higher tier that you want.

az resource update --resource-group {ResourceGroupName} --resource-type Microsoft.Logic/integrationAccounts --name {IntegrationAccountName} --subscription {AzureSubscriptionID} --set sku.name={SkuName}

For example, if you have the Basic tier, you can set skuName to Standard:

az resource update --resource-group FabrikamIntegration-RG --resource-type Microsoft.Logic/integrationAccounts --name Fabrikam-Integration --subscription XXXXXXXXXXXXXXXXX --set sku.name=Standard

Downgrade pricing tier

To make this change, use the Azure CLI.

If you haven't done so already, install the Azure CLI prerequisites.
Open the bash shell on your local Computer.

At the command prompt, enter the az resource command and set skuName to the lower tier that you want.

az resource update --resource-group <resourceGroupName> --resource-type Microsoft.Logic/integrationAccounts --name <integrationAccountName> --subscription <AzureSubscriptionID> --set sku.name=<skuName>

For example, if you have the Standard tier, you can set skuName to Basic:

az resource update --resource-group FabrikamIntegration-RG --resource-type Microsoft.Logic/integrationAccounts --name Fabrikam-Integration --subscription XXXXXXXXXXXXXXXXX --set sku.name=Basic

Unlink from logic app

In the Azure portal, open your Standard logic app resource.
On your logic app's navigation menu, under Settings, select Configuration.
On the Configuration pane, find the app setting named WORKFLOW_INTEGRATION_ACCOUNT_CALLBACK_URL.
In the Delete column, select Delete (trash can icon).
On the Configuration pane toolbar, select Save.

Visual Studio Code

From your Standard logic app project in Visual Studio Code, open the local.settings.json file.
In the Values object, find and delete the app setting that has the following properties and values:

Property Value

Name WORKFLOW_INTEGRATION_ACCOUNT_CALLBACK_URL

Value <integration-account-callback-URL>
When you're done, save your changes.

Move integration account

You can move your integration account to another Azure resource group or Azure subscription. When you move resources, Azure creates new resource IDs, so make sure that you use the new IDs instead and update any scripts or tools associated with the moved resources. If you want to change the subscription, you must also specify an existing or new resource group.

For this task, you can use either the Azure portal by following the steps in this section or the Azure CLI.

Sign in to the Azure portal with your Azure account credentials.
In the main Azure search box, enter integration accounts, and select Integration accounts.

Azure shows all the integration accounts in your Azure subscriptions.
Under Integration accounts, select the integration account that you want to move. On your integration account menu, select Overview.
On the Overview pane, next to either Resource group or Subscription name, select change.
Select any related resources that you also want to move.
Based on your selection, follow these steps to change the resource group or subscription:
- Resource group: From the Resource group list, select the destination resource group. Or, to create a different resource group, select Create a new resource group.
- Subscription: From the Subscription list, select the destination subscription. From the Resource group list, select the destination resource group. Or, to create a different resource group, select Create a new resource group.
To acknowledge your understanding that any scripts or tools associated with the moved resources won't work until you update them with the new resource IDs, select the confirmation box, and then select OK.
After you finish, make sure that you update all scripts with the new resource IDs for your moved resources.

Delete integration account

For this task, you can use either the Azure portal by following the steps in this section, Azure CLI, or Azure PowerShell.

Portal
Azure CLI

Sign in to the Azure portal with your Azure account credentials.
In the main Azure search box, enter integration accounts, and select Integration accounts.

Azure shows all the integration accounts in your Azure subscriptions.
Under Integration accounts, select the integration account that you want to delete. On your integration account menu, select Overview.
On the Overview pane, select Delete.
To confirm that you want to delete your integration account, select Yes.

You can delete an integration account by using the az logic integration-account delete command:

az logic integration-account delete --name integration_account_01 --resource-group myresourcegroup

Create and manage integration accounts for B2B workflows in Azure Logic Apps with the Enterprise Integration Pack

Prerequisites

Create integration account

Prepare your environment for the Azure CLI

Link to logic app

Find your integration account's callback URL

Link integration account to Standard logic app

Azure portal

Visual Studio Code

Change pricing tier

Upgrade pricing tier

Downgrade pricing tier

Unlink from logic app

Visual Studio Code

Move integration account

Delete integration account

Next steps

Additional resources

Additional resources