Skip to content

Commit e163797

Browse files
committed
[APIM] Workspaces changes - migration
1 parent 6c96924 commit e163797

File tree

1 file changed

+42
-4
lines changed

1 file changed

+42
-4
lines changed

articles/api-management/breaking-changes/workspaces-breaking-changes-june-2024.md

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ services: api-management
55
author: dlepow
66
ms.service: api-management
77
ms.topic: reference
8-
ms.date: 04/24/2024
8+
ms.date: 05/08/2024
99
ms.author: danlep
1010
---
1111

1212
# Workspaces - breaking changes (June 2024)
1313

1414
[!INCLUDE [api-management-availability-premium-dev-standard](../../../includes/api-management-availability-premium-dev-standard.md)]
1515

16-
On 14 June 2024, as part of our development of [workspaces](../workspaces-overview.md) (preview) in Azure API Management, we're introducing several breaking changes.
16+
After 14 June 2024, as part of our development of [workspaces](../workspaces-overview.md) (preview) in Azure API Management, we're introducing several breaking changes.
1717

18-
Your workspaces and APIs managed in them may stop working beyond 14 June 2024 if they still rely on the capabilities set to change. APIs and resources managed outside workspaces aren't affected by this change.
18+
After 14 June 2024, your workspaces and APIs managed in them may stop working if they still rely on the capabilities set to change. APIs and resources managed outside workspaces aren't affected by this change.
1919

2020
## Is my service affected by these changes?
2121

@@ -58,7 +58,45 @@ The `context.Workspace` object can be used instead.
5858
5959
## What is the deadline for the change?
6060

61-
The breaking changes are effective 14 June 2024. We strongly recommend that you make all required changes to the configuration of workspaces before then.
61+
The breaking changes will be introduced after 14 June 2024. We strongly recommend that you make all required changes to the configuration of workspaces before that date.
62+
63+
## What do I need to do?
64+
65+
If your workspaces are affected by these changes, you need to update your workspace configurations to align with the new capabilities.
66+
67+
### Standard tier customers
68+
69+
If you're using workspaces in the **Standard** tier, [upgrade](../upgrade-and-scale.md) to the **Premium** tier to continue using workspaces.
70+
71+
### Developer tier customers
72+
73+
The Developer tier was designed for single-user or single-team use cases. It's unable to facilitate multi-team collaboration with workspaces because of the limited computing resources, lack of SLA, and no infrastructure redundancy. If you're using workspaces preview in the **Developer** tier, you can choose one of the following options:
74+
75+
* **Aggregate in a Premium tier instance**
76+
77+
Aggregate multiple non-production environments in a single Premium tier instance. Use workspaces in the Premium tier to isolate the different environments.
78+
79+
* **Use Developer tier instances for development, migrate to workspaces in Premium tier**
80+
81+
You might use Developer tier instances for development environments. For higher environments, you can migrate the configuration of these Developer-tier services into workspaces of a Premium tier service. Note that with this approach you may run into issues or conflicts when managing the configurations across environments.
82+
83+
If you are currently using workspaces in a Developer tier instance, you can migrate the workspace configurations to a Developer tier instance without workspaces:
84+
85+
1. Export a Resource Manager template from your API Management instance. You can export the template from the [Azure portal](..azure-resource-manager/templates/export-template-portal.md) or by using other tools.
86+
1. Remove the following substring of the resource ID values: `/workspaces/[^/]+`
87+
1. Deploy the template. For more information, see [Quickstart: Create and deploy ARM templates by using the Azure portal](../azure-resource-manager/templates/quickstart-create-templates-use-the-portal.md).
88+
89+
Depending on your use case, you may need to perform additional configuration changes in your API Management instance.
90+
91+
### Assignment of workspace-level entities
92+
93+
If you assigned workspace-level entities to service-level entities in the workspaces preview, see the following table for migration guidance.
94+
95+
|Assignment no longer supported |Recommended migration step |
96+
|---------|---------|
97+
|Assign workspace APIs to service-level products | Use workspace-level products |
98+
|Assign workspace APIs or products to service-level tags | Use workspace-level tags |
99+
|Assign service-level groups to workspace products for visibility controls | |
62100

63101
## Help and support
64102

0 commit comments

Comments
 (0)