Skip to content

Commit 74279c7

Browse files
committed
update migration guidance
1 parent 335206d commit 74279c7

File tree

2 files changed

+22
-37
lines changed

2 files changed

+22
-37
lines changed
Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Azure API Management compute platform
3-
description: Learn about the compute platform used to host your API Management service instance
3+
description: Learn about the compute platform used to host your API Management service instance. Instances in the dedicated service tiers of API Management are hosted on the stv1 or stv2 compute platform.
44
author: dlepow
55
ms.service: api-management
66
ms.topic: conceptual
7-
ms.date: 03/09/2023
7+
ms.date: 04/17/2023
88
ms.author: danlep
99
ms.custom:
1010
---
@@ -22,11 +22,11 @@ The following table summarizes the compute platforms currently used for instance
2222

2323
| Version | Description | Architecture | Tiers |
2424
| -------| ----------| ----------- | ---- |
25-
| `stv2`, `stv2.1` | Single-tenant v2 | Azure-allocated VM infrastructure that supports availability zones, private endpoints<br/><br/>`stv2.1` provides upgraded VM infrastructure with greater unit performance<br/><br/>See [What are the benefits of the `stv2` platform?](#what-are-the-benefits-of-the-stv2-platform) | Developer, Basic, Standard, Premium<sup>1</sup> |
25+
| `stv2` | Single-tenant v2 | Azure-allocated compute infrastructure that supports added resiliency and security features. See [What are the benefits of the `stv2` platform?](#what-are-the-benefits-of-the-stv2-platform) in this article. | Developer, Basic, Standard, Premium<sup>1</sup> |
2626
| `stv1` | Single-tenant v1 | Azure-allocated compute infrastructure | Developer, Basic, Standard, Premium |
2727
| `mtv1` | Multi-tenant v1 | Shared infrastructure that supports native autoscaling and scaling down to zero in times of no traffic | Consumption |
2828

29-
<sup>1</sup> Newly created instances in these tiers and some existing instances in Developer and Premium tiers configured with virtual networks or availability zones. Hosting on higher performance `stv2.1` platform is provided subject to regional availability and capacity.
29+
<sup>1</sup> Newly created instances in these tiers and some existing instances in Developer and Premium tiers configured with virtual networks or availability zones.
3030

3131
> [!NOTE]
3232
> Currently, the `stv2` platform isn't available in the US Government cloud or in the following Azure regions: China East, China East 2, China North, China North 2.
@@ -39,8 +39,8 @@ You can find the platform version of your instance using the portal, the API Man
3939

4040
To find the platform version in the portal:
4141

42-
1. Go to your API Management instance.
43-
1. On the **Overview** page, the **Platform Version** is displayed.
42+
1. Sign in to the [portal](https://portal.azure.com) and go to your API Management instance.
43+
1. On the **Overview** page, under **Essentials**, the **Platform Version** is displayed.
4444

4545
:::image type="content" source="media/compute-infrastructure/platformversion-property.png" alt-text="Screenshot of the API Management platform version in the portal.":::
4646

@@ -52,29 +52,15 @@ The `stv2` platform infrastructure supports several resiliency and security feat
5252
* [Private endpoints](private-endpoint.md)
5353
* [Protection with Azure DDoS](protect-with-ddos-protection.md)
5454

55-
### Additional benefits of `stv2.1` platform
56-
Starting in March 2023, API Management is introducing the `stv2.1` platform with the capabilities of the `stv2` platform along with upgraded CPU and memory resources.
57-
58-
This compute upgrade in `stv2.1` provides several benefits to API Management customers:
59-
60-
* Increased performance per API Management scale unit, at no additional cost
61-
* Increased unit capacity, as measured by the capacity metric
62-
* Reduced times to provision and scale out instances
63-
64-
The `stv2.1` infrastructure is being introduced over time to Azure regions and is provided to customers based on available capacity. Instances that are updated will show a `platformVersion` value of `stv2.1`.
6555

6656
## How do I migrate to the `stv2` platform?
6757

6858
> [!IMPORTANT]
6959
> Support for API Management instances hosted on the `stv1` platform will be [retired by 31 August 2024](breaking-changes/stv1-platform-retirement-august-2024.md). To ensure proper operation of your API Management instance, you should migrate any instance hosted on the `stv1` platform to `stv2` before that date.
7060
71-
Migration steps depend on features enabled in your API Management instance. For details, see the [migration guidance](migrate-stv1-to-stv2.md):
72-
73-
* **Non-VNet-injected API Management instance** - Use the [Migrate to stv2](/rest/api/apimanagement/current-preview/api-management-service/migratetostv2) REST API
74-
75-
* **VNet-injected API Management instance** - Update the VNet connection, or enable zone redundancy
61+
Migration steps depend on features enabled in your API Management instance. If the instance isn't injected in a VNet, you can use a migration API. For instances that are VNet-injected, follow manual steps. For details, see the [migration guide](migrate-stv1-to-stv2.md).
7662

7763
## Next steps
7864

79-
* Learn more about using a [virtual network](virtual-network-concepts.md) with API Management.
80-
* Learn more about enabling [availability zones](../reliability/migrate-api-mgt.md).
65+
* [Migrate an API Management instance to the stv2 platform](migrate-stv1-to-stv2.md).
66+
* Learn more about [upcoming breaking changes](breaking-changes/overview.md) in API Management.

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

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Follow the steps in this article to migrate your Azure API Manageme
55
author: dlepow
66
ms.service: api-management
77
ms.topic: how-to
8-
ms.date: 03/09/2023
8+
ms.date: 04/17/2023
99
ms.author: danlep
1010

1111
---
@@ -14,14 +14,15 @@ ms.author: danlep
1414

1515
You can migrate an API Management instance hosted on the `stv1` compute platform to the `stv2` platform. This article provides migration steps for two scenarios, depending on whether or not your API Management instance is currently deployed (injected) in an [external](api-management-using-with-vnet.md) or [internal](api-management-using-with-internal-vnet.md) VNet.
1616

17-
* **Non-VNet-injected API Management instance** - Use the [Migrate to stv2](/rest/api/apimanagement/current-preview/api-management-service/migratetostv2) REST API
17+
* **Non-VNet-injected API Management instance** - Use the [Migrate to stv2](/rest/api/apimanagement/current-ga/api-management-service/migratetostv2) REST API
1818

19-
* **VNet-injected API Management instance** - Update the VNet connection, or enable zone redundancy
19+
* **VNet-injected API Management instance** - Manually update the VNet configuration settings
2020

2121
For more information about the `stv1` and `stv2` platforms and the benefits of using the `stv2` platform, see [Compute platform for API Management](compute-infrastructure.md).
2222

2323
> [!IMPORTANT]
24-
> * Migration is a long-running operation and could take several minutes to complete. Your instance will experience downtime during the migration.
24+
> * Migration is a long-running operation. Your instance will experience downtime during the last 10-15 minutes of migration. Plan your migration accordingly.
25+
> * The VIP address(es) of your API Management will change.
2526
> * Migration to `stv2` is not reversible.
2627
2728
> [!IMPORTANT]
@@ -61,20 +62,22 @@ RG_NAME={name of your resource group}
6162
APIM_RESOURCE_ID=$(az apim show --name $APIM_NAME --resource-group $RG_NAME --query id --output tsv)
6263
6364
# Call REST API to migrate to stv2
64-
az rest --method post --uri "$APIM_RESOURCE_ID/migrateToStv2?api-version=2022-04-01-preview"
65+
az rest --method post --uri "$APIM_RESOURCE_ID/migrateToStv2?api-version=2022-08-01"
6566
```
6667

6768
## Scenario 2: Migrate a network-injected API Management instance
6869

69-
Trigger migration of a network-injected API Management instance to the `stv2` platform by updating the existing network configuration (see the following section), or enable [zone redundancy](../reliability/migrate-api-mgt.md).
70+
Trigger migration of a network-injected API Management instance to the `stv2` platform by updating the existing network configuration (see the following section). You can also cause migrate to the `stv2` platform by enabling [zone redundancy](../reliability/migrate-api-mgt.md).
7071

7172
### Update VNet configuration
7273

74+
Update the configuration of the VNet in each location (region) where the API Management instance is deployed.
75+
7376
#### Prerequisites
7477

75-
* A new or existing virtual network and subnet in the same region and subscription as your API Management instance. The subnet must be different from the one currently used for the instance hosted on the `stv1` platform, and a network security group must be attached.
78+
* A new subnet in the current virtual network. (Alternatively, set up a subnet in a different virtual network in the same region and subscription as your API Management instance). A network security group must be attached to the subnet.
7679

77-
* A new or existing Standard SKU [public IPv4 address](../virtual-network/ip-services/public-ip-addresses.md#sku) resource in the same region and subscription as your API Management instance.
80+
* A Standard SKU [public IPv4 address](../virtual-network/ip-services/public-ip-addresses.md#sku) resource in the same region and subscription as your API Management instance.
7881

7982
For details, see [Prerequisites for network connections](api-management-using-with-vnet.md#prerequisites).
8083

@@ -91,15 +94,11 @@ To update the existing external or internal VNet configuration:
9194

9295
The virtual network configuration is updated, and the instance is migrated to the `stv2` platform.
9396

94-
> [!NOTE]
95-
> * Updating the VNet configuration takes from 15 to 45 minutes to complete.
96-
> * The VIP address(es) of your API Management instance will change.
97-
98-
9997
## Verify migration
10098

10199
To verify that the migration was successful, 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`.
102100

103101
## Next steps
104102

105-
* Learn about [stv1 platform retirement](breaking-changes/stv1-platform-retirement-august-2024.md).
103+
* Learn about [stv1 platform retirement](breaking-changes/stv1-platform-retirement-august-2024.md).
104+
* For instances deployed in a VNet, see the [Virtual network configuration reference](virtual-network-reference.md).

0 commit comments

Comments
 (0)