Skip to content

Commit 3370c15

Browse files
authored
Merge pull request #209388 from dlepow/release-apim-retirement-200209
[APIM] stv1 platform and SHGW v0/v1 retirement
2 parents db3de0d + 624a108 commit 3370c15

File tree

4 files changed

+127
-3
lines changed

4 files changed

+127
-3
lines changed

articles/api-management/TOC.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,8 @@
440440
href: breaking-changes/rp-source-ip-address-change-sep-2023.md
441441
- name: API version retirements (September 2023)
442442
href: breaking-changes/api-version-retirement-sep-2023.md
443+
- name: Self-hosted gateway v0/v1 retirements (October 2023)
444+
href: breaking-changes/self-hosted-gateway-v0-v1-retirement-oct-2023.md
443445
- name: Deprecated (legacy) developer portal (October 2023)
444446
items:
445447
- name: Deprecated portal - customize the portal
@@ -470,6 +472,8 @@
470472
href: api-management-page-templates.md
471473
- name: Template resources
472474
href: api-management-template-resources.md
475+
- name: stv1 compute platform retirement (August 2024)
476+
href: breaking-changes/stv1-platform-retirement-august-2024.md
473477
- name: ADAL-based identity provider retirement (September 2025)
474478
href: breaking-changes/identity-provider-adal-retirement-sep-2025.md
475479
- name: CAPTCHA endpoint update (September 2025)
@@ -481,4 +485,4 @@
481485
- name: Stack Overflow
482486
href: https://stackoverflow.com/questions/tagged/azure-api-management
483487
- name: Additional resources
484-
href: https://aka.ms/apimlove
488+
href: https://aka.ms/apimlove

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: adrianhall
77

88
ms.service: api-management
99
ms.topic: reference
10-
ms.date: 07/25/2022
10+
ms.date: 09/07/2022
1111
ms.author: adhal
1212
---
1313

@@ -21,6 +21,8 @@ The following table lists all the upcoming breaking changes and feature retireme
2121
| [Resource provider source IP address updates][rp2023] | September 30, 2023 |
2222
| [API version retirements][api2023] | September 30, 2023 |
2323
| [Deprecated (legacy) portal retirement][devportal2023] | October 2023 |
24+
| [Self-hosted gateway v0/v1 retirement][shgwv0v1] | October 1, 2023 |
25+
| [stv1 platform retirement][stv12024] | August 31, 2024 |
2426
| [ADAL-based Azure AD or Azure AD B2C identity provider retirement][msal2025] | September 30, 2025 |
2527
| [CAPTCHA endpoint update][captcha2025] | September 30, 2025 |
2628

@@ -29,5 +31,7 @@ The following table lists all the upcoming breaking changes and feature retireme
2931
[rp2023]: ./rp-source-ip-address-change-sep-2023.md
3032
[api2023]: ./api-version-retirement-sep-2023.md
3133
[devportal2023]: ../api-management-customize-styles.md
34+
[shgwv0v1]: ./self-hosted-gateway-v0-v1-retirement-oct-2023.md
35+
[stv12024]: ./stv1-platform-retirement-august-2024.md
3236
[msal2025]: ./identity-provider-adal-retirement-sep-2025.md
33-
[captcha2025]: ./captcha-endpoint-change-sep-2025.md
37+
[captcha2025]: ./captcha-endpoint-change-sep-2025.md
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Azure API Management - Self-hosted gateway v0/v1 retirement (October 2023) | Microsoft Docs
3+
description: Azure API Management is retiring the v0 and v1 versions of the self-hosted gateway container image, effective 1 October 2023. If you've deployed one of these versions, you must migrate to the v2 version of the self-hosted gateway.
4+
services: api-management
5+
documentationcenter: ''
6+
author: dlepow
7+
ms.service: api-management
8+
ms.topic: reference
9+
ms.date: 09/06/2022
10+
ms.author: danlep
11+
---
12+
13+
# Support ending for Azure API Management self-hosted gateway version 0 and version 1 container images (October 2023)
14+
15+
The [self-hosted gateway](../self-hosted-gateway-overview.md) is an optional, containerized version of the default managed gateway included in every API Management service. On 1 October 2023 we're removing support for the v0 and v1 versions of the self-hosted gateway container image. If you've deployed the self-hosted gateway using either of these container images, you need to take the steps below to continue using the self-hosted gateway by migrating to the v2 container image and configuration API.
16+
17+
## Is my service affected by this?
18+
19+
Your service is affected by this change if:
20+
21+
* Your service is in the Developer or Premium service tier.
22+
* You have deployed a self-hosted gateway using the version v0 or v1 of the self-hosted gateway [container image](../self-hosted-gateway-migration-guide.md#using-the-new-configuration-api).
23+
24+
## What is the deadline for the change?
25+
26+
**Support for the v1 configuration API and for the v0 and v1 container images of the self-hosted gateway will retire on 1 October 2023.**
27+
28+
Version 2 of the configuration API and container image is already available, and includes the following improvements:
29+
30+
* A new configuration API that removes the dependency on Azure Storage, unless you're using request tracing or quotas.
31+
32+
* New container images, and new container image tags to let you choose the best way to try our gateway and deploy it in production.
33+
34+
If you are using version 0 or version 1 of the self-hosted gateway, you will need to manually migrate your container images to the newest v2 image and switch to the v2 configuration API.
35+
36+
## What do I need to do?
37+
38+
Migrate all your existing deployments of the self-hosted gateway using version 0 or version 1 to the newest v2 container image and v2 configuration API by 1 October 2023.
39+
40+
Follow the [migration guide](../self-hosted-gateway-migration-guide.md) for a successful migration.
41+
42+
## Help and support
43+
44+
If you have questions, get answers from community experts in [Microsoft Q&A](https://aka.ms/apim/retirement/shgwv0v1). 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).
45+
46+
1. For **Summary**, type a description of your issue, for example, "stv1 retirement".
47+
1. Under **Issue type**, select **Technical**.
48+
1. Under **Subscription**, select your subscription.
49+
1. Under **Service**, select **My services**, then select **API Management Service**.
50+
1. Under **Resource**, select the Azure resource that you’re creating a support request for.
51+
1. For **Summary**, type a description of your issue, for example, "v1/v0 retirement".
52+
1. For **Problem type**, select **Self-hosted gateway**.
53+
1. For **Problem subtype**, select **Administration, Configuration and Deployment**.
54+
55+
## Next steps
56+
57+
See all [upcoming breaking changes and feature retirements](overview.md).
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Azure API Management - stv1 platform retirement (August 2024) | Microsoft Docs
3+
description: Azure API Management is retiring the stv1 compute platform effective 31 August 2024. If your API Management instance is hosted on the stv1 platform, you must migrate to the stv2 platform.
4+
services: api-management
5+
documentationcenter: ''
6+
author: dlepow
7+
ms.service: api-management
8+
ms.topic: reference
9+
ms.date: 08/26/2022
10+
ms.author: danlep
11+
---
12+
13+
# stv1 platform retirement (August 2024)
14+
15+
As a cloud platform-as-a-service (PaaS), Azure API Management abstracts many details of the infrastructure used to host and run your service. **The infrastructure associated with the API Management `stv1` compute platform version will be retired effective 31 August 2024.** A more current compute platform version (`stv2`) is already available, and provides enhanced service capabilities.
16+
17+
The following table summarizes the compute platforms currently used for instances in the different API Management service tiers.
18+
19+
| Version | Description | Architecture | Tiers |
20+
| -------| ----------| ----------- | ---- |
21+
| `stv2` | Single-tenant v2 | Azure-allocated compute infrastructure that supports availability zones, private endpoints | Developer, Basic, Standard, Premium<sup>1</sup> |
22+
| `stv1` | Single-tenant v1 | Azure-allocated compute infrastructure | Developer, Basic, Standard, Premium |
23+
| `mtv1` | Multi-tenant v1 | Shared infrastructure that supports native autoscaling and scaling down to zero in times of no traffic | Consumption |
24+
25+
To take advantage of upcoming features, we're recommending that customers migrate their Azure API Management instances from the `stv1` compute platform to the `stv2` compute platform. The `stv2` compute platform comes with additional features and improvements such as support for Azure Private Link and other networking features.
26+
27+
New instances created in service tiers other than the Consumption tier are mostly hosted on the `stv2` platform already. Existing instances on the `stv1` compute platform will continue to work normally until the retirement date, but those instances won’t receive the latest features available to the `stv2` platform. Support for `stv1` instances will be retired by 31 August 2024.
28+
29+
## Is my service affected by this?
30+
31+
If the value of the `platformVersion` property of your service is `stv1`, it is hosted on the `stv1` platform. See [How do I know which platform hosts my API Management instance?](../compute-infrastructure.md#how-do-i-know-which-platform-hosts-my-api-management-instance)
32+
33+
## What is the deadline for the change?
34+
35+
Support for API Management instances hosted on the `stv1` platform will be retired by 31 August 2024.
36+
37+
After 31 August 2024, any instance hosted on the `stv1` platform won't be supported, and could experience system outages.
38+
39+
## What do I need to do?
40+
41+
**Migrate all your existing instances hosted on the `stv1` compute platform to the `stv2` compute platform by 31 August 2024.**
42+
43+
If you have existing instances hosted on the `stv1` platform, you can follow our [migration guide](../compute-infrastructure.md#how-do-i-migrate-to-the-stv2-platform) which provides all the details to ensure a successful migration.
44+
45+
## Help and support
46+
47+
If you have questions, get answers from community experts in [Microsoft Q&A](https://aka.ms/apim/retirement/stv1). 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).
48+
49+
1. For **Summary**, type a description of your issue, for example, "stv1 retirement".
50+
1. Under **Issue type**, select **Technical**.
51+
1. Under **Subscription**, select your subscription.
52+
1. Under **Service**, select **My services**, then select **API Management Service**.
53+
1. Under **Resource**, select the Azure resource that you’re creating a support request for.
54+
1. For **Problem type**, select **Administration and Management**.
55+
1. For **Problem subtype**, select **Upgrade, Scale or SKU Changes**.
56+
57+
## Next steps
58+
59+
See all [upcoming breaking changes and feature retirements](overview.md).

0 commit comments

Comments
 (0)