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-no-vnet.md
+8-16Lines changed: 8 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,11 +29,12 @@ If you need to migrate a *VNnet-injected* API Management hosted on the `stv1` pl
29
29
30
30
API Management platform migration from `stv1` to `stv2` involves updating the underlying compute alone and has no impact on the service/API configuration persisted in the storage layer. For an instance that's not deployed in a VNet:
31
31
32
-
* The upgrade process involves creating a new compute in parallel to the old compute. The old compute takes 15-45 mins to be deleted.
33
-
* The API Management status in the portal will be **Updating**.
34
32
* You can choose whether the VIP address of the instance will change, or whether the original VIP address is preserved.
35
-
* Azure manages the management endpoint DNS, and updates to the new compute immediately on successful migration.
36
-
* The gateway and portal DNS points to the new compute immediately.
33
+
* The upgrade process involves creating a new compute in parallel to the old compute.
34
+
* The API Management status in the portal will be **Updating**.
35
+
* If you choose to preserve the VIP address, migration includes an additional step of moving the VIP from the old compute to the new compute during which the APIs will be unresponsive.
36
+
* Azure manages the management endpoint DNS, and updates to the new compute immediately on successful migration.
37
+
* The default gateway and portal DNS point to the new compute immediately.
37
38
* If you choose to have your API Management instance receive a new VIP address, you'll need to update network dependencies to use the new VIP address.
38
39
39
40
## Prerequisites
@@ -111,11 +112,11 @@ After successful migration to a new VIP address, update any network dependencies
111
112
112
113
-**What are the prerequisites for the migration?**
113
114
114
-
For non-VNet-injected instances, no prerequisites are required. If you migrate preserving your public IP address, this will render your API Management instance unresponsive for approximately 15 minutes. If you can't afford any downtime, then choose the **New virtual IP address** option that makes API Management available on a new IP. Network dependencies need to be updated with the new public virtual IP address.
115
+
For non-VNet-injected instances, no prerequisites are required. If you migrate preserving your public IP address, this will render your API Management instance unresponsive for approximately 15 minutes. There may not be a downtime if you choose the **New virtual IP address** option that makes API Management available on a new IP. Instances configured with a custom domain using an A record and/or having network dependencies on the public virtual IP address will have a downtime when a new virtual IP address is requested.
115
116
116
117
-**Will the migration cause a downtime?**
117
118
118
-
For non-VNet-injected instances, there's a downtime of approximately 15 minutes only if you choose to preserve the original IP address. However, there's no downtime if you migrate with a new IP address.
119
+
For non-VNet-injected instances, there's a downtime of approximately 15 minutes only if you choose to preserve the original IP address. However, there's no downtime if you migrate with a new IP address and have no network dependencies on the new IP. Network dependencies include custom domain name without a CNAME, IP allow–listing, firewall rules, and VNets.
119
120
120
121
-**Can data or configuration losses occur by/during the migration?**
121
122
@@ -165,15 +166,6 @@ After successful migration to a new VIP address, update any network dependencies
165
166
166
167
For an API Management that's not inject in a VNet, follow the [migration steps](#migrate-the-instance-to-stv2-platform) using the portal or the Azure CLI. All the regions will be migrated to `stv2`.
167
168
168
-
169
-
170
-
-**Can I test the new gateway before switching the live traffic?**
171
-
172
-
- By default, the old and the new managed gateways coexist for 15 mins, which is a small window of time to validate the deployment.
173
-
- The migration process automatically updates the default domain names, and if being used, the traffic routes to the new gateways immediately.
174
-
- If custom domain names are in use, the corresponding DNS records might need to be updated with the new IP address if not using CNAME. Customers can update their hosts file to the new API Management IP and validate the instance before making the switch. During this validation process, the old gateway continues to serve the live traffic.
175
-
176
-
177
169
-**What should we consider for self-hosted gateways?**
178
170
179
171
You don't need to do anything in your self-hosted gateways. You just need to migrate API Management instances running in Azure that are impacted by the `stv1` platform retirement. Note that there could be a new IP for the Configuration endpoint of the API Management instance, and any networking restrictions pinned to the IP should be updated.
@@ -184,7 +176,7 @@ After successful migration to a new VIP address, update any network dependencies
184
176
185
177
-**Is there any impact on cost once we migrated to stv2?**
186
178
187
-
The billing model remains the same for `stv2` and there won't be any more cost incurred after the migration.
179
+
The billing model remains the same for `stv2` and there won't be any more cost incurred during and after the migration.
188
180
189
181
-**What RBAC permissions are required for the stv1 to stv2 migration?**
Copy file name to clipboardExpand all lines: articles/api-management/migrate-stv1-to-stv2-vnet.md
+18-12Lines changed: 18 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ API Management platform migration from `stv1` to `stv2` involves updating the un
38
38
* For an instance in internal VNet mode, customer manages the DNS, so the DNS entries continue to point to old compute until updated by the customer.
39
39
* It's the DNS that points to either the new or the old compute and hence no downtime to the APIs.
40
40
* Changes are required to your firewall rules, if any, to allow the new compute subnet to reach the backends.
41
-
*. After successful migration, the old compute is automatically decommissioned after approximately 15 minutes by default, with an option to delay it for up to 48 hours. *The 48 hour delay option is only available for VNet-injected services.**The 48 hour delay option is only available for VNet-injected services.*
41
+
* After successful migration, the old compute is automatically decommissioned after approximately 15 minutes by default, with an option to delay it for up to 48 hours. *The 48 hour delay option is only available for VNet-injected services.*
42
42
43
43
## Prerequisites
44
44
@@ -48,11 +48,14 @@ API Management platform migration from `stv1` to `stv2` involves updating the un
48
48
49
49
* A Standard SKU [public IPv4 address](../virtual-network/ip-services/public-ip-addresses.md#sku) resource in the same region(s) and subscription as your API Management instance. For details, see [Prerequisites for network connections](api-management-using-with-vnet.md#prerequisites).
50
50
51
-
> [!IMPORTANT]
52
-
> When you update the VNet configuration for migration to the `stv2` platform, you must provide a public IP address address resource (or resources, if your API Management is deployed to multiple Azure regions), or migration won't succeed. In internal VNet mode, this public IP address is used only for Azure internal management operations and doesn't expose your gateway to the internet.
51
+
> [!IMPORTANT]
52
+
> When you update the VNet configuration for migration to the `stv2` platform, you must provide a public IP address resource (or resources, if your API Management is deployed to multiple Azure regions), or migration won't succeed. In internal VNet mode, this public IP address is used only for Azure internal management operations and doesn't expose your gateway to the internet. Public backends may see the instance's public VIP as the caller IP.
53
53
54
-
* (Optional) Contact Azure support to request that the original service infrastructure is maintained in parallel for up to 48 hours after successful migration. This option extends the period when the old infrastructure is available after migration beyond the default of 15 minutes before it is purged. This option is available only for VNet-injected services to allow service owners to update network settings and test applications to use the new infrastructure.
54
+
* (Optional) Contact Azure support to request that the original service infrastructure is maintained in parallel for up to 48 hours after successful migration. This option extends the period when the old infrastructure is available after migration beyond the default of 15 minutes before it is purged. This option is available only for VNet-injected services to allow service owners to update network settings and test applications to use the new infrastructure. This extension request applies to all API Management instances in a subscription.
55
55
56
+
> [!NOTE]
57
+
> If you plan to migrate your VNet-injected API Management instance back to the original subnet after migration, we recommend that you don't request the 48-hour extension.
58
+
56
59
57
60
## Trigger migration of a network-injected API Management instance
58
61
@@ -65,7 +68,7 @@ You can also migrate to the `stv2` platform by enabling [zone redundancy](../rel
65
68
66
69
### Update network configuration
67
70
68
-
You can use the Azure portal or other Azure tools such to migrate to a new VNet and subnet. The following image shows a high level overview of what happens during migration to a new VNet and subnet.
71
+
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.
69
72
70
73
:::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.":::
71
74
@@ -80,20 +83,23 @@ For example, to use the portal:
80
83
81
84
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.
82
85
83
-
## (Optional) Migrate back to original VNet and subnet
86
+
## (Optional) Migrate back to original subnet
84
87
85
-
You can optionally migrate back to the original VNet and subnet you used in each region before migration to the `stv2` platform. To do so, update the VNet configuration again, this time specifying the original VNet and subnet in each region. As in the preceding migration, expect a long-running operation, and expect the VIP address to change.
88
+
You can optionally migrate back to the original subnet you used in each region before migration to the `stv2` platform. To do so, update the VNet configuration again, this time specifying the original VNet and subnet in each region. As in the preceding migration, expect a long-running operation, and expect the VIP address to change.
86
89
87
-
The following image shows a high level overview of what happens during migration back to the original VNet and subnet.
90
+
The following image shows a high level overview of what happens during migration back to the original subnet.
88
91
89
92
:::image type="content" source="media/migrate-stv1-to-stv2-vnet/inplace-old-subnet.gif" alt-text="Diagram of in-place migration back to original subnet.":::
90
93
91
94
> [!IMPORTANT]
92
-
> If the VNet and subnet are locked (because other `stv1` platform-based API Management instances are deployed there) or the resource group where the original VNet is deployed has a [resource lock](../azure-resource-manager/management/lock-resources.md), make sure to remove the lock before migrating back to the original VNet and subnet. Wait for lock removal to complete before attempting the migration to the original subnet. [Learn more](api-management-using-with-internal-vnet.md#challenges-encountered-in-reassigning-api-management-instance-to-previous-subnet).
95
+
> If the VNet and subnet are locked (because other `stv1` platform-based API Management instances are deployed there) or the resource group where the original VNet is deployed has a [resource lock](../azure-resource-manager/management/lock-resources.md), make sure to remove the lock before migrating back to the original subnet. Wait for lock removal to complete before attempting the migration to the original subnet. [Learn more](api-management-using-with-internal-vnet.md#challenges-encountered-in-reassigning-api-management-instance-to-previous-subnet).
96
+
97
+
> [!NOTE]
98
+
> If you plan to migrate back to the original subnet, we recommend that you don't request the 48-hour extension on your subscription for maintaining the old infrastructure; otherwise, your migration will be delayed. If you need to cancel an extension, contact Azure support.
93
99
94
100
### Additional prerequisites
95
101
96
-
* The original subnet and VNet, in each region where the API Management instance is deployed. A network security group must be attached to the subnet, and [NSG rules](api-management-using-with-vnet.md#configure-nsg-rules) for API Management must be configured.
102
+
* The unlocked original subnet, in each region where the API Management instance is deployed. A network security group must be attached to the subnet, and [NSG rules](api-management-using-with-vnet.md#configure-nsg-rules) for API Management must be configured.
97
103
98
104
* A new Standard SKU [public IPv4 address](../virtual-network/ip-services/public-ip-addresses.md#sku) resource in the same region(s) and subscription as your API Management instance.
99
105
@@ -200,7 +206,7 @@ After you update the VNet configuration, the status of your API Management insta
200
206
201
207
-**Do we need a public IP even if the API Management instance is VNet injected in internal mode only?**
202
208
203
-
API Management `stv1` uses an Azure managed public IP even in an internal mode for management traffic. However, `stv2` requires a usermanaged public IP for the same purpose. This public IP is only used for Azure internal management operations and doesn't expose your instance to the internet. More details [here](./api-management-howto-ip-addresses.md#ip-addresses-of-api-management-service-in-vnet).
209
+
API Management `stv1` uses an Azure managed public IP even in an internal mode for management traffic. However, `stv2` requires a user-managed public IP for the same purpose. This public IP is only used for Azure internal management operations and doesn't expose your instance to the internet. Public(internet-facing) backends may see the instance's public IP as the origin of the request. More details [here](./api-management-howto-ip-addresses.md#ip-addresses-of-api-management-service-in-vnet).
204
210
205
211
-**Can I upgrade my stv1 instance to the same subnet?**
206
212
@@ -230,7 +236,7 @@ After you update the VNet configuration, the status of your API Management insta
230
236
231
237
-**Is there any impact on cost once we migrated to stv2?**
232
238
233
-
The billing model remains the same for `stv2` and there won't be any more cost incurred after the migration.
239
+
The billing model remains the same for `stv2` and there won't be any more cost incurred during and after the migration.
234
240
235
241
-**What RBAC permissions are required for the stv1 to stv2 migration?**
0 commit comments