Skip to content

Commit 0317917

Browse files
committed
[APIM] Preserve IP during stv2 migration
1 parent 04edc78 commit 0317917

File tree

1 file changed

+8
-24
lines changed

1 file changed

+8
-24
lines changed

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

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66
ms.service: api-management
77
ms.custom: devx-track-azurecli
88
ms.topic: how-to
9-
ms.date: 10/18/2023
9+
ms.date: 01/11/2024
1010
ms.author: danlep
1111
---
1212

@@ -52,26 +52,17 @@ API Management platform migration from `stv1` to `stv2` involves updating the un
5252

5353
For an API Management instance that's not deployed in a VNet, migrate your instance using the **Platform migration** blade in the Azure portal, or invoke the Migrate to `stv2` REST API.
5454

55-
You can choose whether the virtual IP address of API Management will change, or whether the original VIP address is preserved.
55+
During the migration, the VIP address of your API Management instance will be preserved.
5656

57-
* **New virtual IP address (recommended)** - If you choose this mode, 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.
58-
59-
* **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.
57+
* API requests will be unresponsive for approximately 15 minutes while the IP address is migrated to the new infrastructure.
58+
* Infrastructure configuration (such as custom domains, locations, and CA certificates) will be locked for 45 minutes.
59+
* No further configuration is required after migration.
6060

6161
#### [Portal](#tab/portal)
6262

6363
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
6464
1. In the left menu, under **Settings**, select **Platform migration**.
65-
1. On the **Platform migration** page, select one of the two migration options:
66-
67-
* **New virtual IP address (recommended)**. The VIP address of your API Management instance will change automatically. Your service will have no downtime, but after migration you'll need to update any network dependencies including DNS, firewall rules, and VNets to use the new VIP address.
68-
69-
* **Preserve IP address** - The VIP address of your API Management instance won't change. Your instance will have downtime for up to 15 minutes.
70-
71-
:::image type="content" source="media/migrate-stv1-to-stv2/platform-migration-portal.png" alt-text="Screenshot of API Management platform migration in the portal.":::
72-
73-
1. Review guidance for the migration process, and prepare your environment.
74-
65+
1. On the **Platform migration** page, review guidance for the migration process, and prepare your environment.
7566
1. After you've completed preparation steps, select **I have read and understand the impact of the migration process.** Select **Migrate**.
7667

7768
#### [Azure CLI](#tab/cli)
@@ -102,22 +93,15 @@ RG_NAME={name of your resource group}
10293
# Get resource ID of API Management instance
10394
APIM_RESOURCE_ID=$(az apim show --name $APIM_NAME --resource-group $RG_NAME --query id --output tsv)
10495
105-
# Call REST API to migrate to stv2 and change VIP address
106-
az rest --method post --uri "$APIM_RESOURCE_ID/migrateToStv2?api-version=2023-03-01-preview" --body '{"mode": "NewIp"}'
107-
108-
# Alternate call to migrate to stv2 and preserve VIP address
109-
# az rest --method post --uri "$APIM_RESOURCE_ID/migrateToStv2?api-version=2023-03-01-preview" --body '{"mode": "PreserveIp"}'
96+
# Call REST API to migrate to stv2 and preserve VIP address
97+
az rest --method post --uri "$APIM_RESOURCE_ID/migrateToStv2?api-version=2023-03-01-preview" --body '{"mode": "PreserveIp"}'
11098
```
11199
---
112100

113101
### Verify migration
114102

115103
To verify that the migration was successful, when the status changes to `Online`, check the [platform version](compute-infrastructure.md#how-do-i-know-which-platform-hosts-my-api-management-instance) of your API Management instance. After successful migration, the value is `stv2`.
116104

117-
### Update network dependencies
118-
119-
On successful migration, update any network dependencies including DNS, firewall rules, and VNets to use the new VIP address.
120-
121105
## Scenario 2: Migrate a network-injected API Management instance
122106

123107
Trigger migration of a network-injected API Management instance to the `stv2` platform by updating the existing network configuration to use new network settings (see the following section). After that update completes, as an optional step, you can migrate back to the original VNet and subnet you used.

0 commit comments

Comments
 (0)