Skip to content

Commit 0b9ee7a

Browse files
committed
review comments
1 parent 91407ee commit 0b9ee7a

File tree

3 files changed

+23
-32
lines changed

3 files changed

+23
-32
lines changed

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,6 @@ If the value of the `platformVersion` property of your service is `stv1`, it's h
3838

3939
Support for API Management instances hosted on the `stv1` platform will be retired by 31 August 2024.
4040

41-
## What happens after 31 August 2024?
42-
43-
[TBD...]
44-
4541
## What do I need to do?
4642

4743
**Migrate all your existing instances hosted on the `stv1` compute platform to the `stv2` compute platform by 31 August 2024.**

articles/api-management/breaking-changes/stv1-platform-retirement-sovereign-clouds-february-2025.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,6 @@ If the value of the `platformVersion` property of your service is `stv1`, it's h
3838

3939
In Azure Government and Azure operated by 21Vianet, support for API Management instances hosted on the `stv1` platform will be retired by 28 February 2025.
4040

41-
## What happens after 28 February 2025?
42-
43-
[TBD...]
44-
4541
## What do I need to do?
4642

4743
**Migrate all your existing instances hosted on the `stv1` compute platform to the `stv2` compute platform by 28 February 2025.**

articles/api-management/migrate-stv1-to-stv2-vnet.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,29 @@ author: dlepow
66
ms.service: azure-api-management
77
ms.custom:
88
ms.topic: how-to
9-
ms.date: 08/09/2024
9+
ms.date: 08/13/2024
1010
ms.author: danlep
1111
---
1212

1313
# Migrate a VNet-injected API Management instance hosted on the stv1 platform to stv2
1414

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

17-
This article provides steps to migrate an API Management instance hosted on the `stv1` compute platform in-place to the `stv2` platform when the instance is injected (deployed) in an [external](api-management-using-with-vnet.md) or [internal](api-management-using-with-internal-vnet.md) VNet. For this scenario, migrate your instance using platform migration options in the Azure portal or the [Migrate to stv2](/rest/api/apimanagement/current-ga/api-management-service/migratetostv2) REST API. [Find out if you need to do this](compute-infrastructure.md#how-do-i-know-which-platform-hosts-my-api-management-instance).
17+
This article provides steps to migrate an API Management instance hosted on the `stv1` compute platform in-place to the `stv2` platform when the instance is injected (deployed) in an [external](api-management-using-with-vnet.md) or [internal](api-management-using-with-internal-vnet.md) VNet. [Find out if you need to do this](compute-infrastructure.md#how-do-i-know-which-platform-hosts-my-api-management-instance).
18+
19+
For this scenario, you have the following migration options:
20+
21+
* Use the [Migrate to stv2](/rest/api/apimanagement/current-ga/api-management-service/migratetostv2) REST API. The REST API migrates the instance in-place using the instances's existing subnet configuration. Currently, for instances in external mode, you can also choose to preserve the instance's VIP address (or addresses) during migration.
22+
23+
* Use the **Platform migration** blade in the Azure portal. Currently, using the portal, you migrate your instance in-place but must specify a different subnet in the same or a different VNet. After migration, optionally migrate back to the instance's original subnet. The migration process changes the VIP address(es) of the instance. After migration, you need to update any network dependencies including DNS, firewall rules, and VNets to use the new VIP address(es).
1824

1925
If you need to migrate a *non-VNnet-injected* API Management hosted on the `stv1` platform, see [Migrate a non-VNet-injected API Management instance to the stv2 platform](migrate-stv1-to-stv2-no-vnet.md).
2026

2127
[!INCLUDE [api-management-migration-alert](../../includes/api-management-migration-alert.md)]
2228

29+
2330
> [!CAUTION]
2431
> * Migrating your API Management instance to the `stv2` platform is a long-running operation.
25-
> * For certain migration options, the VIP address(es) of your API Management instance will change. After migration, you'll need to update any network dependencies including DNS, firewall rules, and VNets to use the new VIP address(es). Plan your migration accordingly.
2632
> * Migration to `stv2` is not reversible.
2733
2834

@@ -54,14 +60,24 @@ API Management platform migration from `stv1` to `stv2` involves updating the un
5460

5561
[!INCLUDE [api-management-publicip-internal-vnet](../../includes/api-management-publicip-internal-vnet.md)]
5662

57-
## Migrate the instance to stv2 platform
63+
## Migrate the instance using the REST API
5864

59-
Platform migration options are available in the Azure portal or the [Migrate to stv2](/rest/api/apimanagement/current-ga/api-management-service/migratetostv2) REST API.
65+
With the Migrate to stv2 REST API, you migrate your API Management instance to the `stv2` platform using the original subnet configuration, simplifying your migration. You can choose whether the API Management instance's original VIP address is preserved (recommended) or whether a new VIP address will be generated.
6066

67+
> [!IMPORTANT]
68+
> Currently, the option to preserve the VIP address when migrating using the REST API is only available for VNet-injected services in the *external* mode, not in the internal mode.
6169
62-
#### [Portal](#tab/portal)
70+
* **Preserve IP address** - If you preserve the VIP address, API requests will be unresponsive for approximately 15 minutes while the IP address is migrated to the new infrastructure. Infrastructure configuration (such as custom domains, locations, and CA certificates) will be locked for 45 minutes. No further configuration is required after migration.
6371

64-
Using the Azure portal, you currently migrate your instance by specifying a different subnet in the same or a different VNet. After migration, you can optionally migrate back to the original subnet you used.
72+
* **New virtual IP address** - If you choose this option, API Management generates a new VIP address for your instance. API requests remain responsive during migration. Infrastructure configuration (such as custom domains, locations, and CA certificates) will be locked for 30 minutes. After migration, you'll need to update any network dependencies including DNS, firewall rules, and VNets to use the new VIP address.
73+
74+
75+
[!INCLUDE [api-management-migration-cli-steps](../../includes/api-management-migration-cli-steps.md)]
76+
77+
78+
## Migrate the instance using the portal
79+
80+
Using the Azure portal, you migrate your instance by specifying a different subnet in the same or a different VNet. After migration, optionally migrate back to the instance's original subnet.
6581

6682
The following image shows a high level overview of what happens during migration to a new subnet.
6783

@@ -84,23 +100,6 @@ The following image shows a high level overview of what happens during migration
84100
1. In **Step 3**, confirm you want to migrate, and select **Migrate**.
85101
The status of your API Management instance changes to **Updating**. The migration process takes approximately 45 minutes to complete. When the status changes to **Online**, migration is complete.
86102

87-
88-
#### [CLI](#tab/cli)
89-
90-
With the Migrate to stv2 REST API, you migrate your API Management instance to the `stv2` platform using the original subnet configuration, simplifying your migration. You can choose whether the API Management instance's original VIP address is preserved (recommended) or whether a new VIP address will be generated.
91-
92-
> [!IMPORTANT]
93-
> Currently, the option to preserve the VIP address when migrating using the REST API is only available for VNet-injected services in the *external* mode, not in the internal mode.
94-
95-
* **Preserve IP address** - If you preserve the VIP address, API requests will be unresponsive for approximately 15 minutes while the IP address is migrated to the new infrastructure. Infrastructure configuration (such as custom domains, locations, and CA certificates) will be locked for 45 minutes. No further configuration is required after migration.
96-
97-
* **New virtual IP address** - If you choose this option, API Management generates a new VIP address for your API requests remain responsive during migration. Infrastructure configuration (such as custom domains, locations, and CA certificates) will be locked for 30 minutes. After migration, you'll need to update any network dependencies including DNS, firewall rules, and VNets to use the new VIP address.
98-
99-
100-
[!INCLUDE [api-management-migration-cli-steps](../../includes/api-management-migration-cli-steps.md)]
101-
102-
---
103-
104103
If your API Management instance is deployed in multiple regions, repeat the preceding steps to continue migrating VNet settings for the remaining locations of your instance.
105104

106105

0 commit comments

Comments
 (0)