Skip to content

Commit edf5395

Browse files
author
gitName
committed
review comments
1 parent 525d4e3 commit edf5395

File tree

4 files changed

+26
-16
lines changed

4 files changed

+26
-16
lines changed

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,14 @@ API Management service owners can also create custom groups or use external grou
186186
* [How to create and use groups][How to create and use groups]
187187
* [How to manage user accounts](api-management-howto-create-or-invite-developers.md)
188188

189+
### Workspaces
190+
191+
Workspaces support a federated API management model by allowing 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.
192+
193+
**More information**:
194+
195+
* [Workspaces in API Management](workspaces-overview.md)
196+
189197
### Policies
190198

191199
With [policies][API Management policies], an API provider can change the behavior of an API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Popular statements include format conversion from XML to JSON and call-rate limiting to restrict the number of incoming calls from a developer. For a complete list, see [API Management policies][Policy reference].
@@ -222,4 +230,4 @@ Complete the following quickstart and start using Azure API Management:
222230
[How to create or invite developers]: api-management-howto-create-or-invite-developers.md
223231
[Policy reference]: ./api-management-policies.md
224232
[API Management policies]: api-management-howto-policies.md
225-
[Create an API Management service instance]: get-started-create-service-instance.md
233+
[Create an API Management service instance]: get-started-create-service-instance.md

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Follow the steps in this article to:
2525

2626
> [!NOTE]
2727
> * 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 shared workspace gateway, helping organizations manage APIs with workspaces at a lower cost. This feature is being rolled out starting in December 2024. Shared gateways will only be available in workspaces created after the service update. [Learn more](https://aka.ms/apim/workspaces/sharedgateway)
28+
> * Associating multiple workspaces to a workspace gateway is available only for workspace gateways created after March 1, 2025. [Learn more about shared workspace gateways](workspaces-overview.md#workspace-gateway).
2929
3030
## Prerequisites
3131

@@ -45,7 +45,7 @@ Follow the steps in this article to:
4545

4646
:::image type="content" source="media/how-to-create-workspace/create-workspace-gateway.png" alt-text="Screenshot of creating a workspace gateway in the portal.":::
4747

48-
* Select **Create new** to create a new workspace gateway, or select **Use existing** to share an existing 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.
4949

5050
* If you choose to create a new gateway:
5151
* 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).

articles/api-management/workspaces-overview.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: concept-article
9-
ms.date: 01/27/2025
9+
ms.date: 02/25/2025
1010
ms.author: danlep
1111
#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.
1212

@@ -70,16 +70,16 @@ Workspace gateways are managed independently from the API Management service and
7070
* For information on the cost of workspace gateways, see [API Management pricing](https://aka.ms/apimpricing).
7171
* For a detailed comparison of API Management gateways, see [API Management gateways overview](api-management-gateways-overview.md).
7272

73-
### Dedicated versus shared workspace gateway
73+
### Dedicated versus shared workspace gateways
7474

7575
> [!NOTE]
76-
> We're introducing the ability to associate multiple workspaces with a shared workspace gateway, helping organizations manage APIs with workspaces at a lower cost. This feature is being rolled out starting in December 2024. Shared gateways will only be available in workspaces created after the service update. [Learn more](https://aka.ms/apim/workspaces/sharedgateway)
76+
> Associating multiple workspaces to a workspace gateway is available only for workspace gateways created after March 1, 2025.
7777
78-
A workspace gateway can be either *dedicated* to a single workspace or *shared* among multiple workspaces:
78+
Each workspace gateway can be associated with one or multiple workspaces:
7979

80-
* **Dedicated** - Provides isolation of runtime between workspaces, increasing API reliability, resiliency, and security and enabling attribution of runtime issues to a workspace.
81-
82-
* **Shared** - Shares gateway settings including scale, hostname, networking, and TLS configuration, and computing resources such as CPU and memory by multiple workspaces.
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.
8383

8484
Consider reliability, security, and cost when choosing a deployment model for workspaces.
8585

@@ -90,12 +90,14 @@ Consider reliability, security, and cost when choosing a deployment model for wo
9090

9191
> [!NOTE]
9292
> * 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 that share a workspace gateway must be in the same API Management instance
94-
> * A shared gateway can be associated with up to 30 workspaces (contact support to increase this limit)
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)
9595
9696
### Gateway hostname
9797

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`. Currently, custom hostnames aren't supported for workspace gateways. Use the gateway hostname to route API requests to your workspace's APIs.
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.
99+
100+
Currently, custom hostnames aren't supported for workspace gateways. You can configure a proxy, such as Azure Application Gateway or Azure Front Door, with a custom hostname.
99101

100102
### Network isolation
101103

@@ -161,7 +163,7 @@ Workspaces are designed to be self-contained to maximize segregation of administ
161163
162164
## Migrate from preview workspaces
163165

164-
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.
166+
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.
165167

166168
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).
167169

includes/api-management-service-limits.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +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 |
52+
| Maximum number of APIs per [workspace](../articles/api-management/workspaces-overview.md#workspace-gateway) | N/A | N/A | N/A | N/A | 50 |
53+
| Maximum number of workspaces per [workspace gateway premium](../articles/api-management/workspaces-overview.md#workspace-gateway) | N/A | N/A | N/A | N/A | 30 |
5454

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

0 commit comments

Comments
 (0)