Set up a workspace

  • Article

Availability

Important

This feature is available only in the Premium tier of API Management.

Set up a workspace (preview) to enable a decentralized API development team to manage and productize their own APIs, while a central API platform team maintains the API Management infrastructure. After you create a workspace and assign permissions, workspace collaborators can create and manage their own APIs, products, subscriptions, and related resources.

Note

  • Workspaces are a preview feature of API Management and subject to certain limitations.
  • Workspaces are supported in API Management REST API version 2022-09-01-preview or later.
  • For pricing considerations, see API Management pricing.

Prerequisites

  • An API Management instance. If you need to, create one.

Create a workspace - portal

  1. Sign in to the Azure portal, and navigate to your API Management instance.

  2. In the left menu, select Workspaces (preview) > + Add. Screenshot of creating an API Management workspace in the portal.

  3. In the Create workspace window, enter a descriptive Name, resource Id, and optional Description for the workspace. Select Save.

The new workspace appears in the list on the Workspaces page. Select the workspace to manage its settings and resources.

Assign users to workspace - portal

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

Note

For easier management, set up Microsoft Entra groups to assign workspace permissions to multiple users.

Assign a service-scoped role

  1. Sign in to the Azure portal, and navigate to your API Management instance.

  2. In the left menu, select Access control (IAM) > + Add.

  3. Assign one of the following service-scoped roles to each member of the workspace:

    • API Management Service Workspace API Developer
    • API Management Service Workspace API Product Manager

Assign a workspace-scoped role

  1. In the menu for your API Management instance, select Workspaces (preview) > the name of the workspace that you created.

  2. In the Workspace window, select Access control (IAM)> + Add.

  3. Assign one of the following workspace-scoped roles to the workspace members to manage workspace APIs and other resources.

    • API Management Workspace Reader
    • API Management Workspace Contributor
    • API Management Workspace API Developer
    • API Management Workspace API Product Manager

Migrate resources to a workspace

The open source Azure API Management workspaces migration tool can help you with the initial setup of resources in the workspace. Use the tool to migrate selected service-level APIs with their dependencies from an Azure API Management instance to a workspace.

Next steps