Skip to content

Commit c3a8d92

Browse files
author
gitName
committed
[APIM] Shared workspace gateway
1 parent dc6e5f3 commit c3a8d92

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

articles/api-management/how-to-create-workspace.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: dlepow
55
ms.topic: how-to
66
ms.service: azure-api-management
77
ms.author: danlep
8-
ms.date: 11/12/2024
8+
ms.date: 12/05/2024
99
ms.custom:
1010
---
1111

@@ -19,7 +19,7 @@ Set up a [workspace](workspaces-overview.md) to enable an API team to manage and
1919

2020
Follow the steps in this article to:
2121

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
2323
* Optionally, isolate the workspace gateway in an Azure virtual network
2424
* Assign permissions to the workspace
2525

@@ -43,7 +43,7 @@ Follow the steps in this article to:
4343

4444
1. On the **Gateway** tab, configure settings for the workspace gateway:
4545

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+
* In **Gateway details**, select an existing gateway, or 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).
4747

4848
* In **Network**, select a **Network configuration** for your workspace gateway.
4949

@@ -54,7 +54,7 @@ Follow the steps in this article to:
5454

5555
1. Select **Next**. After validation completes, select **Create**.
5656

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**.
57+
It can take from several minutes to up to several hours to create the workspace, a new workspace gateway (if selected), 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**.
5858

5959
After the deployment completes, the new workspace appears in the list on the **Workspaces** page. Select the workspace to manage its settings and resources.
6060

articles/api-management/workspaces-overview.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,19 +60,34 @@ While workspaces are managed independently from the API Management service and o
6060

6161
## Workspace gateway
6262

63-
Each workspace can be associated with 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.
64-
65-
Workspace gateways are managed independently from the API Management service and from each other. They ensure isolation of runtime between workspaces, increasing API reliability, resiliency, and security and enabling attribution of runtime issues to workspaces.
63+
Each workspace can be associated with workspace gateways to enable runtime of APIs managed within the workspace. A workspace gateway is a standalone Azure resource with the same core functionality as the gateway built into your API Management service. Workspace gateways are managed independently from the API Management service and from each other.
6664

6765
* For information on the cost of workspace gateways, see [API Management pricing](https://aka.ms/apimpricing).
6866
* For a detailed comparison of API Management gateways, see [API Management gateways overview](api-management-gateways-overview.md).
6967

68+
### Dedicated versus shared workspace gateway
69+
7070
> [!NOTE]
7171
> 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)
7272
73+
A workspace gateway can be either *dedicated* to a single workspace or *shared* among multiple workspaces:
74+
75+
* **Dedicated** - Provides isolation of runtime between workspaces, increasing API reliability, resiliency, and security and enabling attribution of runtime issues to a workspace.
76+
77+
* **Shared** - Gateway settings including scale, hostname, networking, and TLS configuration, and computing resources such as CPU and memory, are shared by multiple workspaces on a gateway.
78+
79+
<!--- Can a workspace be associated with both a dedicated g/w and a shared g/w?-->
80+
81+
Consider reliability, security, and cost when choosing a deployment model for workspaces.
82+
83+
* **Use dedicated gateways for mission-critical workloads** - To maximize API reliability and security, assign each mission-critical workspace to its own dedicated gateway, avoiding shared use with other workspaces.
84+
* **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.
85+
* **Use distinct gateways for different use cases** - Group workspaces on a gateway based on a use case or network requirements. For instance, separate internal and external APIs by assigning them to different gateways.
86+
**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.
87+
7388
### Gateway hostname
7489

75-
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.
90+
Each workspace gateway provides a unique hostname for APIs managed in that workspace. Default hostnames follow the pattern `<gateway-name>-<hash>.gateway.<region>.azure-api.net`. Currently, custom hostnames aren't supported for workspace gateways.
7691

7792

7893
### Network isolation
@@ -94,7 +109,9 @@ For a current list of regions where workspace gateways are available, see [Avail
94109
### Gateway constraints
95110
The following constraints currently apply to workspace gateways:
96111

97-
* A workspace gateway needs to be in the same region as the API Management instance's primary Azure region and in the same subscription.
112+
* A workspace gateway needs to be in the same region as the API Management instance's primary Azure region and in the same subscription
113+
* To associate a shared gateway, a workspace must be in the same API Management instance
114+
* A shared gateway can be associated with up to 30 workspaces (contact support to increase this limit)
98115
* A workspace can't be associated with a self-hosted gateway
99116
* Workspace gateways don't support inbound private endpoints
100117
* APIs in workspace gateways can't be assigned custom hostnames

0 commit comments

Comments
 (0)