Merge pull request #296548 from ecfan/patch-1

[Standard] Enable stateful affinity - Add screenshots for visibility + screenshot refresh

Author: v-ccolin

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

@@ -6,7 +6,7 @@ ms.suite: integration
 ms.reviewer: estfan, edwardhe, azla
 ms.topic: how-to
 ms.custom: devx-track-azurepowershell
-ms.date: 01/10/2024
+ms.date: 03/18/2025
 ---
 
 # Enable stateful mode for stateless built-in connectors in Azure Logic Apps
@@ -25,18 +25,16 @@ To run these connector operations in stateful mode, you must enable this capabil
 
 - An Azure account and subscription. If you don't have a subscription, [sign up for a free Azure account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
 
-- The Standard logic app resource where you plan to create the workflow that uses the stateful mode-enabled connector operations. If you don't have this resource, [create your Standard logic app resource now](../logic-apps/create-single-tenant-workflows-azure-portal.md).
+- The Standard logic app resource where you plan to create the workflow that uses the stateful mode-enabled connector operations. If you don't have this resource, [create your Standard logic app resource now](/azure/logic-apps/create-single-tenant-workflows-azure-portal).
 
 - An Azure virtual network with a subnet to integrate with your logic app. If you don't have these items, see the following documentation:
 
-  - [Quickstart: Create a virtual network with the Azure portal](../virtual-network/quick-create-portal.md)
-  - [Add, change, or delete a virtual network subnet](../virtual-network/virtual-network-manage-subnet.md?tabs=azure-portal)
+  - [Quickstart: Create a virtual network with the Azure portal](/azure/virtual-network/quick-create-portal)
+  - [Add, change, or delete a virtual network subnet](/azure/virtual-network/virtual-network-manage-subnet?tabs=azure-portal)
 
 ## Enable stateful mode in the Azure portal
 
-> [!NOTE]
-> If you use network security groups in your virtual network, stateful mode requires that
-> you open [ports 20,000 to 30,000](../app-service/overview-vnet-integration.md#private-ports).
+If you use network security groups in your virtual network, stateful mode requires that you open [ports 20,000 to 30,000](/azure/app-service/overview-vnet-integration#private-ports).
 
 1. In the [Azure portal](https://portal.azure.com), open the Standard logic app resource where you want to enable stateful mode for these connector operations.
 
@@ -56,7 +54,7 @@ To run these connector operations in stateful mode, you must enable this capabil
 
       :::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](../app-service/configure-vnet-integration-enable.md).
+   For general information about enabling virtual network integration with your app, see [Enable virtual network integration in Azure App Service](/azure/app-service/configure-vnet-integration-enable).
 
 1. Next, update your logic app's underlying website configuration (**<*logic-app-name*>.azurewebsites.net**) by using either of the following tools:
 
@@ -73,10 +71,17 @@ After you enable virtual network integration for your logic app, you must update
 To configure virtual network private ports using the Azure portal, follow these steps:
 
 1. In the [Azure portal](https://portal.azure.com), find and open your Standard logic app resource.
+
 1. On the logic app menu, under **Settings**, select **Configuration**.
+
 1. On the **Configuration** page, select **General settings**.
+
+   :::image type="content" source="media/enable-stateful-affinity-built-in-connectors/general-settings.png" alt-text="Screenshot shows Azure portal, Standard logic app menu, Settings, and Configuration with general settings tab selected.":::
+
 1. Under **Platform settings**, in the **VNet Private Ports** box, enter the ports that you want to use.
 
+   :::image type="content" source="media/enable-stateful-affinity-built-in-connectors/vnet-private-ports.png" alt-text="Screenshot shows Azure portal, Standard logic app menu, Settings, and Configuration with general settings tab selected, and highlighted property named VNet Private Ports.":::
+
 ### Azure Resource Management API
 
 To complete this task with the [Azure Resource Management API - Update By Id](/rest/api/resources/resources/update-by-id), review the following requirements, syntax, and parameter values.
@@ -93,22 +98,22 @@ OAuth authorization and the bearer token are required. To get the bearer token,
 
 Updates a resource by using the specified resource ID:
 
-`PATCH https://management.azure.com/{resourceId}?api-version=2021-04-01`
+**`PATCH https://management.azure.com/<resource-ID>?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"}}** |
+| **<*resource-ID*>** | **`subscriptions/<Azure-subscription-ID>/resourcegroups/<resource-group>/providers/Microsoft.Web/sites/<website-name>/config/web`** |
+| **<*Azure-subscription-ID*>** | The ID for your Azure subscription |
+| **<*resource-group*>** | The resource group that contains your logic app resource, which is **My-Standard-RG** in this example |
+| **<*website-name*>** | 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`
+**`https://management.azure.com/subscriptions/<Azure-subscription-ID>/resourcegroups/My-Standard-RG/providers/Microsoft.Web/sites/mystandardlogicapp/config/web?api-version=2021-02-01`**
 
 ### Azure PowerShell
 
@@ -117,10 +122,10 @@ To complete this task with Azure PowerShell, review the following requirements,
 #### Syntax
 
 ```powershell
-Set-AzContext -Subscription {yourSubscriptionID}
-$webConfig = Get-AzResource -ResourceId {resourceId}
+Set-AzContext -Subscription <Azure-subscription-ID>
+$webConfig = Get-AzResource -ResourceId <resource-ID>
 $webConfig.Properties.vnetPrivatePortsCount = 2
-$webConfig | Set-AzResource -ResourceId {resourceId}
+$webConfig | Set-AzResource -ResourceId <resource-ID>
 ```
 
 For more information, see the following documentation:
@@ -133,14 +138,14 @@ For more information, see the following documentation:
 
 | 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 |
+| **<*Azure-subscription-ID*>** | The ID for your Azure subscription |
+| **<*resource-ID*>** | **`subscriptions/<Azure-subscription-ID>/resourcegroups/<resource-group>/providers/Microsoft.Web/sites/<website-name>/config/web`** |
+| **<*resource-group*>** | The resource group that contains your logic app resource, which is **My-Standard-RG** in this example |
+| **<*website-name*>** | 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`
+**`https://management.azure.com/subscriptions/<Azure-subscription-ID>/resourcegroups/My-Standard-RG/providers/Microsoft.Web/sites/mystandardlogicapp/config/web?api-version=2021-02-01`**
 
 #### Troubleshoot errors
 
@@ -151,7 +156,7 @@ If you get an error that says **Reserved instance count is invalid**, use the fo
 ```powershell
 $webConfig.Properties.preWarmedInstanceCount = $webConfig.Properties.reservedInstanceCount
 $webConfig.Properties.reservedInstanceCount = $null
-$webConfig | Set-AzResource -ResourceId {resourceId}
+$webConfig | Set-AzResource -ResourceId <resource-ID>
 ```
 
 Error example:
@@ -160,7 +165,7 @@ Error example:
 Set-AzResource :
 {
    "Code":"BadRequest",
-   "Message":"siteConfig.ReservedInstanceCount is invalid.  Please use the new property siteConfig.PreWarmedInstanceCount.",
+   "Message":"siteConfig.ReservedInstanceCount is invalid. Please use the new property siteConfig.PreWarmedInstanceCount.",
    "Target": null,
    "Details":
    [
@@ -192,20 +197,20 @@ Set-AzResource :
 
 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**.
+1. On your logic app resource menu, under **Settings**, select **Scale out (App Service plan)**.
 
-1. On the **Scale out** page, in the **App Scale out** section, follow these steps:
+1. On the **Scale out (App Service plan)** 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**.
+   1. Set **Enforce Scale Out Limit** to **Yes**, which shows the **Maximum Scale Out Limit** property.
 
    1. 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.":::
+      :::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.":::
 
 1. When you're done, on the **Scale out** toolbar, select **Save**.
 
 ## Next steps
 
-- [Connect to Azure Service Bus](connectors-create-api-servicebus.md)
-- [Connect to SAP](../logic-apps/logic-apps-using-sap-connector.md)
-- [Connect to IBM MQ](connectors-create-api-mq.md)
+- [Connect to Azure Service Bus](/azure/connectors/connectors-create-api-servicebus)
+- [Connect to SAP](/azure/logic-apps/connectors/sap)
+- [Connect to IBM MQ](/azure/connectors/connectors-create-api-mq)