Skip to content

Commit e2169a7

Browse files
Merge pull request #230333 from dlepow/wsrev
[APIM] [Workspaces] Add'l review comments
2 parents 6dd9b3a + 4f7eff0 commit e2169a7

File tree

4 files changed

+21
-15
lines changed

4 files changed

+21
-15
lines changed

articles/api-management/api-management-in-workspace.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: dlepow
55
ms.topic: how-to
66
ms.service: api-management
77
ms.author: danlep
8-
ms.date: 02/22/2023
8+
ms.date: 03/10/2023
99
ms.custom:
1010
---
1111

@@ -16,13 +16,16 @@ This article is an introduction to managing APIs, products, subscriptions, and o
1616
[!INCLUDE [api-management-availability-premium-dev-standard](../../includes/api-management-availability-premium-dev-standard.md)]
1717

1818
> [!NOTE]
19-
> Workspaces are supported in API Management REST API version 2022-09-01-preview or later.
19+
> * Workspaces are a preview feature of API Management and subject to certain [limitations](workspaces-overview.md#preview-limitations).
20+
> * This feature is being released during March and April 2023.
21+
> * Workspaces are supported in API Management REST API version 2022-09-01-preview or later.
22+
> * For pricing considerations, see [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/).
2023
2124
## Prerequisites
2225

2326
* An API Management instance. If needed, ask an administrator to [create one](get-started-create-service-instance.md).
2427
* A workspace. If needed, ask an administrator of your API Management instance to [create one](how-to-create-workspace.md).
25-
* Permissions to collaborate in the workspace. If needed, ask a workspace administrator to assign you appropriate [roles](api-management-role-based-access-control.md#built-in-workspace-roles) in the workspace.
28+
* Permissions to collaborate in the workspace. If needed, ask a workspace owner to assign you appropriate [roles](api-management-role-based-access-control.md#built-in-workspace-roles) in the workspace.
2629

2730
## Go to the workspace - portal
2831

articles/api-management/api-management-role-based-access-control.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ A workspace collaborator must be assigned both a workspace-scoped role and a ser
4949
|API Management Workspace Reader | workspace | Has read-only access to entities in the workspace. |
5050
|API Management Workspace API Developer | workspace | Has read access to entities in the workspace and read and write access to APIs, policies, schemas, products, policy fragments, named values, and tags. |
5151
|API Management Workspace API Product Manager | workspace | Has read access to entities in the workspace and read and write access to products, subscriptions, groups, and email notifications recipients. |
52-
| API Management Service Workspace Member | service | Has read access to tags and products and write access to allow:<br/><br/> ▪️ Assigning APIs to products<br/> ▪️ Assigning tags to products and APIs |
53-
| API Management Service Workspace API Product Manager | service | Has the same access as API Management Service Workspace Member as well as read access to users and write access to allow assigning users to groups. |
52+
| API Management Workspace API Developer | service | Has read access to tags and products and write access to allow:<br/><br/> ▪️ Assigning APIs to products<br/> ▪️ Assigning tags to products and APIs |
53+
| API Management Service Workspace API Product Manager | service | Has the same access as API Management Workspace API Developer as well as read access to users and write access to allow assigning users to groups. |
5454

5555

5656
## Custom roles

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ Set up a [workspace](workspaces-overview.md) (preview) to enable a decentralized
1616
[!INCLUDE [api-management-availability-premium-dev-standard](../../includes/api-management-availability-premium-dev-standard.md)]
1717

1818
> [!NOTE]
19-
> Workspaces are supported in API Management REST API version 2022-09-01-preview or later.
19+
> * Workspaces are a preview feature of API Management and subject to certain [limitations](workspaces-overview.md#preview-limitations).
20+
> * This feature is being released during March and April 2023.
21+
> * Workspaces are supported in API Management REST API version 2022-09-01-preview or later.
22+
> * For pricing considerations, see [API Management pricing](https://azure.microsoft.com/pricing/details/api-management/).
2023
2124
## Prerequisites
2225

@@ -38,7 +41,7 @@ The new workspace appears in the list on the **Workspaces** page. Select the wor
3841

3942
After creating a workspace, assign permissions to users to manage the workspace's resources. Each workspace user must be assigned a workspace-specific RBAC role at the service level and at the workspace level, or granted equivalent permissions using custom roles.
4043

41-
At minimum, assign an *administrator* of the workspace. Optionally, assign permissions to other workspace collaborators.
44+
At minimum, assign an *owner* of the workspace. Optionally, assign permissions to other workspace collaborators.
4245

4346
* For a list of built-in workspace roles, see [How to use role-based access control in API Management](api-management-role-based-access-control.md).
4447
* For steps to assign a role, see [Assign Azure roles using the portal](../role-based-access-control/role-assignments-portal.md?tabs=current).
@@ -50,23 +53,23 @@ At minimum, assign an *administrator* of the workspace. Optionally, assign permi
5053

5154
1. In the left menu, select **Access control (IAM)** > **+ Add**.
5255

53-
1. Assign the administrator the following role:
56+
1. Assign the owner the following role:
5457
* **API Management Service Workspace API Product Manager**
5558

5659
1. Assign one of the following roles to other members of the workspace:
57-
* **API Management Service Workspace Member**
60+
* **API Management Workspace API Developer**
5861
* **API Management Service Workspace API Product Manager**
5962

6063
### Assign a workspace-level role
6164

6265
1. In the menu for your API Management instance, select **Workspaces (preview)** > the name of the workspace that you created.
6366
1. In the **Workspace** window, select **Access control (IAM)**> **+ Add**.
6467

65-
1. Assign the administrator the following role:
68+
1. Assign the owner the following role:
6669

6770
* **API Management Workspace Owner**
6871

69-
1. Optionally, assign one of the following workspace-level roles to other workspace members to manage workspace APIs and other resources. The administrator of the workspace can also assign workspace-level roles.
72+
1. Optionally, assign one of the following workspace-level roles to other workspace members to manage workspace APIs and other resources. The owner of the workspace can also assign workspace-level roles.
7073

7174
* **API Management Workspace Reader**
7275
* **API Management Workspace Contributor**

articles/api-management/workspaces-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: dlepow
77

88
ms.service: api-management
99
ms.topic: conceptual
10-
ms.date: 03/07/2023
10+
ms.date: 03/10/2023
1111
ms.author: danlep
1212
ms.custom:
1313
---
@@ -31,11 +31,11 @@ An organization that manages APIs using Azure API Management may have multiple d
3131

3232
The following is a sample workflow for creating and using a workspace.
3333

34-
1. A central API platform team that manages the API Management instance creates a workspace and assigns its administrators and workspace members.
34+
1. A central API platform team that manages the API Management instance creates a workspace and assigns its owners and workspace members.
3535

3636
1. A central API platform team uses DevOps tools to create a DevOps pipeline for APIs in that workspace.
3737

38-
1. Workspace administrators assign permissions to workspace members using RBAC roles - for example, permissions to create or read resources in the workspace.
38+
1. Workspace owners assign permissions to workspace members using RBAC roles - for example, permissions to create or read resources in the workspace.
3939

4040
1. Workspace members develop, publish, productize, and maintain APIs in the workspace.
4141

@@ -94,7 +94,7 @@ Workspace members must be assigned both a service-level role and a workspace-lev
9494
* API gateways, including scaling, locations, and self-hosted gateways
9595

9696

97-
* **Resource references** - Resources in a workspace can reference other resources in the workspace and, in certain cases, resources from the service level. They can't reference resources from another workspace.
97+
* **Resource references** - Resources in a workspace can reference other resources in the workspace and the following resources from the service level: products, tags, and users. They can't reference resources from another workspace.
9898

9999
For security reasons, it's not possible to reference service-level resources from workspace-level policies (for example, named values) or by resource names, such as `backend-id` in the [set-backend-service](set-backend-service-policy.md) policy.
100100

0 commit comments

Comments
 (0)