Skip to content

Commit 8c7c6d4

Browse files
Merge pull request #268193 from dlepow/marchret
[APIM] Breaking changes - March 2024
2 parents c6056d8 + 7dedd3d commit 8c7c6d4

File tree

6 files changed

+153
-6
lines changed

6 files changed

+153
-6
lines changed

articles/api-management/TOC.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@
643643
href: /azure/architecture/best-practices/api-design?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
644644
- name: Web API implementation
645645
href: /azure/architecture/best-practices/api-implementation?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
646-
- name: Breaking changes
646+
- name: Breaking changes and retirements
647647
items:
648648
- name: Breaking changes overview
649649
href: breaking-changes/overview.md
@@ -662,11 +662,18 @@
662662
- name: Workspaces breaking changes (June 2024)
663663
href: breaking-changes/workspaces-breaking-changes-june-2024.md
664664
- name: stv1 compute platform retirement (August 2024)
665-
href: breaking-changes/stv1-platform-retirement-august-2024.md
665+
- name: Git configuration retirement (March 2025)
666+
href: breaking-changes/git-configuration-retirement-march-2025.md
667+
- name: Direct management API retirement (March 2025)
668+
href: breaking-changes/direct-management-api-retirement-march-2025.md
669+
- name: ADAL-based identity provider retirement (September 2025)
670+
href: breaking-changes/git-configuration-retirement-march-2025.md
666671
- name: ADAL-based identity provider retirement (September 2025)
667672
href: breaking-changes/identity-provider-adal-retirement-sep-2025.md
668673
- name: CAPTCHA endpoint update (September 2025)
669674
href: breaking-changes/captcha-endpoint-change-sep-2025.md
675+
- name: Built-in analytics dashboard retirement (March 2027)
676+
href: breaking-changes/analytics-dashboard-retirement-march-2027.md
670677
- name: Regional availability
671678
href: https://azure.microsoft.com/global-infrastructure/services/
672679
- name: Microsoft Q&A question page
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Azure API Management - Analytics dashboard retirement (March 2027)
3+
description: Azure API Management is replacing the built-in API analytics dashboard as of March 2027. An equivalent dashboard is available based on an Azure Monitor Workbook.
4+
services: api-management
5+
author: dlepow
6+
ms.service: api-management
7+
ms.topic: reference
8+
ms.date: 05/16/2024
9+
ms.author: danlep
10+
---
11+
12+
# Built-in API analytics dashboard retirement (March 2027)
13+
14+
[!INCLUDE [premium-dev-standard-basic.md](../../../includes/api-management-availability-premium-dev-standard-basic.md)]
15+
16+
Effective 15 March 2027, the dashboard and reports associated with API Management built-in analytics will be retired. To replace them, a new version of API analytics has been introduced using Azure Monitor Log Analytics workbooks.
17+
18+
## Is my service affected by this?
19+
20+
The Premium, Standard, Basic, and Developer tiers of API Management provide a [built-in analytics dashboard](../howto-use-analytics.md#legacy-built-in-analytics) and reports ("legacy built-in analytics") for each API Management instance. As of early 2024, API Management also provides identical API analytics using an [Azure Monitor-based dashboard](../howto-use-analytics.md#azure-monitor-based-dashboard) that aggregates data in an Azure Log Analytics workspace. The Azure Monitor-based dashboard is now the recommended solution for viewing API Management analytics data in the portal.
21+
22+
## What is the deadline for the change?
23+
After 15 March 2027, the legacy built-in analytics will not be supported. Both the legacy built-in analytics and Azure Monitor-based analytics will be available in parallel for a period of time to allow for a smooth transition to the Azure Monitor-based implementation.
24+
25+
## What do I need to do?
26+
27+
From now through 15 March 2027, you will have access to both implementations in the Azure portal, featuring identical dashboards and reports. We recommend that you start using the Azure Monitor-based dashboard to view your API Management analytics data. To use the Azure Monitor-based dashboard, configure a Log Analytics workspace as a data source for API Management gateway logs. For more information, see [Tutorial: Monitor published APIs](../api-management-howto-use-azure-monitor.md).
28+
29+
When an option to do so becomes available, we recommend disabling the legacy analytics dashboard to improve the capacity performance of your API Management instance. We recommend pursuing this change proactively before the retirement date.
30+
31+
## Help and support
32+
33+
If you have questions, get answers from community experts in [Microsoft Q&A](/answers). If you have a support plan and you need technical help, create a [support request](https://portal.azure.com/#view/Microsoft_Azure_Support/HelpAndSupportBlade/~/overview).
34+
35+
1. Under **Issue type**, select **Technical**.
36+
1. Under **Subscription**, select your subscription.
37+
1. Under **Service**, select **My services**, then select **API Management Service**.
38+
1. Under **Resource**, select the Azure resource that you’re creating a support request for.
39+
1. For **Summary**, type a description of your issue, for example, "built-in analytics".
40+
41+
## Related content
42+
43+
See all [upcoming breaking changes and feature retirements](overview.md).
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Azure API Management - Direct management API retirement (March 2025)
3+
description: Azure API Management is retiring its direct management API as of March 2025. Use the Azure Resource Manager-based API instead.
4+
services: api-management
5+
author: dlepow
6+
ms.service: api-management
7+
ms.topic: reference
8+
ms.date: 05/16/2024
9+
ms.author: danlep
10+
---
11+
12+
# Direct management API retirement (March 2025)
13+
14+
[!INCLUDE [premium-dev-standard-basic.md](../../../includes/api-management-availability-premium-dev-standard-basic.md)]
15+
16+
Effective 15 March 2025, Azure API Management will retire its direct management REST API. If you enable and use the direct management API to configure and manage your API Management instance programmatically, migrate to use the standard Azure Resource Manager-based API instead.
17+
18+
## Is my service affected by this?
19+
20+
A built-in [direct management API](/rest/api/apimanagement/apimanagementrest/api-management-rest) to programmatically manage your API Management is disabled by default but can be enabled in the Premium, Standard, Basic, and Developer tiers of API Management. While your API Management instance isn't affected by this change, any tool, script, or program that uses the direct management API to interact with the API Management service is affected by this change. You'll be unable to run those tools successfully after the retirement date unless you update the tools to use the standard [Azure Resource Manager-based REST API](/rest/api/apimanagement) for API Management.
21+
22+
## What is the deadline for the change?
23+
24+
Support for the direct management API will no longer be available after 15 March 2025.
25+
26+
## What do I need to do?
27+
28+
From now through 15 March 2025, if you have enabled the direct management API, you can continue to use it normally. At any time before the retirement date, update your tools, scripts, and programs to use equivalent operations in the Azure Resource Manager-based REST API instead.
29+
30+
## Help and support
31+
32+
If you have questions, get answers from community experts in [Microsoft Q&A](/answers). If you have a support plan and you need technical help, create a [support request](https://portal.azure.com/#view/Microsoft_Azure_Support/HelpAndSupportBlade/~/overview).
33+
34+
1. Under **Issue type**, select **Technical**.
35+
1. Under **Subscription**, select your subscription.
36+
1. Under **Service**, select **My services**, then select **API Management Service**.
37+
1. Under **Resource**, select the Azure resource that you’re creating a support request for.
38+
1. For **Summary**, type a description of your issue, for example, "Direct management API".
39+
40+
## Related content
41+
42+
See all [upcoming breaking changes and feature retirements](overview.md).
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Azure API Management - Git configuration retirement (March 2025)
3+
description: Azure API Management is retiring configuration management using a built-in Git repo as of March 2025. If you use the feature, adopt a configuration management solution such as APIOps.
4+
services: api-management
5+
author: dlepow
6+
ms.service: api-management
7+
ms.topic: reference
8+
ms.date: 05/16/2024
9+
ms.author: danlep
10+
---
11+
12+
# Git configuration retirement (March 2025)
13+
14+
[!INCLUDE [api-management-availability-premium-dev-standard-basic](../../../includes/api-management-availability-premium-dev-standard-basic.md)]
15+
16+
Effective 15 March 2025, Azure API Management will retire the ability to manage the configuration of your service instance using the built-in Git repository. If you plan to continue using a Git repository to manage the configuration of your service instance after the retirement date, you must update your configuration management to use a different solution such as APIOps and your own Git repository implementation.
17+
18+
## Is my service affected by this?
19+
20+
A built-in [Git repository](../api-management-configuration-repository-git.md) to save and deploy service configuration information can be enabled in the Premium, Standard, Basic, and Developer tiers of API Management. While your API Management instance isn't affected by this change, you'll be unable to save and update your service configuration using API Management's built-in Git repository after the retirement date.
21+
22+
Other tools such as the Azure portal, REST APIs, and Azure Resource Manager templates will continue to be available for managing your API Management service configuration.
23+
24+
## What is the deadline for the change?
25+
26+
Support for the built-in Git repository will no longer be available after 15 March 2025.
27+
28+
## What do I need to do?
29+
30+
From now through 15 March 2025, if you have an existing Azure API Management instance using the Git repository, you can continue to use it normally. At any time before the retirement date, update your configuration management to use a different solution and tools based on Azure Resource Management-based REST APIs and Azure RBAC. For example, use a [devops and CI/CD](../devops-api-development-templates.md) solution such as [APIOps](https://github.com/Azure/apiops) to extract and manage API Management configuration in your own your Git repository implementation like GitHub or Azure DevOps Repositories.
31+
32+
After the retirement date, if you create an API Management instance, you won't be able to activate the Git repository feature to save or update your service configuration.
33+
34+
## Help and support
35+
36+
If you have questions, get answers from community experts in [Microsoft Q&A](/answers). If you have a support plan and you need technical help for the Git repository feature, create a [support request](https://portal.azure.com/#view/Microsoft_Azure_Support/HelpAndSupportBlade/~/overview):
37+
38+
1. Under **Issue type**, select **Technical**.
39+
1. Under **Subscription**, select your subscription.
40+
1. Under **Service**, select **My services**, then select **API Management Service**.
41+
1. Under **Resource**, select the Azure resource that you're creating a support request for.
42+
1. For **Summary**, type a description of your issue, for example, "Git repository".
43+
1. For **Problem type**, select **Configuration and Management**.
44+
1. For **Problem subtype**, select **Git Repository**.
45+
46+
For assistance with issues specific to APIOps, review [APIOps support documentation](https://github.com/Azure/apiops/blob/main/SUPPORT.md).
47+
48+
## Related content
49+
50+
See all [upcoming breaking changes and feature retirements](overview.md).

articles/api-management/breaking-changes/overview.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Upcoming Breaking Changes in Azure API Management | Microsoft Docs
3-
description: A list of all the upcoming breaking changes for Azure API Management
3+
description: A list of all the upcoming breaking changes and feature retirements for the Azure API Management service.
44
services: api-management
55
author: dlepow
66

77
ms.service: api-management
88
ms.topic: reference
9-
ms.date: 01/25/2024
9+
ms.date: 05/17/2024
1010
ms.author: danlep
1111
---
1212

@@ -26,8 +26,11 @@ The following table lists all the upcoming breaking changes and feature retireme
2626
| [Self-hosted gateway v0/v1 retirement][shgwv0v1] | October 1, 2023 |
2727
| [Workspaces breaking changes][workspaces2024] | June 14, 2024 |
2828
| [stv1 platform retirement][stv12024] | August 31, 2024 |
29+
| [Git repository retirement][git2025] | March 15, 2025 |
30+
| [Direct management API retirement][mgmtapi2025] | March 15, 2025 |
2931
| [ADAL-based Microsoft Entra ID or Azure AD B2C identity provider retirement][msal2025] | September 30, 2025 |
3032
| [CAPTCHA endpoint update][captcha2025] | September 30, 2025 |
33+
| [Built-in analytics dashboard retirement][analytics2027] | March 15, 2027 |
3134

3235
<!-- Links -->
3336
[bc1]: ./rp-source-ip-address-change-mar-2023.md
@@ -39,4 +42,7 @@ The following table lists all the upcoming breaking changes and feature retireme
3942
[msal2025]: ./identity-provider-adal-retirement-sep-2025.md
4043
[captcha2025]: ./captcha-endpoint-change-sep-2025.md
4144
[metrics2023]: ./metrics-retirement-aug-2023.md
45+
[git2025]: ./git-configuration-retirement-march-2025.md
46+
[analytics2027]: ./analytics-dashboard-retirement-march-2027.md
47+
[mgmtapi2025]: ./direct-management-api-retirement-march-2025.md
4248
[workspaces2024]: ./workspaces-breaking-changes-june-2024.md

articles/api-management/breaking-changes/stv1-platform-retirement-august-2024.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ If the value of the `platformVersion` property of your service is `stv1`, it's h
3636
Support for API Management instances hosted on the `stv1` platform will be retired by 31 August 2024.
3737

3838
> [!WARNING]
39-
> * After 31 August 2024, any instance hosted on the `stv1` platform will be shut down, and the instance won't respond to API requests.
40-
> * Data from a shut-down instance will be backed up by Azure. The owner may trigger restoration of the instance on the `stv2` platform, but the instance will remain shut down until then.
39+
> If your instance is currently hosted on the `stv1` platform, you must migrate to the `stv2` platform. Failure to migrate by the retirement date might result in loss of the environments running APIs and all configuration data.
4140
4241

4342
## What do I need to do?

0 commit comments

Comments
 (0)