Skip to content

Commit 10d5abd

Browse files
committed
[APIM] Updated platform migration - VNet injection
1 parent 32401ae commit 10d5abd

File tree

3 files changed

+22
-14
lines changed

3 files changed

+22
-14
lines changed
51.6 KB
Loading

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

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66
ms.service: api-management
77
ms.custom:
88
ms.topic: how-to
9-
ms.date: 05/15/2024
9+
ms.date: 06/14/2024
1010
ms.author: danlep
1111
---
1212

@@ -67,18 +67,22 @@ You can also migrate to the `stv2` platform by enabling [zone redundancy](../rel
6767
6868
### Update network configuration
6969

70-
You can use the Azure portal or other Azure tools such to migrate to a new subnet in the same or a different VNet. The following image shows a high level overview of what happens during migration to a new subnet.
70+
You can use the Azure portal to migrate to a new subnet in the same or a different VNet. The following image shows a high level overview of what happens during migration to a new subnet.
7171

7272
:::image type="content" source="media/migrate-stv1-to-stv2-vnet/inplace-new-subnet.gif" alt-text="Diagram of in-place migration to a new subnet.":::
7373

74-
For example, to use the portal:
74+
#### [Portal](#tab/portal)
7575

76-
1. In the [portal](https://portal.azure.com), navigate to your API Management instance.
77-
1. In the left menu, select **Network** > **Virtual network**.
78-
1. Select the network connection in the location you want to update.
79-
1. Select the virtual network and subnet you want to configure. Optionally select a new public IP. Select **Apply**.
80-
1. Continue configuring VNet settings for the remaining locations of your API Management instance.
81-
1. In the top navigation bar, select **Save**.
76+
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
77+
1. In the left menu, under **Settings**, select **Platform migration**.
78+
1. On the **Platform migration** page, in **Step 1**, review migration requirements and prerequisites.
79+
1. In **Step 2**, select a location to migrate. Select the **Virtual network**, **Subnet**, and optional **Public IP** you want to migrate to.
80+
:::image type="content" source="media/migrate-stv1-to-stv2-vnet/select-location.png" alt-text="Screenshot of selecting network migration settings in the portal." lightbox="media/migrate-stv1-to-stv2-vnet/select-location.png":::
81+
82+
1. In **Step 3**, confirm you want to migrate, and select **Migrate**.
83+
1. If your API Management instance is deployed in multiple regions, continue migrating VNet settings for the remaining locations of your instance.
84+
85+
---
8286

8387
After you update the VNet configuration, 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.
8488

@@ -109,7 +113,11 @@ The following image shows a high level overview of what happens during migration
109113
1. In the [portal](https://portal.azure.com), navigate to your original VNet.
110114
1. In the left menu, select **Subnets**, and then the original subnet.
111115
1. Verify that the original IP addresses were released by API Management. Under **Available IPs**, note the number of IP addresses available in the subnet. All addresses (except for Azure reserved addresses) should be available. If necessary, wait for IP addresses to be released.
112-
1. Repeat the migration steps in the [preceding section](#trigger-migration-of-a-network-injected-api-management-instance). In each region, specify the original VNet and subnet. Optionally select a new public IP.
116+
1. Navigate to your API Management instance.
117+
1. In the left menu, under **Network**, select **Virtual network**.
118+
1. Select the network connection in the location you want to update.
119+
1. Select the original VNet network and subnet. Optionally select a new public IP. Select **Apply**.
120+
1. If your API Management instance is deployed in multiple regions, continue configuring VNet settings for the remaining locations of your instance.
113121
1. In the top navigation bar, select **Save**.
114122

115123
After you update the VNet configuration, 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.
@@ -158,11 +166,11 @@ After you update the VNet configuration, the status of your API Management insta
158166

159167
- **How to confirm that the migration is complete and successful?**
160168

161-
The migration is considered complete and successful when the status in the overview page reads **Online** along with the platform version being either `stv2` or `stv2.1`. Also verify that the network status in the network blade shows green for all required connectivity.
169+
The migration is considered complete and successful when the status in the **Overview** page reads **Online** along with the platform version being either `stv2` or `stv2.1`. Also verify that the network status in the **Network** blade shows green for all required connectivity.
162170

163171
- **Can I do the migration using the portal?**
164172

165-
Yes, VNet-injected instances can be migrated by changing the subnet configuration(s) in the **Network** blade.
173+
Yes, VNet-injected instances can be migrated by changing the subnet configuration(s) in the **Platform migration** blade.
166174

167175
- **Can I preserve the IP address of the instance?**
168176

@@ -201,7 +209,7 @@ After you update the VNet configuration, the status of your API Management insta
201209

202210
- **My stv1 instance is deployed to multiple Azure regions (multi-region). How do I upgrade to stv2?**
203211

204-
Multi-region deployments include more managed gateways deployed in other locations. Each location should be migrated separately by providing a new subnet and a new public IP (required when enabling zone redundancy). Navigate to the **Locations** blade and perform the changes on each listed location. The instance is considered migrated to the new platform only when all the locations are migrated. All regional gateways continue to operate normally throughout the migration process.
212+
Multi-region deployments include more managed gateways deployed in other locations. Migrate each location separately by updating network settings in sequence - for example, using the **Platform migration** blade. The instance is considered migrated to the new platform only when all the locations are migrated. All regional gateways continue to operate normally throughout the migration process.
205213

206214

207215
- **Can I upgrade my stv1 instance to the same subnet?**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ There are two different migration scenarios, depending on whether or not your AP
2424

2525
* [**Scenario 1: Migrate a non-VNet-injected API Management instance**](migrate-stv1-to-stv2-no-vnet.md) - Migrate your instance to the `stv2` platform using the portal or the [Migrate to stv2](/rest/api/apimanagement/current-ga/api-management-service/migratetostv2) REST API.
2626

27-
* [**Scenario 2: Migrate a VNet-injected API Management instance**](migrate-stv1-to-stv2-vnet.md) - Migrate your instance to the `stv2` platform by updating the VNet configuration settings
27+
* [**Scenario 2: Migrate a VNet-injected API Management instance**](migrate-stv1-to-stv2-vnet.md) - Migrate your instance to the `stv2` platform by updating the VNet configuration settings using the portal.
2828

2929
## Alternative: Side-by-side deployment
3030

0 commit comments

Comments
 (0)