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/migrate-stv1-to-stv2-vnet.md
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,11 +18,9 @@ This article provides steps to migrate an API Management instance hosted on the
18
18
19
19
For this scenario, you have the following migration options:
20
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. You can choose whether the API Management instance's original VIP address(es) is preserved (recommended) or whether a new VIP address will be generated.
21
+
*[**Migrate using the REST API**](#migrate-the-instance-using-the-rest-api---keep-same-subnet-configuration) - The Migrate to stv2 REST API migrates the instance in-place and keeps the instances's existing subnet configuration. You can choose whether the API Management instance's original VIP address(es) is preserved (recommended) or whether a new VIP address will be generated.
22
22
23
-
With this option, the `stv1` compute is deleted permanently after the migration is complete, with no option to retain it temporarily.
24
-
25
-
* Use the **Platform migration** blade in the Azure portal. Currently, using the 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. 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).
23
+
*[**Migrate using the portal**](#migrate-the-instance-using-the-portal) - Currently, using the **Platform migration** blade in 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. 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).
26
24
27
25
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).
28
26
@@ -88,7 +86,7 @@ You can choose whether the API Management instance's original VIP address is pre
88
86
89
87
***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.
90
88
91
-
With this option, the `stv1` compute is retained for approximately 1 hour after migration is complete so that you can validate the migrated instance and confirm the network and DNS configuration. Optionally, set a custom retention time by setting using the [REST API](/rest/api/apimanagement/api-management-service/create-or-update).
89
+
With this option, the `stv1` compute is retained for 1 hour by default after migration is complete so that you can validate the migrated instance and confirm the network and DNS configuration. Optionally, set a [custom retention time](#set-custom-retention-time-for-stv1-compute).
92
90
93
91
If your API Management instance is deployed in multiple regions, the REST API migrates the VNet settings for all locations of your instance.
94
92
@@ -100,7 +98,7 @@ API Management pre-creates public IP addresses for the migration process. Find t
100
98
* When you migrate and preserve the VIP address, the pre-created IP address is assigned temporarily to the new `stv2` deployment during migration. The pre-created IP address is released after the migration is complete and the original IP address is assigned to the `stv2` deployment.
101
99
* When you migrate and generate a new VIP address, the pre-created IP address is assigned to the new `stv2` deployment during migration and persists after migration is complete.
102
100
103
-
You can configure the pre-created IP address to serve runtime traffic during migration and, in the case of migration to a new IP address, afterward. For example, whitelist the pre-created IP address in your firewall rules to allow traffic to the new `stv2` deployment during migration.
101
+
You can configure the pre-created IP address to serve runtime traffic during migration and, in the case of migration to a new IP address, afterward. For example, allow-list the pre-created IP address in your firewall rules to allow traffic to the new `stv2` deployment during migration.
104
102
-->
105
103
106
104
### Limitations and considerations for same-subnet migration
@@ -116,7 +114,7 @@ When migrating a VNet-injected instance keeping the same subnet configuration, m
|External | Preserve VIP | No downtime; traffic is served on a temporary IP address for up to 20 minutes during migration to the new `stv2` deployment | No retention |
119
-
|External | New VIP | No downtime<br/><br/>New IP address can be used to serve runtime traffic| Retained for configurable period to allow you to update network dependencies |
117
+
|External | New VIP | No downtime | Retained for configurable period to allow you to update network dependencies |
120
118
|Internal | Preserve VIP | Downtime for approximately 20 minutes during migration when the existing IP address is assigned to the new `stv2` deployment. | No retention |
121
119
|Internal | New VIP | No downtime | Retained for configurable period to allow you to update network dependencies |
122
120
@@ -265,7 +263,7 @@ After you update the VNet configuration, the status of your API Management insta
265
263
266
264
- **Can I preserve the IP address of the instance?**
267
265
268
-
Currently, you can preserve the IP address only when migrating by using the [Migrate to stv2 REST API](#migrate-the-instance-using-the-rest-api).
266
+
Currently, you can preserve the IP address only when migrating by using the [Migrate to stv2 REST API](#migrate-the-instance-using-the-rest-api---keep-same-subnet-configuration).
269
267
270
268
- **Is there a migration path without modifying the existing instance?**
271
269
@@ -305,7 +303,7 @@ After you update the VNet configuration, the status of your API Management insta
305
303
306
304
- **Can I upgrade my stv1 instance to the same subnet?**
307
305
308
-
- Currently, you can only upgrade to the same subnet in a single pass when using the [Migrate to stv2 REST API](#migrate-the-instance-using-the-rest-api).
306
+
- Currently, you can only upgrade to the same subnet in a single pass when using the [Migrate to stv2 REST API](#migrate-the-instance-using-the-rest-api---keep-same-subnet-configuration).
309
307
310
308
Currently, if you use the **Platform migration** blade in the portal, you need to migrate to a new subnet and then migrate back to the original subnet:
311
309
- The old gateway takes between 15 mins to 45 mins to vacate the subnet, so that you can initiate the move. However, you can enable a migration setting to retain the old gateway for 48 hours.
Copy file name to clipboardExpand all lines: articles/api-management/migrate-stv1-to-stv2.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ ms.author: danlep
16
16
17
17
Here we help you find guidance to migrate your API Management instance hosted on the `stv1` compute platform to the newer `stv2` platform. [Find out if you need to do this](compute-infrastructure.md#how-do-i-know-which-platform-hosts-my-api-management-instance).
18
18
19
-
There are two different in-place migration scenarios, depending on whether or not your API Management instance is currently deployed (injected) in a VNet (either external mode or internal mode). Choose the migration guide for your scenario.
19
+
There are two different in-place migration scenarios, depending on whether or not your API Management instance is currently deployed (injected) in a VNet. Choose the migration guide for your scenario.
Copy file name to clipboardExpand all lines: includes/api-management-migration-cli-steps.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ ms.date: 08/09/2024
6
6
ms.author: danlep
7
7
---
8
8
9
-
Run the following Azure CLI commands, setting variables where indicated with the name of your API Management instance and the name of the resource group in which it was created.
9
+
Run the following Azure CLI commands to call the Migrate to stv2 API, setting variables where indicated with the name of your API Management instance and the name of the resource group in which it was created.
10
10
11
11
> [!NOTE]
12
12
> The following script is written for the bash shell. To run the script in PowerShell, prefix the variable name with the `$` character when setting the variables. Example: `$APIM_NAME=...`.
0 commit comments