Skip to content

Commit 7611c62

Browse files
author
gitName
committed
review
1 parent 3325eb5 commit 7611c62

File tree

4 files changed

+13
-11
lines changed

4 files changed

+13
-11
lines changed

articles/api-management/api-management-key-concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ When developers subscribe to a product, they're granted the primary and secondar
181181

182182
### Workspaces
183183

184-
Workspaces allow decentralized API development teams to manage and productize their own APIs, while a central API platform team maintains the API Management infrastructure. Each workspace contains APIs, products, subscriptions, and related entities that are accessible only to the workspace collaborators. Access is controlled through Azure role-based access control (RBAC). Each workspace is associated with a workspace gateway that routes API traffic to its backend services.
184+
Workspaces allow decentralized API development teams to manage and productize their own APIs, while a central API platform team maintains the API Management infrastructure. Each workspace contains APIs, products, subscriptions, and related entities that are accessible only to the workspace collaborators. Access is controlled through Azure role-based access control (RBAC). Each workspace is associated with one or more workspace gateways that route API traffic to its backend services.
185185

186186
**More information**:
187187

articles/api-management/breaking-changes/workspaces-breaking-changes-march-2025.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ The following are abbreviated steps to add a workspace gateway to a workspace. F
7171
1. In the left menu, under **APIs**, select **Workspaces**.
7272
1. Select a workspace.
7373
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.
7676
1. Repeat the preceding steps for your remaining workspaces.
7777

7878
### Update client apps to use the new gateway hostname

articles/api-management/workspaces-overview.md

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

6161
## Workspace gateway
6262

63-
Each workspace is associated with one or more 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.
63+
Each workspace is associated 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. Workspace gateways are managed independently from the API Management service and from each other.
6464

6565
* For information on the cost of workspace gateways, see [API Management pricing](https://aka.ms/apimpricing).
6666
* For a detailed comparison of API Management gateways, see [API Management gateways overview](api-management-gateways-overview.md).
@@ -76,18 +76,21 @@ A workspace gateway can be either *dedicated* to a single workspace or *shared*
7676

7777
* **Shared** - Shares gateway settings including scale, hostname, networking, and TLS configuration, and computing resources such as CPU and memory by multiple workspaces.
7878

79-
<!--- Can a workspace be associated with both a dedicated g/w and a shared g/w?-->
80-
8179
Consider reliability, security, and cost when choosing a deployment model for workspaces.
8280

8381
* **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.
8482
* **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.
8583
* **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.
8684
**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.
8785

86+
> [!NOTE]
87+
> * A workspace gateway needs to be in the same region as the API Management instance's primary Azure region and in the same subscription
88+
> * All workspaces that share a workspace gateway must be in the same API Management instance
89+
> * A shared gateway can be associated with up to 30 workspaces (contact support to increase this limit)
90+
8891
### Gateway hostname
8992

90-
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`. Currently, custom hostnames aren't supported for workspace gateways.
93+
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`. Currently, custom hostnames aren't supported for workspace gateways. Use the gateway hostname to route API requests to your workspace's APIs.
9194

9295

9396
### Network isolation
@@ -109,9 +112,6 @@ For a current list of regions where workspace gateways are available, see [Avail
109112
### Gateway constraints
110113
The following constraints currently apply to workspace gateways:
111114

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-
* All workspaces that share a workspace gateway 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)
115115
* A workspace can't be associated with a self-hosted gateway
116116
* Workspace gateways don't support inbound private endpoints
117117
* APIs in workspace gateways can't be assigned custom hostnames
@@ -157,7 +157,7 @@ Workspaces are designed to be self-contained to maximize segregation of administ
157157
158158
## Migrate from preview workspaces
159159

160-
If you created preview workspaces in Azure API Management and want to continue using them, migrate your workspaces to the generally available version by associating a workspace gateway with each workspace.
160+
If you created preview workspaces in Azure API Management and want to continue using them, migrate your workspaces to the generally available version by associating a dedicated or shared workspace gateway with each workspace.
161161

162162
For details and to learn about other changes that could affect your preview workspaces, see [Workspaces breaking changes (March 2025)](breaking-changes/workspaces-breaking-changes-march-2025.md).
163163

includes/api-management-service-limits.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ To request a limit increase, create a support request from the Azure portal. For
4949
| Maximum number of access policies per connection | 100 | 100 | 100 | 100 | 100 |
5050
| Maximum number of authorization requests per minute per connection | 250 | 250 | 250 | 250 | 250 |
5151
| Maximum number of [workspaces](../articles/api-management/workspaces-overview.md) per service instance | N/A | N/A | N/A | N/A | 100 |
52+
| Maximum number of APIs per [workspace](../articles/api-management/workspaces-overview.md#workspace-gateway) per service instance | N/A | N/A | N/A | N/A | 50 |
53+
| Maximum number of workspaces per [shared workspace gateway premium](../articles/api-management/workspaces-overview.md#workspace-gateway) per service instance | N/A | N/A | N/A | N/A | 30 |
5254

5355
<sup>1</sup> Connections are pooled and reused unless explicitly closed by the backend.<br/>
5456
<sup>2</sup> Includes an up to 2048-bytes long query string.<br/>

0 commit comments

Comments
 (0)