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/breaking-changes/workspaces-breaking-changes-march-2025.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ services: api-management
5
5
author: dlepow
6
6
ms.service: azure-api-management
7
7
ms.topic: concept-article
8
-
ms.date: 07/10/2024
8
+
ms.date: 04/16/2025
9
9
ms.author: danlep
10
10
---
11
11
@@ -71,8 +71,8 @@ The following are abbreviated steps to add a workspace gateway to a workspace. F
71
71
1. In the left menu, under **APIs**, select **Workspaces**.
72
72
1. Select a workspace.
73
73
1. In the left menu, under **Deployment + infrastructure**, select **Gateways** > **+ Add**.
74
-
1. Complete the wizard to create a gateway. Currently, provisioning of the gateway can take from several minutes to up to 3 hours or longer.
75
-
1. After your gateway is provisioned, go to the gateway's **Overview** page. Note the value of **Runtime hostname**. Use this value to update your client apps that call your workspace's APIs.
74
+
1. Complete the wizard to create a new gateway or associate an existing gateway. Currently, provisioning a new gateway can take from several minutes to up to 3 hours or longer.
75
+
1. After adding a gateway, go to the gateway's **Overview** page. Note the value of **Runtime hostname**. Use this value to update your client apps that call your workspace's APIs.
76
76
1. Repeat the preceding steps for your remaining workspaces.
77
77
78
78
### Update client apps to use the new gateway hostname
Copy file name to clipboardExpand all lines: articles/api-management/how-to-create-workspace.md
+18-12Lines changed: 18 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: dlepow
5
5
ms.topic: how-to
6
6
ms.service: azure-api-management
7
7
ms.author: danlep
8
-
ms.date: 11/12/2024
8
+
ms.date: 04/16/2025
9
9
ms.custom:
10
10
---
11
11
@@ -19,19 +19,19 @@ Set up a [workspace](workspaces-overview.md) to enable an API team to manage and
19
19
20
20
Follow the steps in this article to:
21
21
22
-
* Create an API Management workspace and a workspace gateway using the Azure portal
22
+
* Create an API Management workspace and associate a workspace gateway using the Azure portal
23
23
* Optionally, isolate the workspace gateway in an Azure virtual network
24
24
* Assign permissions to the workspace
25
25
26
26
> [!NOTE]
27
27
> * Currently, creating a workspace gateway is a long-running operation that can take up to 3 hours or more to complete.
28
-
> *We're introducing the ability to associate multiple workspaces with a workspace gateway, helping organizations manage APIs with workspaces at a lower cost. This feature is being rolled out starting in December 2024 and it may not be available to all eligible services before January. [Learn more](https://aka.ms/apim/workspaces/sharedgateway)
28
+
> *Associating multiple workspaces with a workspace gatewayis available only for workspace gateways created after April 15, 2025. [Learn more about shared workspace gateways](workspaces-overview.md#workspace-gateway).
29
29
30
30
## Prerequisites
31
31
32
32
* An API Management instance. If you need to, [create one](get-started-create-service-instance.md) in a supported tier.
33
33
***Owner** or **Contributor** role on the resource group where the API Management instance is deployed, or equivalent permissions to create resources in the resource group.
34
-
* (Optional) An existing or new Azure virtual network and subnet to isolate the workspace gateway's inbound and outbound traffic. For configuration options and requirements, see [Network resource requirements for workspace gateways](virtual-network-workspaces-resources.md).
34
+
* (Optional) A subnet in a new or existing Azure virtual network to isolate the workspace gateway's inbound and outbound traffic. For configuration options and requirements, see [Network resource requirements for workspace gateways](virtual-network-workspaces-resources.md).
35
35
36
36
## Create a workspace - portal
37
37
@@ -41,20 +41,26 @@ Follow the steps in this article to:
41
41
42
42
1. On the **Basics** tab, enter a descriptive **Display name**, resource **Name**, and optional **Description** for the workspace. Select **Next**.
43
43
44
-
1. On the **Gateway** tab, configure settings for the workspace gateway:
44
+
1. On the **Gateway** tab, configure settings for the workspace gateway.
45
45
46
-
* In **Gateway details**, enter a gateway name and select the number of scale **Units**. The gateway costs are based on the number of units you select. For more information, see [API Management pricing](https://aka.ms/apimpricing).
46
+
:::image type="content" source="media/how-to-create-workspace/create-workspace-gateway.png" alt-text="Screenshot of creating a workspace gateway in the portal.":::
47
47
48
-
*In**Network**, select a **Network configuration**for your workspace gateway.
48
+
*Select**Create new** to create a new workspace gateway, or select **Use existing**to associate the workspace with an existing gateway that has other workspaces deployed on it.
49
49
50
-
> [!IMPORTANT]
51
-
> Plan your workspace's network configuration carefully. You can't change the network configuration after you create the workspace.
52
-
53
-
* If you select a network configuration that includes private inbound or private outbound network access, select a **Virtual network** and **Subnet** to isolate the workspace gateway, or create a new one. For network requirements, see [Network resource requirements for workspace gateways](virtual-network-workspaces-resources.md).
50
+
* If you choose to create a new gateway:
51
+
* In **Gateway details**, enter a new gateway name and select the number of scale **Units**. The gateway costs are based on the number of units. For more information, see [API Management pricing](https://aka.ms/apimpricing).
54
52
53
+
* In **Network**, select a **Network configuration** for your workspace gateway.
54
+
55
+
> [!IMPORTANT]
56
+
> Plan your workspace's network configuration carefully. You can't change the network configuration after you create the workspace.
57
+
58
+
* If you select a network configuration that includes private inbound or private outbound network access, select a **Virtual network** and **Subnet** to isolate the workspace gateway, or create a new one. For network requirements, see [Network resource requirements for workspace gateways](virtual-network-workspaces-resources.md).
59
+
55
60
1. Select **Next**. After validation completes, select **Create**.
56
61
57
-
It can take from several minutes to up to several hours to create the workspace, workspace gateway, and related resources. To track the deployment progress in the Azure portal, go to the gateway's resource group. In the left menu, under **Settings**, select **Deployments**.
62
+
> [!NOTE]
63
+
> Creation of a new workspace gateway, if selected, can take up to several hours to complete. To track the deployment progress in the Azure portal, go to the gateway's resource group. In the left menu, under **Settings**, select **Deployments**.
58
64
59
65
After the deployment completes, the new workspace appears in the list on the **Workspaces** page. Select the workspace to manage its settings and resources.
Copy file name to clipboardExpand all lines: articles/api-management/workspaces-overview.md
+26-5Lines changed: 26 additions & 5 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: concept-article
9
-
ms.date: 01/27/2025
9
+
ms.date: 04/16/2025
10
10
ms.author: danlep
11
11
#customer intent: As administrator of an API Management instance, I want to learn about using workspaces to manage APIs in a decentralized way, so that I can enable my development teams to manage and productize their own APIs.
12
12
@@ -40,6 +40,7 @@ In Azure API Management, use *workspaces* to implement federated API management.
40
40
* Each workspace is associated with one or more [workspace gateways](#workspace-gateway) for routing API traffic to the backend services of APIs in the workspace.
41
41
* The platform team can apply API policies spanning APIs in workspaces, monitor the platform by viewing the logs for all workspaces, and implement a centralized API discovery experience with a developer portal.
42
42
43
+
43
44
:::image type="content" source="media/workspaces-overview/workspace-concept.png" alt-text="Conceptual diagram of API Management service with workspaces.":::
@@ -62,20 +63,41 @@ The following is a sample workflow for creating and using a workspace.
62
63
63
64
## Workspace gateway
64
65
65
-
Each workspace is associated with one or more workspace gateways to enable runtime of APIs managed within the workspace. The workspace gateway is a standalone Azure resource with the same core functionality as the gateway built into your API Management service.
66
+
Each workspace is configured with one or more *workspace gateways* to enable runtime of APIs managed within the workspace. A workspace gateway is a standalone Azure resource (*workspace gateway premium*) with the same core functionality as the gateway built into your API Management service.
66
67
67
68
Workspace gateways are managed independently from the API Management service and from each other. They allow for isolation of runtime between workspaces or use cases, increasing API reliability, resiliency, and security and enabling attribution of runtime issues to workspaces.
68
69
69
70
* For information on the cost of workspace gateways, see [API Management pricing](https://aka.ms/apimpricing).
70
71
* For a detailed comparison of API Management gateways, see [API Management gateways overview](api-management-gateways-overview.md).
71
72
73
+
### Associate workspaces with a workspace gateway
74
+
75
+
Depending on your organization's needs, you can associate one workspace or multiple workspaces with a workspace gateway.
76
+
77
+
> [!NOTE]
78
+
> Associating multiple workspaces with a workspace gateway is available only for workspace gateways created after April 15, 2025.
79
+
80
+
* A workspace gateway has certain configuration (such as virtual network, scale, hostname) and allocated computing resources (CPU, memory, networking resources).
81
+
* Configuration and computing resources are shared by all workspaces deployed on a gateway.
82
+
* Bugs in an API or anomalous traffic may cause exhaustion of these resources, affecting all workspaces on that gateway. In other words, the more workspaces are deployed on a gateway, the higher the risk that an API from a workspace will experience reliability issues caused by an API from another workspace.
83
+
84
+
Consider reliability, security, and cost when choosing a deployment model for workspaces.
85
+
86
+
***Use dedicated gateways for mission-critical workloads** - To maximize API reliability and security, assign each mission-critical workspace to its own gateway, avoiding shared use with other workspaces.
87
+
***Balance reliability, security, and cost** - Associate multiple workspaces with a gateway to balance reliability, security, and cost for non-critical workloads. Distributing workspaces across at least two gateways helps prevent issues, such as resource exhaustion or configuration errors, from impacting all APIs within the organization.
88
+
***Use distinct gateways for different use cases** - Group workspaces on a gateway based on a use case or network requirements. For instance, you can distinguish between internal and external APIS by assigning them to separate gateways, each with its own network configuration.
89
+
***Prepare to quarantine troubled workspaces** - Use a proxy, such as Azure Application Gateway or Azure Front Door, in front of shared workspace gateways to simplify moving a workspace that's causing resource exhaustion to a different gateway, preventing impact on other workspaces sharing the gateway.
90
+
72
91
> [!NOTE]
73
-
> We're introducing the ability to associate multiple workspaces with a workspace gateway, helping organizations manage APIs with workspaces at a lower cost. This feature is being rolled out starting in December 2024 and it may not be available to all eligible services before January. [Learn more](https://aka.ms/apim/workspaces/sharedgateway)
92
+
> * A workspace gateway needs to be in the same region as the API Management instance's primary Azure region and in the same subscription
93
+
> * All workspaces associated with a workspace gateway must be in the same API Management instance
94
+
> * A workspace gateway can be associated with up to 30 workspaces (contact support to increase this limit)
74
95
75
96
### Gateway hostname
76
97
77
-
Each association of a workspace to a workspace gateway creates a unique hostname for APIs managed in that workspace. Default hostnames follow the pattern `<workspace-name>-<hash>.gateway.<region>.azure-api.net`. Currently, custom hostnames aren't supported for workspace gateways.
98
+
Each workspace gateway provides a unique hostname for APIs managed in an associated workspace. Default hostnames follow the pattern `<gateway-name>-<hash>.gateway.<region>.azure-api.net`. Use the gateway hostname to route API requests to your workspace's APIs.
78
99
100
+
Currently, custom hostnames aren't supported for workspace gateways. You can configure Azure Application Gateway or Azure Front Door with a custom hostname in front of a workspace gateway.
79
101
80
102
### Network isolation
81
103
@@ -96,7 +118,6 @@ For a current list of regions where workspace gateways are available, see [Avail
96
118
### Gateway constraints
97
119
The following constraints currently apply to workspace gateways:
98
120
99
-
* A workspace gateway needs to be in the same region as the API Management instance's primary Azure region and in the same subscription.
100
121
* A workspace can't be associated with a self-hosted gateway
101
122
* Workspace gateways don't support inbound private endpoints
102
123
* APIs in workspace gateways can't be assigned custom hostnames
Copy file name to clipboardExpand all lines: articles/app-service/overview-tls.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: What Is TLS/SSL in Azure App Service?
3
3
description: Learn how TLS and SSL work in Azure App Service, including TLS version support, certificate management, bindings, and mutual authentication to protect web app traffic.
0 commit comments