You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/breaking-changes/api-version-retirement-sep-2023.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,33 +1,31 @@
1
1
---
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.
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.
17
17
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.
21
19
22
20
## Is my service affected by this?
23
21
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.
25
23
26
24
## What is the deadline for the change?
27
25
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.
29
27
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.
31
29
32
30
## Required action
33
31
@@ -48,7 +46,7 @@ We also recommend setting the **Minimum API version** in your API Management ins
48
46
* API Management DevOps Resource Kit: 1.0.0
49
47
* Terraform azurerm provider: 3.0.0
50
48
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:
52
50
* .NET: 8.0.0
53
51
* Go: 1.0.0
54
52
* Python: 3.0.0
@@ -57,18 +55,21 @@ We also recommend setting the **Minimum API version** in your API Management ins
57
55
58
56
### Update Minimum API version setting on your API Management instance
59
57
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
+
61
61
62
62
To set the **Minimum API version** in the portal:
63
63
64
64
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
65
65
1. In the left menu, under **Deployment + infrastructure**, select **Management API**.
66
66
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.
68
68
1. Select **Save**.
69
69
70
70
## More information
71
71
72
+
*[Supported API Management API versions](/rest/api/apimanagement/operation-groups)
0 commit comments