Skip to content

Latest commit

 

History

History
207 lines (140 loc) · 9.53 KB

enable-stateful-affinity-built-in-connectors.md

File metadata and controls

207 lines (140 loc) · 9.53 KB
Raw
title description services ms.suite ms.reviewer ms.topic ms.custom ms.date
Enable stateful mode for stateless built-in connectors
Enable stateless built-in connectors to run in stateful mode for Standard workflows in Azure Logic Apps.
logic-apps
integration
estfan, edwardhe, azla
how-to
devx-track-azurepowershell
01/10/2024

Enable stateful mode for stateless built-in connectors in Azure Logic Apps

[!INCLUDE logic-apps-sku-standard]

In Standard logic app workflows, the following built-in, service provider-based connectors are stateless, by default:

  • Azure Service Bus
  • SAP
  • IBM MQ

To run these connector operations in stateful mode, you must enable this capability. This how-to guide shows how to enable stateful mode for these connectors.

Prerequisites

Enable stateful mode in the Azure portal

  1. In the Azure portal, open the Standard logic app resource where you want to enable stateful mode for these connector operations.

  2. To enable virtual network integration for your logic app, and add your logic app to the previously created subnet, follow these steps:

    1. On the logic app menu resource, under Settings, select Networking.

    2. In the Outbound traffic configuration section, next to Virtual network integration, select Not configured > Add virtual network integration.

    3. On the Add virtual network integration pane that opens, select your Azure subscription and your virtual network.

    4. From the Subnet list, select the subnet where you want to add your logic app.

    5. When you're done, select Connect, and return to the Networking page.

      The Virtual network integration property is now set to the selected virtual network and subnet, for example:

      :::image type="content" source="media/enable-stateful-affinity-built-in-connectors/enable-virtual-network-integration.png" alt-text="Screenshot shows Azure portal, Standard logic app resource, Networking page with selected virtual network and subnet.":::

    For general information about enabling virtual network integration with your app, see Enable virtual network integration in Azure App Service.

  3. Next, update your logic app's underlying website configuration (<logic-app-name>.azurewebsites.net) by using either of the following tools:

Update website configuration for logic app

After you enable virtual network integration for your logic app, you must update your logic app's underlying website configuration (<logic-app-name>.azurewebsites.net) by using one the following methods:

Azure portal

To configure virtual network private ports using the Azure portal, follow these steps:

  1. In the Azure portal, find and open your Standard logic app resource.
  2. On the logic app menu, under Settings, select Configuration.
  3. On the Configuration page, select General settings.
  4. Under Platform settings, in the VNet Private Ports box, enter the ports that you want to use.

Azure Resource Management API

To complete this task with the Azure Resource Management API - Update By Id, review the following requirements, syntax, and parameter values.

Requirements

OAuth authorization and the bearer token are required. To get the bearer token, follow these steps

  1. While you're signed in to the Azure portal, open your web browser's developer tools (F12).

  2. Get the token by sending any management request, for example, by saving a workflow in your Standard logic app.

Syntax

Updates a resource by using the specified resource ID:

PATCH https://management.azure.com/{resourceId}?api-version=2021-04-01

Parameter values

Element Value
HTTP request method PATCH
<resourceId> subscriptions/{yourSubscriptionID}/resourcegroups/{yourResourceGroup}/providers/Microsoft.Web/sites/{websiteName}/config/web
<yourSubscriptionId> The ID for your Azure subscription
<yourResourceGroup> The resource group that contains your logic app resource
<websiteName> The name for your logic app resource, which is mystandardlogicapp in this example
HTTP request body {"properties": {"vnetPrivatePortsCount": "2"}}

Example

https://management.azure.com/subscriptions/XXxXxxXX-xXXx-XxxX-xXXX-XXXXxXxXxxXX/resourcegroups/My-Standard-RG/providers/Microsoft.Web/sites/mystandardlogicapp/config/web?api-version=2021-02-01

Azure PowerShell

To complete this task with Azure PowerShell, review the following requirements, syntax, and values. This method doesn't require that you manually get the bearer token.

Syntax

Set-AzContext -Subscription {yourSubscriptionID}
$webConfig = Get-AzResource -ResourceId {resourceId}
$webConfig.Properties.vnetPrivatePortsCount = 2
$webConfig | Set-AzResource -ResourceId {resourceId}

For more information, see the following documentation:

Parameter values

Element Value
<yourSubscriptionID> The ID for your Azure subscription
<resourceId> subscriptions/{yourSubscriptionID}/resourcegroups/{yourResourceGroup}/providers/Microsoft.Web/sites/{websiteName}/config/web
<yourResourceGroup> The resource group that contains your logic app resource
<websiteName> The name for your logic app resource, which is mystandardlogicapp in this example

Example

https://management.azure.com/subscriptions/XXxXxxXX-xXXx-XxxX-xXXX-XXXXxXxXxxXX/resourcegroups/My-Standard-RG/providers/Microsoft.Web/sites/mystandardlogicapp/config/web?api-version=2021-02-01

Troubleshoot errors

Error: Reserved instance count is invalid

If you get an error that says Reserved instance count is invalid, use the following workaround:

$webConfig.Properties.preWarmedInstanceCount = $webConfig.Properties.reservedInstanceCount
$webConfig.Properties.reservedInstanceCount = $null
$webConfig | Set-AzResource -ResourceId {resourceId}

Error example:

Set-AzResource :
{
   "Code":"BadRequest",
   "Message":"siteConfig.ReservedInstanceCount is invalid.  Please use the new property siteConfig.PreWarmedInstanceCount.",
   "Target": null,
   "Details":
   [
      {
         "Message":"siteConfig.ReservedInstanceCount is invalid. Please use the new property siteConfig.PreWarmedInstanceCount."
      },
      {
         "Code":"BadRequest"
      },
      {
         "ErrorEntity":
         {
            "ExtendedCode":"51021",
            "MessageTemplate":"{0} is invalid. {1}",
            "Parameters":
            [
               "siteConfig.ReservedInstanceCount", "Please use the new property siteConfig.PreWarmedInstanceCount."
            ],
            "Code":"BadRequest",
            "Message":"siteConfig.ReservedInstanceCount is invalid. Please use the new property siteConfig.PreWarmedInstanceCount."
         }
      }
   ],
   "Innererror": null
}

Prevent context loss during resource scale-in events

Resource scale-in events might cause the loss of context for built-in connectors with stateful mode enabled. To prevent this potential loss before such events can happen, fix the number of instances available for your logic app resource. This way, no scale-in events can happen to cause this potential context loss.

  1. On your logic app resource menu, under Settings, select Scale out.

  2. On the Scale out page, in the App Scale out section, follow these steps:

    1. Set Enforce Scale Out Limit to Yes, which shows the Maximum Scale Out Limit.

    2. Set Always Ready Instances to the same number as Maximum Scale Out Limit and Maximum Burst, which appears in the Plan Scale out section, for example:

    :::image type="content" source="media/enable-stateful-affinity-built-in-connectors/scale-in-settings.png" alt-text="Screenshot shows Azure portal, Standard logic app resource, Scale out page, and Always Ready Instances number set to match Maximum Burst and Maximum Scale Out Limit.":::

  3. When you're done, on the Scale out toolbar, select Save.

Next steps