You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/api-management-howto-developer-portal-customize.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ author: dlepow
6
6
7
7
ms.service: azure-api-management
8
8
ms.topic: tutorial
9
-
ms.date: 03/29/2024
9
+
ms.date: 04/28/2025
10
10
ms.author: danlep
11
11
ms.custom: engagement-fy23
12
12
---
@@ -28,7 +28,7 @@ In this tutorial, you learn how to:
28
28
29
29
For more information about developer portal features and options, see [Azure API Management developer portal overview](developer-portal-overview.md).
30
30
31
-
:::image type="content" source="media/api-management-howto-developer-portal-customize/cover.png" alt-text="Screenshot of the API Management developer portal - administrator mode." border="false":::
31
+
:::image type="content" source="media/api-management-howto-developer-portal-customize/cover.png" alt-text="Screenshot of the API Management developer portal - administrator mode." :::
32
32
33
33
## Prerequisites
34
34
@@ -49,6 +49,8 @@ Follow these steps to access the managed version of the developer portal.
49
49
It might take a few minutes to enable the developer portal.
50
50
1. In the left menu, under **Developer portal**, select **Portal overview**. Then select the **Developer portal** button in the top navigation bar. A new browser tab with an administrative version of the portal will open.
@@ -70,7 +72,7 @@ You'll want to use your own images and other media content in the developer port
70
72
71
73
A placeholder logo is provided in the top left corner of the navigation bar. You can replace it with your own logo to match your organization's branding.
72
74
73
-
1. In the developer portal, select the default **Contoso**logo in the top left of the navigation bar.
75
+
1. In the developer portal, select the default logo in the top left of the navigation bar.
74
76
1. Select **Edit**.
75
77
1. In the **Picture** pop-up, under **Main**, select **Source**.
76
78
1. In the **Media** pop-up, select one of the following:
The pre-provisioned content in the developer portal showcases pages with commonly used features. Find them on the **Pages** panel. You can modify the content of these pages or add new ones to suit your needs.
81
82
82
-
### Layouts and pages
83
-
84
-
Layouts define how pages are displayed. For example, in the default content, there are two layouts: one applies to the home page, and the other to all remaining pages. You can modify these layouts and add more layouts to suit your needs.
83
+
Select **Layouts** on the **Pages** panel to define how pages are displayed. The developer portal comes with a default layout that's applied to the pages. You can modify this layout and add more layouts to suit your needs.
85
84
86
85
A layout gets applied to a page by matching its URL template to the page's URL. For example, a layout with a URL template of `/wiki/*` is applied to every page with the `/wiki/` segment in the URL: `/wiki/getting-started`, `/wiki/styles`, etc.
87
86
88
87
In the following image, content belonging to the layout is outlined in blue, while the page-specific content is outlined in red.
89
88
90
89
:::image type="content" source="media/developer-portal-overview/pages-layouts.png" alt-text="Screenshot of layout content in the developer portal." :::
91
90
92
-
The pre-provisioned content in the developer portal showcases pages with commonly used features. You can modify the content of these pages or add new ones to suit your needs.
93
-
94
91
> [!NOTE]
95
92
> Due to integration considerations, the following pages can't be removed or moved under a different URL: `/404`, `/500`, `/captcha`, `/change-password`, `/config.json`, `/confirm/invitation`, `/confirm-v2/identities/basic/signup`, `/confirm-v2/password`, `/internal-status-0123456789abcdef`, `/publish`, `/signin`, `/signin-sso`, `/signup`.
96
93
@@ -248,7 +245,8 @@ To restore a previous portal revision:
248
245
If you want to discard all changes you've made to the developer portal, you can reset the website to its starting state. Resetting the portal deletes any changes you've made to the developer portal pages, layouts, customizations, and uploaded media.
249
246
250
247
> [!NOTE]
251
-
> Resetting the developer portal doesn't delete the published version of the developer portal.
248
+
> * Resetting the developer portal doesn't delete the published version of the developer portal.
249
+
> * Resetting the portal could update the portal to a newer version of the developer portal codebase with updated components. The placeholder content that appears might also be changed. Developer portal features and customization options remain consistent.
Copy file name to clipboardExpand all lines: articles/app-service/app-service-hybrid-connections.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn how to create and use hybrid connections in Azure App Service
4
4
author: madsd
5
5
ms.assetid: 66774bde-13f5-45d0-9a70-4e9536a4f619
6
6
ms.topic: article
7
-
ms.date: 04/10/2025
7
+
ms.date: 04/29/2025
8
8
ms.author: madsd
9
9
ms.custom: "UpdateFrequency3, fasttrack-edit"
10
10
#customer intent: As an app developer, I want to understand the usage of Hybrid Connections to provide access to apps in Azure App Service.
@@ -237,10 +237,10 @@ The status of **Connected** means that at least one HCM is configured with that
237
237
238
238
:::image type="content" source="media/app-service-hybrid-connections/hybrid-connections-service-bus-endpoint.png" alt-text="Screenshot of Hybrid Connection Service Bus endpoint.":::
239
239
240
-
- The Service Bus gateways are the resources that accept the request into the Hybrid Connection and pass it through the Azure Relay. You need to allowlist all 128 of the gateways. The gateways are in the format: `G#-prod-[stamp]-sb.servicebus.windows.net`. The number sign, `#`, is a number between 0 and 127 and `stamp` is the name of the instance within your Azure data center where your Service Bus endpoint exists.
240
+
- The Service Bus gateways are the resources that accept the request into the Hybrid Connection and pass it through the Azure Relay. You need to allowlist all of the gateways. The gateways are in the format: `G#-prod-[stamp]-sb.servicebus.windows.net` and `GV#-prod-[stamp]-sb.servicebus.windows.net`. The number sign, `#`, is a number between 0 and 127 and `stamp` is the name of the instance within your Azure data center where your Service Bus endpoint exists.
241
241
242
242
- If you can use a wildcard, you can allowlist *\*.servicebus.windows.net*.
243
-
- If you can't use a wildcard, you must allowlist all 128 gateways.
243
+
- If you can't use a wildcard, you must allowlist all 256 of the gateways.
244
244
245
245
You can find out the stamp using *nslookup* on the Service Bus endpoint URL.
246
246
@@ -255,6 +255,13 @@ The status of **Connected** means that at least one HCM is configured with that
255
255
...
256
256
G126-prod-sn3-010-sb.servicebus.windows.net
257
257
G127-prod-sn3-010-sb.servicebus.windows.net
258
+
GV0-prod-sn3-010-sb.servicebus.windows.net
259
+
GV1-prod-sn3-010-sb.servicebus.windows.net
260
+
GV2-prod-sn3-010-sb.servicebus.windows.net
261
+
GV3-prod-sn3-010-sb.servicebus.windows.net
262
+
...
263
+
GV126-prod-sn3-010-sb.servicebus.windows.net
264
+
GV127-prod-sn3-010-sb.servicebus.windows.net
258
265
259
266
If your status says **Connected** but your app can't reach your endpoint then:
> Automatic scaling is available for all app types: Windows and Linux (deploy as code and container). Automatic scaling isn't supported for deployment slot traffic.
16
16
>
17
17
18
-
Automatic scaling is a new scale-out option that automatically handles scaling decisions for your web apps and App Service plans. It's different from the preexisting **[Azure autoscale](/azure/azure-monitor/autoscale/autoscale-overview)**, which lets you define scaling rules based on schedules and resources. With automatic scaling, you can adjust scaling settings to improve your app's performance and avoid cold start issues. The platform prewarms instances to act as a buffer when scaling out, ensuring smooth performance transitions. You're charged per second for every instance, including prewarmed instances.
18
+
Automatic scaling is a scale-out option that automatically handles scaling decisions for your web apps and App Service plans. It's different from **[Azure autoscale](/azure/azure-monitor/autoscale/autoscale-overview)**, which lets you define scaling rules based on schedules and resources.
19
+
20
+
With automatic scaling, you can adjust scaling settings to improve your app's performance and avoid cold start issues. The platform prewarms instances to act as a buffer when scaling out, ensuring smooth performance transitions. You're charged per second for every instance, including prewarmed instances.
19
21
20
22
The following table compares scale-out and scale-in options available on App Service:
21
23
22
24
||**Manual**|**Autoscale**|**Automatic scaling**|
23
25
| --- | --- | --- | --- |
24
-
| Available pricing tiers| Basic and up.| Standard and up.| Premium V2 (P1V2, P2V2 and P3V2) pricing tiers. Premium V3 (P0V3, P1V3, P2V3, P3V3, P1MV3, P2MV3, P3MV3, P4MV3 and P5MV3) pricing tiers.|
25
-
|Rule-based scaling|No. |Yes|No, the platform manages out the scale and scalein based on HTTP traffic. |
26
-
|Schedule-based scaling|No. |Yes. |No.|
27
-
|Always-ready instances | No, your web app runs on the number of manually scaled instances.| No, your web app runs on other instances available during the scale-out operation, based on the threshold defined for autoscale rules. | Yes (minimum 1).|
28
-
|Prewarmed instances|No. |No. |Yes (default 1).|
29
-
|Per-app maximum|No. |No. |Yes.|
26
+
| Available pricing tiers| Basic and up | Standard and up | Premium V2 (P1V2, P2V2, and P3V2) pricing tiers. Premium V3 (P0V3, P1V3, P2V3, P3V3, P1MV3, P2MV3, P3MV3, P4MV3, and P5MV3) pricing tiers.|
27
+
|Rule-based scaling|No|Yes|No, the platform manages the scale-out and scale-in based on HTTP traffic. |
28
+
|Schedule-based scaling|No|Yes|No|
29
+
|Always-ready instances | No, your web app runs on the number of manually scaled instances.| No, your web app runs on other instances available during the scale-out operation, based on the threshold defined for autoscale rules. | Yes (minimum 1) |
30
+
|Prewarmed instances|No|No|Yes (default 1) |
31
+
|Per-app maximum|No|No|Yes|
30
32
31
33
## How automatic scaling works
32
34
@@ -40,11 +42,11 @@ Here are a few scenarios where you should scale out automatically:
40
42
41
43
## Enable automatic scaling
42
44
43
-
The **Maximum burst**level represents the highest number of instances that your App Service plan can increase to based on incoming HTTP requests. For Premium v2 & v3 plans, you can set **Maximum burst** to up to 30 instances. The **Maximum burst** number must be equal to or greater than the number of workers specified for the App Service plan.
45
+
The **Maximum burst**setting represents the highest number of instances that your App Service plan can increase to based on incoming HTTP requests. For Premium v2 & v3 plans, you can specify up to 30 instances. The maximum burst number must be equal to or greater than the number of workers specified for the App Service plan.
44
46
45
47
#### [Azure portal](#tab/azure-portal)
46
48
47
-
To enable automatic scaling, go to the web app's left menu and select **scale-out (App Service Plan)**. Select **Automatic**, update the **Maximum burst** value, and select the **Save** button.
49
+
To enable automatic scaling, go to the web app's left menu. Under **Settings**, select **Scale-out (App Service plan)**. Select **Automatic**, update the **Maximum burst** value, and select the **Save** button.
48
50
49
51
:::image type="content" source="./media/manage-automatic-scaling/azure-portal-automatic-scaling.png" alt-text="Screenshot that shows automatic scaling in Azure portal" :::
50
52
@@ -57,7 +59,7 @@ az appservice plan update --name <APP_SERVICE_PLAN> --resource-group <RESOURCE_G
57
59
```
58
60
59
61
>[!NOTE]
60
-
> If you receive the error message "Operation returned an invalid status 'Bad Request'," try using a different resource group or create a new one.
62
+
> If you receive the error message `Operation returned an invalid status 'Bad Request'`, try using a different resource group or create a new one.
61
63
>
62
64
63
65
---
@@ -68,11 +70,14 @@ The app-level setting **Always ready instances** specifies the minimum number of
68
70
69
71
#### [Azure portal](#tab/azure-portal)
70
72
71
-
To set the minimum number of web app instances, go to the web app's left menu and select **scale-out (App Service Plan)**. Update the **Always ready instances** value, and select the **Save** button.
73
+
To set the minimum number of web app instances, go to the web app's left menu and select **Scale-out (App Service plan)**. Update the **Always ready instances** value, and select the **Save** button.
72
74
73
75
:::image type="content" source="./media/manage-automatic-scaling/azure-portal-always-ready-instances.png" alt-text="Screenshot of always-ready instances." :::
74
76
75
77
#### [Azure CLI](#tab/azure-cli)
78
+
79
+
To set the minimum number of web app instances, use the following command:
80
+
76
81
```azurecli-interactive
77
82
az webapp update --resource-group <RESOURCE_GROUP> --name <APP_NAME> --minimum-elastic-instance-count <ALWAYS_READY_COUNT>
78
83
```
@@ -81,11 +86,11 @@ To set the minimum number of web app instances, go to the web app's left menu an
81
86
82
87
## Set the maximum number of web app instances
83
88
84
-
The **Maximum scale limit** value sets the maximum number of instances a web app can scale to. The **Maximum scale limit** is helpful when a downstream component like a database has limited throughput. The per-app maximum can be between 1 and the **Maximum burst**.
89
+
The **Maximum scale limit** value sets the maximum number of instances a web app can scale to. The **Maximum scale limit** is helpful when a downstream component like a database has limited throughput. The per-app maximum can be between 1 and the maximum burst value.
85
90
86
91
#### [Azure portal](#tab/azure-portal)
87
92
88
-
To set the maximum number of web app instances, go to the web app's left menu and select **scale-out (App Service Plan)**. Select **Enforce scale-out limit**, update the **Maximum scale limit**, and select the **Save** button.
93
+
To set the maximum number of web app instances, go to the web app's left menu and select **Scale-out (App Service plan)**. Select **Enforce scale-out limit**, update the **Maximum scale limit**, and select the **Save** button.
89
94
90
95
:::image type="content" source="./media/manage-automatic-scaling/azure-portal-maximum-scale-limit.png" alt-text="Screenshot of maximum scale limit." :::
91
96
@@ -97,7 +102,7 @@ Currently, you can't change the **Maximum scale limit** in the Azure CLI. You mu
97
102
98
103
## Update prewarmed instances
99
104
100
-
The **prewarmed instance** setting provides warmed instances as a buffer during HTTP scale and activation events. Prewarmed instances continue to buffer until the maximum scale-out limit is reached. The default **prewarmed instance** count is 1 and, for most scenarios, this value should remain as 1.
105
+
The prewarmed instance setting provides warmed instances as a buffer during HTTP scale and activation events. Prewarmed instances continue to buffer until the maximum scale-out limit is reached. The default prewarmed instance count is *1* and, for most scenarios, this value should remain as 1.
101
106
102
107
#### [Azure portal](#tab/azure-portal)
103
108
@@ -117,7 +122,7 @@ You can modify the number of prewarmed instances for an app by using the Azure C
117
122
118
123
#### [Azure portal](#tab/azure-portal)
119
124
120
-
To disable automatic scaling, go to the web app's left menu and select **scale-out (App Service Plan)**. Select **Manual** and select the **Save** button.
125
+
To disable automatic scaling, go to the web app's left menu and select **Scale-out (App Service plan)**. Select **Manual** and select the **Save** button.
121
126
122
127
:::image type="content" source="./media/manage-automatic-scaling/azure-portal-manual-scaling.png" alt-text="Screenshot of manual scaling." :::
123
128
@@ -141,6 +146,7 @@ No, you can only have Azure App Service web apps in the App Service plan in whic
141
146
>
142
147
143
148
### How does automatic scaling work behind the scenes?
149
+
144
150
Applications set to automatically scale are continuously monitored, with worker health assessments occurring at least once every few seconds. If the system detects increased load on the application, health checks become more frequent. If worker health deteriorates and requests slow down, other instances are requested. The speed at which instances are added varies based on the individual application's load pattern and startup time. Applications with brief startup times and intermittent bursts of load might see one virtual machine added every few seconds to a minute.
145
151
146
152
Once the load subsides, the platform initiates a review for potential scaling in. This process typically begins about 5-10 minutes after the load stops increasing. During scaling in, instances are removed at a maximum rate of one every few seconds to a minute.
@@ -168,11 +174,12 @@ If your web app returns a 5xx status, these endpoint pings might result in inter
168
174
### How do I track the number of scaled-out instances during the automatic scaling event?
169
175
170
176
The `AutomaticScalingInstanceCount` metric reports the number of virtual machines on which the app is running, including the prewarmed instance if it's deployed. This metric can also be used to track the maximum number of instances your web app scaled out during an automatic scaling event. This metric is available only for the apps that have **Automatic Scaling** enabled.
177
+
171
178
### How does ARR Affinity affect automatic scaling?
172
179
173
180
Azure App Service uses Application Request Routing cookies known as an ARR Affinity. ARR Affinity cookies restrict scaling because they send requests only to servers associated with the cookie, rather than any available instance. For apps that store state, it's better to scale up (increase resources on a single instance). For stateless apps, scaling out (adding more instances) offers more flexibility and scalability. ARR Affinity cookies are enabled by default on App Service. Depending on your application needs, you might choose to disable ARR affinity cookies when using automatic scaling.
174
181
175
-
To disable ARR Affinity cookies: select your App Service app, and under **Settings**, select **Configuration**. Next select the **General settings** tab. Under **ARR affinity**, select **Off** and then select the **Save** button.
182
+
To disable ARR Affinity cookies: select your App Service app, and under **Settings**, select **Configuration**. Next select the **General settings** tab. Under **Session affinity**, select **Off** and then select the **Save** button.
0 commit comments