Skip to content

Commit 9aa4ee1

Browse files
authored
Merge pull request #273323 from dlepow/apiverret
[APIM] API version retirement
2 parents c799cb0 + 1c575d3 commit 9aa4ee1

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

articles/api-management/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@
643643
href: breaking-changes/metrics-retirement-aug-2023.md
644644
- name: Virtual network changes (September 2023)
645645
href: breaking-changes/rp-source-ip-address-change-sep-2023.md
646-
- name: API version retirements (September 2023)
646+
- name: API version retirements (June 2024)
647647
href: breaking-changes/api-version-retirement-sep-2023.md
648648
- name: Self-hosted gateway v0/v1 retirements (October 2023)
649649
href: breaking-changes/self-hosted-gateway-v0-v1-retirement-oct-2023.md

articles/api-management/breaking-changes/api-version-retirement-sep-2023.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,31 @@
11
---
2-
title: Azure API Management - API version retirements (September 2023) | Microsoft Docs
3-
description: The Azure API Management service is retiring all API versions prior to 2021-08-01. If you use one of these API versions, you must update your tools, scripts, or programs to use the latest versions.
2+
title: Azure API Management - API version retirements (June 2024) | Microsoft Docs
3+
description: Starting June 1, 2024, the Azure API Management service is retiring all API versions prior to 2021-08-01. If you use one of these API versions, you must update affected tools, scripts, or programs to use the latest versions.
44
services: api-management
55
author: dlepow
66
ms.service: api-management
77
ms.topic: reference
8-
ms.date: 11/06/2023
8+
ms.date: 04/26/2024
99
ms.author: danlep
1010
---
1111

12-
# API version retirements (September 2023)
12+
# API version retirements (June 2024)
1313

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

1616
Azure API Management uses Azure Resource Manager (ARM) to configure your API Management instances. The API version is embedded in your use of templates that describe your infrastructure, tools that are used to configure the service, and programs that you write to manage your Azure API Management services.
1717

18-
On 30 September 2023, all API versions for the Azure API Management service prior to **2021-08-01** will be retired and API calls using those API versions will fail. This means you'll no longer be able to create or manage your API Management services using your existing templates, tools, scripts, and programs until they've been updated. Data operations (such as accessing the APIs or Products configured on Azure API Management) will be unaffected by this update, including after 30 September 2023.
19-
20-
From now through 30 September 2023, you can continue to use the templates, tools, and programs without impact. You can transition to API version 2021-08-01 or later at any point prior to 30 September 2023.
18+
Starting June 1, 2024, all API versions for the Azure API Management service prior to [**2021-08-01**](/rest/api/apimanagement/operation-groups?view=rest-apimanagement-2021-08-01) are being retired (disabled). The previously communicated retirement date was September 30, 2023. At any time after June 1, 2024, API calls using an API version prior to 2021-08-01 may fail without further notice. You'll no longer be able to create or manage your API Management services with existing templates, tools, scripts, and programs using a retired API version until they've been updated to use API version 2021-08-01 or later. Data plane operations (such as mediating API requests in the gateway) will be unaffected by this update, including after June 1, 2024.
2119

2220
## Is my service affected by this?
2321

24-
While your service isn't affected by this change, any tool, script, or program that uses the Azure Resource Manager (such as the Azure CLI, Azure PowerShell, Azure API Management DevOps Resource Kit, or Terraform) to interact with the API Management service is affected by this change. You'll be unable to run those tools successfully unless you update the tools.
22+
While your service isn't affected by this change, any tool, script, or program that uses the Azure Resource Manager (such as the Azure CLI, Azure PowerShell, Azure API Management DevOps Resource Kit, or Terraform) to interact with the API Management service and calls an API Management API version prior to 2021-08-01 is affected by this change. After an API version is retired, you'll be unable to run any affected tools successfully unless you update the tools.
2523

2624
## What is the deadline for the change?
2725

28-
The affected API versions will no longer be valid after 30 September 2023.
26+
The affected API versions will be retired gradually starting June 1, 2024.
2927

30-
After 30 September 2023, if you prefer not to update your tools, scripts, and programs, your services will continue to run but you won't be able to add or remove APIs, change API policy, or otherwise configure your API Management service.
28+
After an API version is retired, if you prefer not to update your affected tools, scripts, and programs, your services will continue to run. However, you won't be able to add or remove APIs, change API policy, or otherwise configure your API Management service with affected tools.
3129

3230
## Required action
3331

@@ -48,7 +46,7 @@ We also recommend setting the **Minimum API version** in your API Management ins
4846
* API Management DevOps Resource Kit: 1.0.0
4947
* Terraform azurerm provider: 3.0.0
5048

51-
* **Azure SDKs** - Update the Azure API Management SDKs to the latest versions (or later):
49+
* **Azure SDKs** - Update the Azure API Management SDKs to the latest versions or at least the following versions:
5250
* .NET: 8.0.0
5351
* Go: 1.0.0
5452
* Python: 3.0.0
@@ -57,18 +55,21 @@ We also recommend setting the **Minimum API version** in your API Management ins
5755

5856
### Update Minimum API version setting on your API Management instance
5957

60-
We recommend setting the **Minimum API version** for your API Management instance using the Azure portal. This setting limits control plane API calls to your instance with an API version equal to or newer than this value. Currently you can set this to **2021-08-01**.
58+
We recommend setting the **Minimum API version** for your API Management instance using the Azure portal. This setting limits control plane API calls to your instance to an API version equal to or newer than this value. By setting this value to **2021-08-01**, you can assess the impact of the API version retirements on your tooling.
59+
60+
6161

6262
To set the **Minimum API version** in the portal:
6363

6464
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
6565
1. In the left menu, under **Deployment + infrastructure**, select **Management API**.
6666
1. Select the **Management API settings** tab.
67-
1. Under **Prevent users with read-only permissions from accessing service secrets**, select **Yes**. The **Minimum API version** appears.
67+
1. Under **Enforce minimum API version**, select **Yes**. The **Minimum API version** appears.
6868
1. Select **Save**.
6969

7070
## More information
7171

72+
* [Supported API Management API versions](/rest/api/apimanagement/operation-groups)
7273
* [Azure CLI](/cli/azure/update-azure-cli)
7374
* [Azure PowerShell](/powershell/azure/install-azure-powershell)
7475
* [Azure Resource Manager](../../azure-resource-manager/management/overview.md)
@@ -78,5 +79,4 @@ To set the **Minimum API version** in the portal:
7879

7980
## Related content
8081

81-
See all [upcoming breaking changes and feature retirements](overview.md).
82-
82+
See all [upcoming breaking changes and feature retirements](overview.md).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The following table lists all the upcoming breaking changes and feature retireme
2121
| [Resource provider source IP address updates][bc1] | March 31, 2023 |
2222
| [Metrics retirements][metrics2023] | August 31, 2023 |
2323
| [Resource provider source IP address updates][rp2023] | September 30, 2023 |
24-
| [API version retirements][api2023] | September 30, 2023 |
24+
| [API version retirements][api2023] | June 1, 2024 |
2525
| [Deprecated (legacy) portal retirement][devportal2023] | October 31, 2023 |
2626
| [Self-hosted gateway v0/v1 retirement][shgwv0v1] | October 1, 2023 |
2727
| [Workspaces breaking changes][workspaces2024] | June 14, 2024 |

0 commit comments

Comments
 (0)